Повторяющиеся объекты и намеки на тип массива?

PHP 7.1.0 представил iterable псевдотип и функция is_iterable(), которая специально разработана для такой цели:

Это [...] предлагает новый iterable псевдотип. Этот тип аналогичен callable, принимая несколько типов вместо одного единственного типа.

iterable принимает любой array или объект, реализующий Traversable. Оба этих типа являются итеративными с использованием foreach и могут использоваться с yield из генератор.

function foo(iterable $iterable) {
    foreach ($iterable as $value) {
        // ...
    }
}

Это [...] также добавляет функцию is_iterable(), которая возвращает логическое значение: true, если значение является итерационным и будет принято псевдотипом iterable, false для других значений.

var_dump(is_iterable([1, 2, 3])); // bool(true)
var_dump(is_iterable(new ArrayIterator([1, 2, 3]))); // bool(true)
var_dump(is_iterable((function () { yield 1; })())); // bool(true)
var_dump(is_iterable(1)); // bool(false)
var_dump(is_iterable(new stdClass())); // bool(false)

На самом деле мне пришлось добавить проверку для stdClass, так как экземпляры stdClass работают в циклах foreach, но stdClass не реализует проходимость:

function is_iterable($var) {
    return (is_array($var) || $var instanceof Traversable || $var instanceof stdClass);
}

Я использую простой (и, возможно, немного хакерский) способ проверки "повторяемости".

function is_iterable($var) {
    set_error_handler(function ($errno, $errstr, $errfile, $errline, array $errcontext)
    {
        throw new \ErrorException($errstr, null, $errno, $errfile, $errline);
    });

    try {
        foreach ($var as $v) {
            break;
        }
    } catch (\ErrorException $e) {
        restore_error_handler();
        return false;
    }
    restore_error_handler();
    return true;
}

Когда вы пытаетесь зациклить не повторяющуюся переменную, PHP выдает предупреждение. Установив пользовательский обработчик ошибок перед попыткой повторения, вы можете преобразовать ошибку в исключение, что позволит вам использовать блок try/catch. После этого вы восстанавливаете предыдущий обработчик ошибок, чтобы не нарушать поток программы.

Вот небольшой тестовый пример (протестирован в PHP 5.3.15):

class Foo {
    public $a = 'one';
    public $b = 'two';
}

$foo = new Foo();
$bar = array('d','e','f');
$baz = 'string';
$bazinga = 1;
$boo = new StdClass();    

var_dump(is_iterable($foo)); //boolean true
var_dump(is_iterable($bar)); //boolean true
var_dump(is_iterable($baz)); //boolean false
var_dump(is_iterable($bazinga)); //bolean false
var_dump(is_iterable($boo)); //bolean true

К сожалению, вы не сможете использовать подсказки типа для этого, и вам придется делать is_array($var) or $var instanceof ArrayAccess . Это известная проблема, но afaik она до сих пор не решена. По крайней мере, это не работает с PHP 5.3.2, который я только что протестировал.

Вы МОЖЕТЕ использовать подсказку типа, если переключитесь на использование повторяющихся объектов.

protected function doSomethingWithIterableObject(Iterator $iterableObject) {}

Или

protected function doSomethingWithIterableObject(Traversable $iterableObject) {}

Однако это нельзя использовать для одновременного приема повторяющихся объектов и массивов. Если вы действительно хотите это сделать, попробуйте создать функцию-оболочку примерно так:

// generic function (use name of original function) for old code
// (new code may call the appropriate function directly)
public function doSomethingIterable($iterable)
{
    if (is_array($iterable)) {
        return $this->doSomethingIterableWithArray($iterable);
    }
    if ($iterable instanceof Traversable) {
        return $this->doSomethingIterableWithObject($iterable);
    }
    return null;
}
public function doSomethingIterableWithArray(array $iterable)
{
    return $this->myIterableFunction($iterable);
}
public function doSomethingIterableWithObject(Iterator $iterable)
{
    return $this->myIterableFunction($iterable);
}
protected function myIterableFunction($iterable)
{
    // no type checking here
    $result = null;
    foreach ($iterable as $item)
    {
        // do stuff
    }
    return $result;
}