Php/docs/class.recursivearrayiterator
(PHP 5 >= 5.1.0, PHP 7)
Introduction
This iterator allows to unset and modify values and keys while iterating over Arrays and Objects in the same way as the ArrayIterator. Additionally it is possible to iterate over the current iterator entry.
Class synopsis
RecursiveArrayIterator extends ArrayIterator implements RecursiveIterator {
const
int
STD_PROP_LIST
= 1
const
int
ARRAY_AS_PROPS
= 2
/* Constants */
const
int
CHILD_ARRAYS_ONLY
= 4
/* Methods */
public getChildren ( ) : RecursiveArrayIterator
public hasChildren ( ) : bool
/* Inherits */
public ArrayIterator::append
( mixed $value
) : void
public ArrayIterator::asort ( ) : void
public ArrayIterator::__construct
([ mixed $array = array()
[, int $flags = 0
]] )
public ArrayIterator::count ( ) : int
public ArrayIterator::current ( ) : mixed
public ArrayIterator::getArrayCopy ( ) : array
public ArrayIterator::getFlags ( ) : int
public ArrayIterator::key ( ) : mixed
public ArrayIterator::ksort ( ) : void
public ArrayIterator::natcasesort ( ) : void
public ArrayIterator::natsort ( ) : void
public ArrayIterator::next ( ) : 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
public ArrayIterator::seek
( int $position
) : void
public ArrayIterator::serialize ( ) : 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 ( ) : bool
}
Predefined Constants
RecursiveArrayIterator Flags
RecursiveArrayIterator::CHILD_ARRAYS_ONLY- Treat only arrays (not objects) as having children for recursive iteration.
Changelog
| Version | Description |
|---|---|
| 5.3.0 | CHILD_ARRAYS_ONLY flag was added.
|
Table of Contents
- RecursiveArrayIterator::getChildren — Returns an iterator for the current entry if it is an array or an object
- RecursiveArrayIterator::hasChildren — Returns whether current entry is an array or an object
/* Inherited constants */