intlbreakiterator.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 1f68eecaa7c4c723abe72a5a040ea7b15023a5aa Maintainer: mumumu Status: ready -->
<reference xml:id="class.intlbreakiterator" 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>IntlBreakIterator クラス</title>
 <titleabbrev>IntlBreakIterator</titleabbrev>

 <partintro>

<!-- {{{ IntlBreakIterator intro -->
  <section xml:id="intlbreakiterator.intro">
   &reftitle.intro;
   <para>
    “break iterator” は、
    テキスト中のどこに境界
    (たとえば、単語や文章の境目)
    が位置するのかに関するメソッドを公開しています。
    PHP の <classname>IntlBreakIterator</classname> は、
    全ての break iterator の基底クラスになります。
    追加の機能が利用可能な場合は、
    intl 拡張モジュールは適切なサブクラスを公開しています。
    たとえば、
    <classname>IntlRuleBasedBreakIterator</classname> や
    <classname>IntlCodePointBreakIterator</classname> です。
   </para>
   <para>
    このクラスは、
    <interfacename>IteratorAggregate</interfacename> も実装しています。
    <classname>IntlBreakIterator</classname> を走査すると、
    テキストに存在する連続する境界を示す、
    負でない整数値を返します。
    これは、UTF-8 のコード単位(バイト) の数として表現され、
    テキストの最初
    (これは、位置 <literal>0</literal> になります) から取得されます。
    イテレータによって返されるキーは、
    <literal>{0, 1, 2, …}</literal> のように、自然数の順序に並びます。
   </para>
  </section>
<!-- }}} -->

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

<!-- {{{ Synopsis -->
   <classsynopsis class="class">
    <ooclass>
     <classname>IntlBreakIterator</classname>
    </ooclass>

    <oointerface>
     <modifier>implements</modifier>
     <interfacename>IteratorAggregate</interfacename>
    </oointerface>

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.done">IntlBreakIterator::DONE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-none">IntlBreakIterator::WORD_NONE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-none-limit">IntlBreakIterator::WORD_NONE_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-number">IntlBreakIterator::WORD_NUMBER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-number-limit">IntlBreakIterator::WORD_NUMBER_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-letter">IntlBreakIterator::WORD_LETTER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-letter-limit">IntlBreakIterator::WORD_LETTER_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-kana">IntlBreakIterator::WORD_KANA</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-kana-limit">IntlBreakIterator::WORD_KANA_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-ideo">IntlBreakIterator::WORD_IDEO</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.word-ideo-limit">IntlBreakIterator::WORD_IDEO_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.line-soft">IntlBreakIterator::LINE_SOFT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.line-soft-limit">IntlBreakIterator::LINE_SOFT_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.line-hard">IntlBreakIterator::LINE_HARD</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.line-hard-limit">IntlBreakIterator::LINE_HARD_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.sentence-term">IntlBreakIterator::SENTENCE_TERM</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.sentence-term-limit">IntlBreakIterator::SENTENCE_TERM_LIMIT</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.sentence-sep">IntlBreakIterator::SENTENCE_SEP</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="intlbreakiterator.constants.sentence-sep-limit">IntlBreakIterator::SENTENCE_SEP_LIMIT</varname>
    </fieldsynopsis>

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

  </section>

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

    <varlistentry xml:id="intlbreakiterator.constants.done">
     <term>
      <constant>IntlBreakIterator::DONE</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-none">
     <term>
      <constant>IntlBreakIterator::WORD_NONE</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-none-limit">
     <term>
      <constant>IntlBreakIterator::WORD_NONE_LIMIT</constant>
      <type>int</type>
     </term>     
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-number">
     <term>
      <constant>IntlBreakIterator::WORD_NUMBER</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-number-limit">
     <term>
      <constant>IntlBreakIterator::WORD_NUMBER_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-letter">
     <term>
      <constant>IntlBreakIterator::WORD_LETTER</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-letter-limit">
     <term>
      <constant>IntlBreakIterator::WORD_LETTER_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-kana">
     <term>
      <constant>IntlBreakIterator::WORD_KANA</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-kana-limit">
     <term>
      <constant>IntlBreakIterator::WORD_KANA_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-ideo">
     <term>
      <constant>IntlBreakIterator::WORD_IDEO</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.word-ideo-limit">
     <term>
      <constant>IntlBreakIterator::WORD_IDEO_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.line-soft">
     <term>
      <constant>IntlBreakIterator::LINE_SOFT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.line-soft-limit">
     <term>
      <constant>IntlBreakIterator::LINE_SOFT_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.line-hard">
     <term>
      <constant>IntlBreakIterator::LINE_HARD</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.line-hard-limit">
     <term>
      <constant>IntlBreakIterator::LINE_HARD_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.sentence-term">
     <term>
      <constant>IntlBreakIterator::SENTENCE_TERM</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.sentence-term-limit">
     <term>
      <constant>IntlBreakIterator::SENTENCE_TERM_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.sentence-sep">
     <term>
      <constant>IntlBreakIterator::SENTENCE_SEP</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="intlbreakiterator.constants.sentence-sep-limit">
     <term>
      <constant>IntlBreakIterator::SENTENCE_SEP_LIMIT</constant>
      <type>int</type>
     </term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

   </variablelist>
  </section>

  <section role="changelog">
   &reftitle.changelog;
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.4.0</entry>
       <entry>
        クラス定数が型付けされました。
       </entry>
      </row>
      <row>
       <entry>8.0.0</entry>
       <entry>
        <classname>IntlBreakIterator</classname> は、
        <interfacename>IteratorAggregate</interfacename> を実装しました。
        これより前のバージョンでは、
        <interfacename>Traversable</interfacename>
        を代わりに実装していました。
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </section>
<!-- }}} -->
 </partintro>

 &reference.intl.entities.intlbreakiterator;

</reference>
<!-- 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
-->