head/first aligned with lodash/underscore

[sfinktah]

first (head) was leagues away from being compatible with underscore or lodash.

i did update the tests, but couldn't check them (composer require tree hell with php 8.1)

[pierredup]

Nice work! Some initial feedback, I haven't gone through everything yet

[pierredup]

All the changes in this file should be reverted

[pierredup]

Calling reset() on an ArrayObject does not work since PHP 7.4, so this needs to be handled separately.

[sfinktah]

Your many comments are appreciated and inarguably valid. I will not waste time responding to the others, but this one is quite interesting.

Personally, I have always disliked using reset() to get the head of an array. Coming from C++ it feels like mutating a const ref. I realise array is passed by value, so no mutation is occuring, though ArrayObject would be by reference.

I would much rather write

function head($array) {
    foreach ($array as $value) {
        return $value;
    }
    return null;
}

function headOr($array, $default) {
    head($array) ?? (is_callable($default) ? $default($array) : $default);
}

As you suggested in another comment, headOr really doesn't need to be overly complex.

That does upset my OCD a little though:

$array = [null, 1, 2];
printf("First: %s\n", head($array, "Empty Array"));

Would return "Empty Array", would it not?

[pierredup]

The code example should reference headOr

[pierredup]

I think most of this logic can go to the head function, then this can be simplified to the following:

function headOr($array, $default)
{
    return head($array) ?? (is_callable($default) ? $default($array) : $default);
}

[pierredup]

The mixed type is only available since PHP 8, while this library still supports PHP 7.x

[pierredup]

This can move to the docblock of the head function

[pierredup]

This can be simplified to the following:

function castArray($value): array
{
    return (array) $value;
}