wernerdweight/ra

PHP Array object with consistent and predictable API

2.0.2 2023-02-21 16:07 UTC

Requires

• php: >=8.1
• thecodingmachine/safe: ^2.4

Requires (Dev)

• thecodingmachine/phpstan-safe-rule: ^1.2
• wernerdweight/cs: ^3.0

MIT

• Werner Dweight Solutions

• array
• object
• iterable

README

PHP Array object with consistent, predictable and convenient API

Instalation

1. Download using composer

composer require wernerdweight/ra

1. Use in your project

use WernerDweight\RA\RA;
 
// helper methods (extracted here to simplify the code below and emphasize the difference)

function filterFunction(string $god): bool {
    return false !== strpos($god, 's');
}
 
function mapFunction(string $godContainingTheLetterS): string {
    return strtoupper($godContainingTheLetterS);
}
 
function reduceFunction(string $carry, string $god): string {
    return $carry .= ($carry[-1] === ' ' ? '' : ', ') . $god;
}
 
// create new RA
$egyptianGods = new RA(['Ra', 'Osiris', 'Anubis', 'Horus']);
 
// use as object
$godsContainingTheLetterSInUppercase = $egyptianGods
    ->filter('filterFunction')
    ->map('mapFunction')
    ->reverse()
    ->reduce('reduceFunction', 'My favourite Egyptian Gods are ');
 
echo $godsContainingTheLetterSInUppercase . "\n";
 
// use as normal array
$godsContainingTheLetterSInUppercase = array_reduce(
    array_reverse(
        array_map(
            'mapFunction',
            array_filter(
                $egyptianGods->toArray(),
                'filterFunction'
            )
        )
    ),
    'reduceFunction',
    'My favourite Egyptian Gods are '
);
 
echo $godsContainingTheLetterSInUppercase . "\n";
 
// RA extends Iterator, ArrayAccess and Countable
foreach ($egyptianGods as $god) {
    echo sprintf("My favourite Egyptian God is %s\n", $god);
}

API

TODO: