<?xml version="1.0" encoding="utf-8"?>

<reference xml:id="class.arrayiterator" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

<title>Класс ArrayIterator</title>

<titleabbrev>ArrayIterator</titleabbrev>

<partintro>

<!-- {{{ ArrayIterator intro -->

<section xml:id="arrayiterator.intro">

&reftitle.intro;

<para>

<!-- Лучше оставить ссылки вместо тегов type, чтобы сохранить склонение слов

Класс поддерживает удаление элементов, и изменение ключей или значений

при итерации <link linkend="language.types.array">по массивам</link>

или <link linkend="language.types.object">объектам</link>.

</para>

<para>

Для многократного перебора одного и того же массива рекомендуют создавать

экземпляр класса <classname>ArrayObject</classname>. Конструктор класса принимает

исходный массив и сохраняет массив внутренне. Затем к элементам внутреннего массива

обращаются либо путём передачи объекта <classname>ArrayObject</classname> в конструкцию &foreach;,

при которой объект массива неявно создаёт экземпляр итератора <classname>ArrayIterator</classname>,

либо путём вызова метода <methodname>ArrayObject::getIterator</methodname> вручную.

</para>

</section>

<!-- }}} -->

<section xml:id="arrayiterator.synopsis">

&reftitle.classsynopsis;

<!-- {{{ Synopsis -->

<classsynopsis class="class">

<ooclass>

<classname>ArrayIterator</classname>

</ooclass>

<oointerface>

<modifier>implements</modifier>

<interfacename>SeekableIterator</interfacename>

</oointerface>

<oointerface>

<interfacename>ArrayAccess</interfacename>

</oointerface>

<oointerface>

<interfacename>Serializable</interfacename>

</oointerface>

<oointerface>

<interfacename>Countable</interfacename>

</oointerface>

<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="arrayiterator.constants.std-prop-list">ArrayIterator::STD_PROP_LIST</varname>

</fieldsynopsis>

<fieldsynopsis>

<modifier>public</modifier>

<modifier>const</modifier>

<type>int</type>

<varname linkend="arrayiterator.constants.array-as-props">ArrayIterator::ARRAY_AS_PROPS</varname>

</fieldsynopsis>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='ArrayIterator'])">

<xi:fallback/>

</xi:include>

<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.arrayiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='ArrayIterator'])">

<xi:fallback/>

</xi:include>

</classsynopsis>

</section>

<section xml:id="arrayiterator.constants">

&reftitle.constants;

<section xml:id="arrayiterator.constants.flags">

<title>Флаги ArrayIterator</title>

<variablelist>

<varlistentry xml:id="arrayiterator.constants.std-prop-list">

<term><constant>ArrayIterator::STD_PROP_LIST</constant></term>

<listitem>

<para>

При установке флага свойства объекта сохраняют стандартное поведение.

Вызов на объекте функции var_dump() показывает, что свойства хранятся стандартно, а во внутреннее хранилище

попадают только элементы массива. При итерации по объекту языковой конструкцией foreach или другими средствами

доступа к спискам выдаются только элементы хранилища. При этом доступ к элементам хранилища возможен

только через квадратные скобки.

</para>

</listitem>

</varlistentry>

<varlistentry xml:id="arrayiterator.constants.array-as-props">

<term><constant>ArrayIterator::ARRAY_AS_PROPS</constant></term>

<listitem>

<para>

При установке флага свойства объекта и элементы массива сохраняются во внутреннем хранилище

и при итерации по объекту выдаются как элементы единого списка. Флаг разрешает обращаться к элементам

внутреннего хранилища для чтения или записи как через синтаксис квадратных скобок, так и через оператор доступа к свойствам объекта.

</para>

</listitem>

</varlistentry>

</variablelist>

</section>

</section>

<!-- {{{ ArrayIterator properties

</partintro>

&reference.spl.entities.arrayiterator;

</reference>