php-doc-en/reference/intl/intlpartsiterator.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.intlpartsiterator" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">

 <title>The IntlPartsIterator class</title>
 <titleabbrev>IntlPartsIterator</titleabbrev>

 <partintro>

<!-- {{{ IntlPartsIterator intro -->
  <section xml:id="intlpartsiterator.intro">
   &reftitle.intro;
   <para>
    Objects of this class can be obtained from
    <classname>IntlBreakIterator</classname> objects. While the break
    iterators provide a sequence of boundary positions when iterated,
    <classname>IntlPartsIterator</classname> objects provide, as a
    convenience, the text fragments comprehended between two successive
    boundaries.
   </para>
   <para>
    The keys may represent the offset of the left boundary, right boundary, or
    they may just the sequence of non-negative integers. See
    <function>IntlBreakIterator::getPartsIterator</function>.
   </para>
  </section>
<!-- }}} -->

  <section xml:id="intlpartsiterator.synopsis">
   &reftitle.classsynopsis;

<!-- {{{ Synopsis -->
   <classsynopsis>
    <ooclass>
     <classname>IntlPartsIterator</classname>
    </ooclass>

    <classsynopsisinfo>
     <ooclass>
      <classname>IntlPartsIterator</classname>
     </ooclass>

     <ooclass>
      <modifier>extends</modifier>
      <classname>IntlIterator</classname>
     </ooclass>
    </classsynopsisinfo>

    <classsynopsisinfo role="comment">Constants</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlpartsiterator.constants.key-sequential">IntlPartsIterator::KEY_SEQUENTIAL</varname>
     <initializer>0</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlpartsiterator.constants.key-left">IntlPartsIterator::KEY_LEFT</varname>
     <initializer>1</initializer>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlpartsiterator.constants.key-right">IntlPartsIterator::KEY_RIGHT</varname>
     <initializer>2</initializer>
    </fieldsynopsis>

    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.intlpartsiterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
     <xi:fallback/>
    </xi:include>

    <classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.intliterator')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])">
     <xi:fallback/>
    </xi:include>
   </classsynopsis>
<!-- }}} -->

  </section>

<!-- {{{ IntlPartsIterator constants -->
  <section xml:id="intlpartsiterator.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="intlpartsiterator.constants.key-sequential">
     <term><constant>IntlPartsIterator::KEY_SEQUENTIAL</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlpartsiterator.constants.key-left">
     <term><constant>IntlPartsIterator::KEY_LEFT</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlpartsiterator.constants.key-right">
     <term><constant>IntlPartsIterator::KEY_RIGHT</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>
<!-- }}} -->


 </partintro>

 &reference.intl.entities.intlpartsiterator;

</phpdoc:classref>
<!-- 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
-->