Public Member Functions | |
| __construct ($array, $flags=0) | |
| append ($value) | |
| asort () | |
| count () | |
| current () | |
| getArrayCopy () | |
| getFlags () | |
| key () | |
| ksort () | |
| natcasesort () | |
| natsort () | |
| next () | |
| offsetExists ($index) | |
| offsetGet ($index) | |
| offsetSet ($index, $newval) | |
| offsetUnset ($index) | |
| rewind () | |
| seek ($position) | |
| setFlags ($flags) | |
| uasort (mixed cmp_function) | |
| uksort (mixed cmp_function) | |
| valid () | |
Public Attributes | |
| const | ARRAY_AS_PROPS = 0x00000002 |
| const | STD_PROP_LIST = 0x00000001 |
Detailed Description
An Array iterator.
- Since
- PHP 5.0
- Version
- 1.2
This iterator allows to unset and modify values and keys while iterating over Arrays and Objects.
When you want to iterate over the same array multiple times you need to instanciate ArrayObject and let it create ArrayIterator instances that refer to it either by using foreach or by calling its getIterator() method manually.
Constructor & Destructor Documentation
| ArrayIterator::__construct | ( | $array, | |
$flags = 0 |
|||
| ) |
Construct a new array iterator from anything that has a hash table.
That is any Array or Object.
- Parameters
-
$array the array to use. $flags see setFlags().
Member Function Documentation
| ArrayIterator::append | ( | $value | ) |
- Parameters
-
$value is appended as last element
- Warning
- this method cannot be called when the ArrayIterator refers to an object.
| ArrayIterator::count | ( | ) |
| ArrayIterator::current | ( | ) |
Return the current element.
Implements Iterator.
Definition at line 843 of file spl.php.
Referenced by RecursiveArrayIterator\getChildren(), and RecursiveArrayIterator\hasChildren().
| ArrayIterator::getArrayCopy | ( | ) |
- Returns
- a copy of the array
- Note
- when the ArrayIterator refers to an object then this method returns an array of the public properties.
| ArrayIterator::key | ( | ) |
| ArrayIterator::natcasesort | ( | ) |
Sort the entries by values using case insensitive "natural order" algorithm.
Definition at line 793 of file spl.php.
Referenced by SubClasses\current().
| ArrayIterator::natsort | ( | ) |
| ArrayIterator::next | ( | ) |
| ArrayIterator::offsetExists | ( | $index | ) |
| ArrayIterator::offsetGet | ( | $index | ) |
| ArrayIterator::offsetSet | ( | $index, | |
| $newval | |||
| ) |
- Parameters
-
$index index to set $newval new value to store at offset $index
Implements ArrayAccess.
Definition at line 808 of file spl.php.
Referenced by SubClasses\__construct().
| ArrayIterator::offsetUnset | ( | $index | ) |
- Parameters
-
$index offset to unset
Implements ArrayAccess.
| ArrayIterator::rewind | ( | ) |
| ArrayIterator::seek | ( | $position | ) |
- Parameters
-
$position offset to seek to
- Exceptions
-
OutOfBoundsException if $position is invalid
Implements SeekableIterator.
| ArrayIterator::setFlags | ( | $flags | ) |
| ArrayIterator::uasort | ( | mixed | cmp_function | ) |
| ArrayIterator::uksort | ( | mixed | cmp_function | ) |
Sort the entries by key using user defined function.
Definition at line 785 of file spl.php.
Referenced by SubClasses\__construct().
| ArrayIterator::valid | ( | ) |
Member Data Documentation
| const ArrayIterator::ARRAY_AS_PROPS = 0x00000002 |
| const ArrayIterator::STD_PROP_LIST = 0x00000001 |
The documentation for this class was generated from the following file:
