README

Adds array helper methods

Test

phpunit or vendor/bin/phpunit

coverage reports will be available in var/coverage

Use

arrayUnique

use Jalismrs\Common\Helpers\ArrayHelpers;

$value1 = new stdClass();

$input = [
    'key1' => $value1,
    'value2',
    $value1,
    'key2' => 'value2',
];

$output = ArrayHelpers::arrayUnique(
    $input,
);

/**
 * [
 *   'key1' => $value1,
 *   'value2',
 * ]
 */

pluckOne

use Jalismrs\Common\Helpers\ArrayHelpers;

$input = [
    'key' => [
        'property1' => 'property1value1',
        'property2' => 'property2value1',
    ],
    [
        'property1' => 'property1value2',
        'property2' => 'property2value2',
    ],
];

$output = ArrayHelpers::pluckOne(
    $input,
    'property1',
);

/**
 * [
 *   'key' => 'property1value1',
 *   'property1value2',
 * ]
 */

pluckMany

use Jalismrs\Common\Helpers\ArrayHelpers;

$input = [
    'key' => [
        'property1' => 'property1value1',
        'property2' => 'property2value1',
        'property3' => 'property3value1',
    ],
    [
        'property1' => 'property1value2',
        'property2' => 'property2value2',
        'property3' => 'property3value2',
    ],
];

$output = ArrayHelpers::pluckMany(
    $input,
    [
        'property1',
        'property3',
    ],
);

/**
 * [
 *   'key' => [
 *     'property1' => 'property1value1',
 *     'property3' => 'property3value1',
 *   ],
 *   [
 *     'property1' => 'property1value2',
 *     'property3' => 'property3value2',
 *   ],
 * ]
 */

split

use Jalismrs\Common\Helpers\ArrayHelpers;

$input = [
    42,
    -69,
];

$output = ArrayHelpers::split(
    $input,
    static function(
        int $value
    ): bool {
        return $value < 10;
    },
);

/**
 * [
 *   ArrayHelpers::SPLIT_MATCHES     => [
 *     -69
 *   ],
 *   ArrayHelpers::SPLIT_NOT_MATCHES => [
 *     42,
 *   ],
 * ]
 */