PHP 7.4.0RC2 Released!

La classe RecursiveArrayIterator

(PHP 5 >= 5.1.0, PHP 7)

Introduction

Cet itérateur permet la suppression et la modification de valeurs et clés durant l'itération sur des tableaux et des objets, de la même façon que ArrayIterator. De plus, il est possible d'itérer sur l'élément courant.

Synopsis de la classe

RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
/* Constants héritées */
const integer STD_PROP_LIST = 1 ;
const integer ARRAY_AS_PROPS = 2 ;
/* Constantes */
const integer CHILD_ARRAYS_ONLY = 4 ;
/* Méthodes */
public hasChildren ( void ) : bool
/* Méthodes héritées */
public ArrayIterator::append ( mixed $value ) : void
public ArrayIterator::asort ( void ) : void
public ArrayIterator::__construct ([ mixed $array = array() [, int $flags = 0 ]] )
public ArrayIterator::count ( void ) : int
public ArrayIterator::current ( void ) : mixed
public ArrayIterator::getArrayCopy ( void ) : array
public ArrayIterator::getFlags ( void ) : int
public ArrayIterator::key ( void ) : mixed
public ArrayIterator::ksort ( void ) : void
public ArrayIterator::natcasesort ( void ) : void
public ArrayIterator::natsort ( void ) : void
public ArrayIterator::next ( void ) : void
public ArrayIterator::offsetExists ( mixed $index ) : bool
public ArrayIterator::offsetGet ( mixed $index ) : mixed
public ArrayIterator::offsetSet ( mixed $index , mixed $newval ) : void
public ArrayIterator::offsetUnset ( mixed $index ) : void
public ArrayIterator::rewind ( void ) : void
public ArrayIterator::seek ( int $position ) : void
public ArrayIterator::serialize ( void ) : string
public ArrayIterator::setFlags ( string $flags ) : void
public ArrayIterator::uasort ( callable $cmp_function ) : void
public ArrayIterator::uksort ( callable $cmp_function ) : void
public ArrayIterator::unserialize ( string $serialized ) : void
public ArrayIterator::valid ( void ) : bool
}

Constantes pré-définies

Contantes RecursiveArrayIterator

RecursiveArrayIterator::CHILD_ARRAYS_ONLY

Traitez uniquement les tableaux (et non les objets) comme ayant des enfants pour l'itération récursive.

Historique

Version Description
5.3.0 Ajout de la constante CHILD_ARRAYS_ONLY.

Sommaire

add a note add a note

User Contributed Notes 3 notes

up
11
c dot 1 at smithies dot org
7 years ago
If you are iterating over a multi-dimensional array of objects, you may be tempted to use a RecursiveArrayIterator within a RecursiveIteratorIterator. You are likely to get baffling results if you do. That is because RecursiveArrayIterator treats all objects as having children, and tries to recurse into them. But if you are interested in having your RecursiveIteratorIterator return the objects in your multi-dimensional array, then you don't want the default setting LEAVES_ONLY, because no object can be a leaf (= has no children).

The solution is to extend the RecursiveArrayIterator class and override the hasChildren method appropriately. Something like the following might be suitable:

<?php
class RecursiveArrayOnlyIterator extends RecursiveArrayIterator {
  public function
hasChildren() {
    return
is_array($this->current());
  }
}
?>
Of course, this simple example will not recurse into ArrayObjects either!
up
9
mccarthy dot richard at gmail dot com
8 years ago
Using the RecursiveArrayIterator to traverse an unknown amount of sub arrays within the outer array. Note: This functionality is already provided by using the RecursiveIteratorIterator but is useful in understanding how to use the iterator when using for the first time as all the terminology does get rather confusing at first sight of SPL!

<?php
$myArray
= array(
   
0 => 'a',
   
1 => array('subA','subB',array(0 => 'subsubA', 1 => 'subsubB', 2 => array(0 => 'deepA', 1 => 'deepB'))),
   
2 => 'b',
   
3 => array('subA','subB','subC'),
   
4 => 'c'
);

$iterator = new RecursiveArrayIterator($myArray);
iterator_apply($iterator, 'traverseStructure', array($iterator));

function
traverseStructure($iterator) {
   
    while (
$iterator -> valid() ) {

        if (
$iterator -> hasChildren() ) {
       
           
traverseStructure($iterator -> getChildren());
           
        }
        else {
            echo
$iterator -> key() . ' : ' . $iterator -> current() .PHP_EOL;   
        }

       
$iterator -> next();
    }
}
?>

The output from which is:
0 : a
0 : subA
1 : subB
0 : subsubA
1 : subsubB
0 : deepA
1 : deepB
2 : b
0 : subA
1 : subB
2 : subC
4 : c
up
7
lemoinem dot remove at me dot mlemoine dot name
5 years ago
The RecursiveArrayOnlyIterator behaviour c dot 1 at smithies dot org presented can also be achieved using the (undocumented) flag RecursiveArrayIterator::CHILD_ARRAYS_ONLY (https://github.com/php/php-src/blob/master/ext/spl/spl_array.c#L1970 and https://github.com/php/php-src/blob/master/ext/spl/spl_array.c#L1620)
To Top