<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/spl.iterators.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ru',
  ),
  'this' => 
  array (
    0 => 'class.arrayiterator.php',
    1 => 'ArrayIterator',
    2 => 'Класс ArrayIterator',
  ),
  'up' => 
  array (
    0 => 'spl.iterators.php',
    1 => 'Итераторы',
  ),
  'prev' => 
  array (
    0 => 'appenditerator.valid.php',
    1 => 'AppendIterator::valid',
  ),
  'next' => 
  array (
    0 => 'arrayiterator.append.php',
    1 => 'ArrayIterator::append',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ru',
    'path' => 'reference/spl/arrayiterator.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.arrayiterator.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.arrayiterator" class="reference">
 <h1 class="title">Класс ArrayIterator</h1>
 

 <div class="partintro"><p class="verinfo">(PHP 5, PHP 7, PHP 8)</p>

  
  <div class="section" id="arrayiterator.intro">
   <h2 class="title">Введение</h2>
   <p class="para">
    
    Класс поддерживает удаление элементов, и изменение ключей или значений
    при итерации <a href="language.types.array.php" class="link">по массивам</a>
    или <a href="language.types.object.php" class="link">объектам</a>.
   </p>
   <p class="para">
    Для многократного перебора одного и того же массива рекомендуют создавать
    экземпляр класса <span class="classname"><a href="class.arrayobject.php" class="classname">ArrayObject</a></span>. Конструктор класса принимает
    исходный массив и сохраняет массив внутренне. Затем к элементам внутреннего массива
    обращаются либо путём передачи объекта <span class="classname"><a href="class.arrayobject.php" class="classname">ArrayObject</a></span> в конструкцию <a href="control-structures.foreach.php" class="link"><code class="literal">foreach</code></a>,
    при которой объект массива неявно создаёт экземпляр итератора <span class="classname"><strong class="classname">ArrayIterator</strong></span>,
    либо путём вызова метода <span class="methodname"><a href="arrayobject.getiterator.php" class="methodname">ArrayObject::getIterator()</a></span> вручную.
   </p>
  </div>
  

  <div class="section" id="arrayiterator.synopsis">
   <h2 class="title">Обзор класса</h2>

   
   <div class="classsynopsis"><div class="classsynopsisinfo">
    
     <span class="modifier">class</span> <strong class="classname"><strong class="classname">ArrayIterator</strong></strong>
    

    
     <span class="modifier">implements</span>
      <a href="class.seekableiterator.php" class="interfacename">SeekableIterator</a>,

     <a href="class.arrayaccess.php" class="interfacename">ArrayAccess</a>,

     <a href="class.serializable.php" class="interfacename">Serializable</a>,

     <a href="class.countable.php" class="interfacename">Countable</a> {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Константы */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.arrayiterator.php#arrayiterator.constants.std-prop-list"><var class="varname">STD_PROP_LIST</var></a></var>;</div>

    <div class="fieldsynopsis"><span class="modifier">public</span>
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.arrayiterator.php#arrayiterator.constants.array-as-props"><var class="varname">ARRAY_AS_PROPS</var></a></var>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Методы */</div>
    <div class="constructorsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.construct.php" class="methodname">__construct</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.object.php" class="type object">object</a></span></span> <code class="parameter">$array</code><span class="initializer"> = []</span></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = 0</span></span>)</div>

    <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.append.php" class="methodname">append</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.asort.php" class="methodname">asort</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = <strong><code><a href="array.constants.php#constant.sort-regular">SORT_REGULAR</a></code></strong></span></span>): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.count.php" class="methodname">count</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.current.php" class="methodname">current</a></span>(): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.getarraycopy.php" class="methodname">getArrayCopy</a></span>(): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.getflags.php" class="methodname">getFlags</a></span>(): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.key.php" class="methodname">key</a></span>(): <span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.ksort.php" class="methodname">ksort</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code><span class="initializer"> = <strong><code><a href="array.constants.php#constant.sort-regular">SORT_REGULAR</a></code></strong></span></span>): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.natcasesort.php" class="methodname">natcasesort</a></span>(): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.natsort.php" class="methodname">natsort</a></span>(): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.next.php" class="methodname">next</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.offsetexists.php" class="methodname">offsetExists</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$key</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.offsetget.php" class="methodname">offsetGet</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$key</code></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.offsetset.php" class="methodname">offsetSet</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.offsetunset.php" class="methodname">offsetUnset</a></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$key</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.rewind.php" class="methodname">rewind</a></span>(): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.seek.php" class="methodname">seek</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.serialize.php" class="methodname">serialize</a></span>(): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.setflags.php" class="methodname">setFlags</a></span>(<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$flags</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.uasort.php" class="methodname">uasort</a></span>(<span class="methodparam"><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.uksort.php" class="methodname">uksort</a></span>(<span class="methodparam"><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code></span>): <span class="type"><a href="language.types.singleton.php" class="type true">true</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.unserialize.php" class="methodname">unserialize</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$data</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="arrayiterator.valid.php" class="methodname">valid</a></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

   }</div>

  </div>

  <div class="section" id="arrayiterator.constants">
   <h2 class="title">Предопределённые константы</h2>
   <div class="section" id="arrayiterator.constants.flags">
    <h2 class="title">Флаги ArrayIterator</h2>
    <dl>

     
      <dt id="arrayiterator.constants.std-prop-list"><strong><code><a href="class.arrayiterator.php#arrayiterator.constants.std-prop-list">ArrayIterator::STD_PROP_LIST</a></code></strong></dt>
      <dd>
       <p class="para">
        При установке флага свойства объекта сохраняют стандартное поведение.
        Вызов на объекте функции var_dump() показывает, что свойства хранятся стандартно, а во внутреннее хранилище
        попадают только элементы массива. При итерации по объекту языковой конструкцией foreach или другими средствами
        доступа к спискам выдаются только элементы хранилища. При этом доступ к элементам хранилища возможен
        только через квадратные скобки.
       </p>
      </dd>
     

     
      <dt id="arrayiterator.constants.array-as-props"><strong><code><a href="class.arrayiterator.php#arrayiterator.constants.array-as-props">ArrayIterator::ARRAY_AS_PROPS</a></code></strong></dt>
      <dd>
       <p class="para">
        При установке флага свойства объекта и элементы массива сохраняются во внутреннем хранилище
        и при итерации по объекту выдаются как элементы единого списка. Флаг разрешает обращаться к элементам
        внутреннего хранилища для чтения или записи как через синтаксис квадратных скобок, так и через оператор доступа к свойствам объекта.
       </p>
      </dd>
     
    </dl>
   </div>
  </div>

  

 </div>

 
















































































































































