archived-doc-ru/reference/spl/limititerator/construct.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="limititerator.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>LimitIterator::__construct</refname>
  <refpurpose>Конструктор класса LimitIterator</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <constructorsynopsis role="LimitIterator">
   <modifier>public</modifier> <methodname>LimitIterator::__construct</methodname>
   <methodparam><type>Iterator</type><parameter>iterator</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>limit</parameter><initializer>-1</initializer></methodparam>
  </constructorsynopsis>
  <para>
   Создаёт новый объект класса <classname>LimitIterator</classname> на основе
   заданного объекта <parameter>iterator</parameter>, начального смещения
   <parameter>offset</parameter> и максимального числа итераций
   <parameter>limit</parameter>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>iterator</parameter></term>
     <listitem>
      <para>
       Объект-итератор <classname>Iterator</classname>, число итераций которого
       требуется ограничить.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>offset</parameter></term>
     <listitem>
      <para>
       Необязательное начальное смещение.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>limit</parameter></term>
     <listitem>
      <para>
       Необязательное ограничение количества итераций.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="errors">
  &reftitle.errors;
  <para>
   Выбрасывает исключение <classname>ValueError</classname>, если
   смещение <parameter>offset</parameter> окажется меньше <literal>0</literal>,
   либо если <parameter>limit</parameter> окажется меньше <literal>-1</literal>.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Теперь выбрасывает исключение <classname>ValueError</classname>,
        если смещение <parameter>offset</parameter> окажется меньше <literal>0</literal>;
        ранее выбрасывалось исключение <classname>RuntimeException</classname>.
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        Теперь выбрасывает исключение <classname>ValueError</classname>,
        если смещение <parameter>limit</parameter> окажется меньше <literal>-1</literal>;
        ранее выбрасывалось исключение <classname>RuntimeException</classname>.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Пример использования <function>LimitIterator::__construct</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$ait = new ArrayIterator(array('a', 'b', 'c', 'd', 'e'));
$lit = new LimitIterator($ait, 1, 3);
foreach ($lit as $value) {
    echo $value . "\n";
}
?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
b
c
d
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><link linkend="limititerator.examples">Примеры использования LimitIterator</link></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->