uconverter.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.uconverter" 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 UConverter class</title>
 <titleabbrev>UConverter</titleabbrev>

 <partintro>

<!-- {{{ UConverter intro -->
  <section xml:id="uconverter.intro">
   &reftitle.intro;
   <para>

   </para>
  </section>
<!-- }}} -->

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

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

    <classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.reason-unassigned">UConverter::REASON_UNASSIGNED</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.reason-illegal">UConverter::REASON_ILLEGAL</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.reason-irregular">UConverter::REASON_IRREGULAR</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.reason-reset">UConverter::REASON_RESET</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.reason-close">UConverter::REASON_CLOSE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.reason-clone">UConverter::REASON_CLONE</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.unsupported-converter">UConverter::UNSUPPORTED_CONVERTER</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.sbcs">UConverter::SBCS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.dbcs">UConverter::DBCS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.mbcs">UConverter::MBCS</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.latin-1">UConverter::LATIN_1</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf8">UConverter::UTF8</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf16-bigendian">UConverter::UTF16_BigEndian</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf16-littleendian">UConverter::UTF16_LittleEndian</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf32-bigendian">UConverter::UTF32_BigEndian</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf32-littleendian">UConverter::UTF32_LittleEndian</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.ebcdic-stateful">UConverter::EBCDIC_STATEFUL</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.iso-2022">UConverter::ISO_2022</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-1">UConverter::LMBCS_1</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-2">UConverter::LMBCS_2</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-3">UConverter::LMBCS_3</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-4">UConverter::LMBCS_4</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-5">UConverter::LMBCS_5</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-6">UConverter::LMBCS_6</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-8">UConverter::LMBCS_8</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-11">UConverter::LMBCS_11</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-16">UConverter::LMBCS_16</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-17">UConverter::LMBCS_17</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-18">UConverter::LMBCS_18</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-19">UConverter::LMBCS_19</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.lmbcs-last">UConverter::LMBCS_LAST</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.hz">UConverter::HZ</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.scsu">UConverter::SCSU</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.iscii">UConverter::ISCII</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.us-ascii">UConverter::US_ASCII</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf7">UConverter::UTF7</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.bocu1">UConverter::BOCU1</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf16">UConverter::UTF16</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.utf32">UConverter::UTF32</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.cesu8">UConverter::CESU8</varname>
    </fieldsynopsis>
    <fieldsynopsis>
     <modifier>public</modifier>
     <modifier>const</modifier>
     <type>int</type>
     <varname linkend="uconverter.constants.imap-mailbox">UConverter::IMAP_MAILBOX</varname>
    </fieldsynopsis>

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

  </section>
  
<!-- {{{ UConverter constants -->
  <section xml:id="uconverter.constants">
   &reftitle.constants;
   <variablelist>

    <varlistentry xml:id="uconverter.constants.reason-unassigned">
     <term><constant>UConverter::REASON_UNASSIGNED</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.reason-illegal">
     <term><constant>UConverter::REASON_ILLEGAL</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.reason-irregular">
     <term><constant>UConverter::REASON_IRREGULAR</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.reason-reset">
     <term><constant>UConverter::REASON_RESET</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.reason-close">
     <term><constant>UConverter::REASON_CLOSE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.reason-clone">
     <term><constant>UConverter::REASON_CLONE</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.unsupported-converter">
     <term><constant>UConverter::UNSUPPORTED_CONVERTER</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.sbcs">
     <term><constant>UConverter::SBCS</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.dbcs">
     <term><constant>UConverter::DBCS</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.mbcs">
     <term><constant>UConverter::MBCS</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.latin-1">
     <term><constant>UConverter::LATIN_1</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf8">
     <term><constant>UConverter::UTF8</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf16-bigendian">
     <term><constant>UConverter::UTF16_BigEndian</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf16-littleendian">
     <term><constant>UConverter::UTF16_LittleEndian</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf32-bigendian">
     <term><constant>UConverter::UTF32_BigEndian</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf32-littleendian">
     <term><constant>UConverter::UTF32_LittleEndian</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.ebcdic-stateful">
     <term><constant>UConverter::EBCDIC_STATEFUL</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.iso-2022">
     <term><constant>UConverter::ISO_2022</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-1">
     <term><constant>UConverter::LMBCS_1</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-2">
     <term><constant>UConverter::LMBCS_2</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-3">
     <term><constant>UConverter::LMBCS_3</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-4">
     <term><constant>UConverter::LMBCS_4</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-5">
     <term><constant>UConverter::LMBCS_5</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-6">
     <term><constant>UConverter::LMBCS_6</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-8">
     <term><constant>UConverter::LMBCS_8</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-11">
     <term><constant>UConverter::LMBCS_11</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-16">
     <term><constant>UConverter::LMBCS_16</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-17">
     <term><constant>UConverter::LMBCS_17</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-18">
     <term><constant>UConverter::LMBCS_18</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-19">
     <term><constant>UConverter::LMBCS_19</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.lmbcs-last">
     <term><constant>UConverter::LMBCS_LAST</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.hz">
     <term><constant>UConverter::HZ</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.scsu">
     <term><constant>UConverter::SCSU</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.iscii">
     <term><constant>UConverter::ISCII</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.us-ascii">
     <term><constant>UConverter::US_ASCII</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf7">
     <term><constant>UConverter::UTF7</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.bocu1">
     <term><constant>UConverter::BOCU1</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf16">
     <term><constant>UConverter::UTF16</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.utf32">
     <term><constant>UConverter::UTF32</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.cesu8">
     <term><constant>UConverter::CESU8</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

    <varlistentry xml:id="uconverter.constants.imap-mailbox">
     <term><constant>UConverter::IMAP_MAILBOX</constant></term>
     <listitem>
      <para/>
     </listitem>
    </varlistentry>

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


 </partintro>

 &reference.intl.entities.uconverter;

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