<h2>Содержание</h2><ul class="chunklist chunklist_reference"><li><a href="arrayiterator.append.php">ArrayIterator::append</a> — Добавляет элемент</li><li><a href="arrayiterator.asort.php">ArrayIterator::asort</a> — Сортирует элементы по значениям</li><li><a href="arrayiterator.construct.php">ArrayIterator::__construct</a> — Создаёт ArrayIterator</li><li><a href="arrayiterator.count.php">ArrayIterator::count</a> — Подсчитывает количество элементов</li><li><a href="arrayiterator.current.php">ArrayIterator::current</a> — Возвращает текущий элемент в массиве</li><li><a href="arrayiterator.getarraycopy.php">ArrayIterator::getArrayCopy</a> — Возвращает копию массива</li><li><a href="arrayiterator.getflags.php">ArrayIterator::getFlags</a> — Получает флаги поведения</li><li><a href="arrayiterator.key.php">ArrayIterator::key</a> — Возвращает ключ текущего элемента массива</li><li><a href="arrayiterator.ksort.php">ArrayIterator::ksort</a> — Сортирует элементы по ключам</li><li><a href="arrayiterator.natcasesort.php">ArrayIterator::natcasesort</a> — Сортирует элементы &quot;натурально&quot;, с учётом регистра</li><li><a href="arrayiterator.natsort.php">ArrayIterator::natsort</a> — Сортирует записи естественным образом</li><li><a href="arrayiterator.next.php">ArrayIterator::next</a> — Перемещает указатель за следующую запись</li><li><a href="arrayiterator.offsetexists.php">ArrayIterator::offsetExists</a> — Проверяет, содержит ли итератор смещение</li><li><a href="arrayiterator.offsetget.php">ArrayIterator::offsetGet</a> — Получает значение для смещения</li><li><a href="arrayiterator.offsetset.php">ArrayIterator::offsetSet</a> — Устанавливает значение для смещения</li><li><a href="arrayiterator.offsetunset.php">ArrayIterator::offsetUnset</a> — Сбрасывает значение по смещению</li><li><a href="arrayiterator.rewind.php">ArrayIterator::rewind</a> — Перемещает указатель в начало массива</li><li><a href="arrayiterator.seek.php">ArrayIterator::seek</a> — Перемещает указатель на выбранную позицию</li><li><a href="arrayiterator.serialize.php">ArrayIterator::serialize</a> — Сериализует массив</li><li><a href="arrayiterator.setflags.php">ArrayIterator::setFlags</a> — Устанавливает флаги поведения</li><li><a href="arrayiterator.uasort.php">ArrayIterator::uasort</a> — Сортировка с помощью заданной пользователем функции и сохранением ключей</li><li><a href="arrayiterator.uksort.php">ArrayIterator::uksort</a> — Сортирует по ключам пользовательской функцией сравнения</li><li><a href="arrayiterator.unserialize.php">ArrayIterator::unserialize</a> — Десериализация</li><li><a href="arrayiterator.valid.php">ArrayIterator::valid</a> — Проверяет, содержит ли массив ещё записи</li></ul>
</div>
<?php manual_footer($setup); ?>