ArrayIterator (class)

The ArrayIterator class

Introduction

(PHP 5, PHP 7)

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

public void append ( mixed $value )

public void asort ( void )

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

public int count ( void )

public mixed current ( void )

public array getArrayCopy ( void )

public void getFlags ( void )

public mixed key ( void )

public void ksort ( void )

public void natcasesort ( void )

public void natsort ( void )

public void next ( void )

public void offsetExists ( string $index )

public mixed offsetGet ( string $index )

public void offsetSet ( string $index , string $newval )

public void offsetUnset ( string $index )

public void rewind ( void )

public void seek ( int $position )

public string serialize ( void )

public void setFlags ( string $flags )

public void uasort ( string $cmp_function )

public void uksort ( string $cmp_function )

public string unserialize ( string $serialized )

public bool valid ( void )

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 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 — User defined sort
• ArrayIterator::uksort — User defined sort
• ArrayIterator::unserialize — Unserialize
• ArrayIterator::valid — Check whether array contains more entries