bindtextdomain.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.bindtextdomain" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>bindtextdomain</refname>
  <refpurpose>Sets or gets the path for a domain</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>string</type><type>false</type></type><methodname>bindtextdomain</methodname>
   <methodparam><type>string</type><parameter>domain</parameter></methodparam>
   <methodparam><type class="union"><type>string</type><type>null</type></type><parameter>directory</parameter></methodparam>
  </methodsynopsis>
  <para>
   The <function>bindtextdomain</function> function sets or gets the path
   for a domain.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>domain</parameter></term>
     <listitem>
      <para>
       The domain.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>directory</parameter></term>
     <listitem>
      <para>
       The directory path.
       An empty string means the current directory.
       If &null;, the currently set directory is returned.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The full pathname for the <parameter>domain</parameter> currently being set,
   &return.falseforfailure;.
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     <row>
      <entry>8.0.3</entry>
      <entry>
       <parameter>directory</parameter> is nullable now.
       Previously, it was not possible to retrieve the currently set directory.
      </entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>bindtextdomain</function> example</title>
    <programlisting role="php">
<![CDATA[
<?php

$domain = 'myapp';
echo bindtextdomain($domain, '/usr/share/myapp/locale');

?>
]]>
    </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
/usr/share/myapp/locale
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    The <function>bindtextdomain</function> information is maintained per process,
    not per thread.
   </para>
  </note>
 </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
-->