create.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="transliterator.create" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>Transliterator::create</refname>
  <refname>transliterator_create</refname>
  <refpurpose>Create a transliterator</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <para>&style.oop;</para>
  <methodsynopsis role="Transliterator">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>Transliterator</type><type>null</type></type><methodname>Transliterator::create</methodname>
   <methodparam><type>string</type><parameter>id</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>direction</parameter><initializer>Transliterator::FORWARD</initializer></methodparam>
  </methodsynopsis>
  <para>&style.procedural;</para>
  <methodsynopsis>
   <type class="union"><type>Transliterator</type><type>null</type></type><methodname>transliterator_create</methodname>
   <methodparam><type>string</type><parameter>id</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>direction</parameter><initializer>Transliterator::FORWARD</initializer></methodparam>
  </methodsynopsis>
  <para>
   Opens a Transliterator by ID.
  </para>

  &warn.undocumented.func;

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>id</parameter></term>
    <listitem>
     <para>
      The ID. A list of all registered transliterator IDs can be retrieved by using
      <methodname>Transliterator::listIDs</methodname>.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>direction</parameter></term>
    <listitem>
     <para>
      The direction, defaults to 
      <link linkend="transliterator.constants.forward">Transliterator::FORWARD</link>.
      May also be set to
      <link linkend="transliterator.constants.reverse">Transliterator::REVERSE</link>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns a <classname>Transliterator</classname> object on success,
   or &null; on failure.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>Transliterator::getErrorMessage</methodname></member>
    <member><methodname>Transliterator::__construct</methodname></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
-->