Php/docs/class.arrayiterator

• PHP Manual
• Iterators
• The ArrayIterator class

(PHP 5, PHP 7)

Introduction

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 instantiate ArrayObject and let it create ArrayIterator instances that refer to it either by using foreach or by calling its getIterator() method manually.

Class synopsis

ArrayIterator implements ArrayAccess , SeekableIterator , Countable , Serializable {

/* Constants */

const int STD_PROP_LIST = 1

const int ARRAY_AS_PROPS = 2

/* Methods */

public append ( mixed $value ) : void

public asort ( ) : void

public __construct ([ mixed $array = array() [, int $flags = 0 ]] )

public count ( ) : int

public current ( ) : mixed

public getArrayCopy ( ) : array

public getFlags ( ) : int

public key ( ) : mixed

public ksort ( ) : void

public natcasesort ( ) : void

public natsort ( ) : void

public next ( ) : void

public offsetExists ( mixed $index ) : bool

public offsetGet ( mixed $index ) : mixed

public offsetSet ( mixed $index , mixed $newval ) : void

public offsetUnset ( mixed $index ) : void

public rewind ( ) : void

public seek ( int $position ) : void

public serialize ( ) : string

public setFlags ( string $flags ) : void

public uasort ( callable $cmp_function ) : void

public uksort ( callable $cmp_function ) : void

public unserialize ( string $serialized ) : void

public valid ( ) : bool

}

Predefined Constants

ArrayIterator Flags

ArrayIterator::STD_PROP_LIST

Properties of the object have their normal functionality when accessed as list (var_dump, foreach, etc.).

ArrayIterator::ARRAY_AS_PROPS

Entries can be accessed as properties (read and write).

Table of Contents

• ArrayIterator::append — Append an element
• ArrayIterator::asort — Sort array by values
• ArrayIterator::__construct — Construct an ArrayIterator
• ArrayIterator::count — Count elements
• ArrayIterator::current — Return current array entry
• ArrayIterator::getArrayCopy — Get array copy
• ArrayIterator::getFlags — Get behavior flags
• ArrayIterator::key — Return current array key
• ArrayIterator::ksort — Sort array by keys
• ArrayIterator::natcasesort — Sort an array naturally, case insensitive
• ArrayIterator::natsort — Sort an array naturally
• ArrayIterator::next — Move to next entry
• ArrayIterator::offsetExists — Check if offset exists
• ArrayIterator::offsetGet — Get value for an offset
• ArrayIterator::offsetSet — Set value for an offset
• ArrayIterator::offsetUnset — Unset value for an offset
• ArrayIterator::rewind — Rewind array back to the start
• ArrayIterator::seek — Seek to position
• ArrayIterator::serialize — Serialize
• ArrayIterator::setFlags — Set behaviour flags
• ArrayIterator::uasort — Sort with a user-defined comparison function and maintain index association
• ArrayIterator::uksort — Sort by keys using a user-defined comparison function
• ArrayIterator::unserialize — Unserialize
• ArrayIterator::valid — Check whether array contains more entries