php-doc-en/reference/fribidi/functions/fribidi-log2vis.xml
Nilgün Belma Bugüner 32c02d8b9f fixed properties
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283810 c90b9560-bf6c-de11-be94-00142212c4b1
2009-07-11 07:05:15 +00:00

79 lines
2.1 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision$ -->
<refentry xml:id="function.fribidi-log2vis" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fribidi_log2vis</refname>
<refpurpose>Convert a logical string to a visual one</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>fribidi_log2vis</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
<methodparam><type>string</type><parameter>direction</parameter></methodparam>
<methodparam><type>int</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
Converts a logical string to a visual one.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>str</parameter></term>
<listitem>
<para>
The logical string.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>direction</parameter></term>
<listitem>
<para>
One of <constant>FRIBIDI_RTL</constant>,
<constant>FRIBIDI_LTR</constant> or <constant>FRIBIDI_AUTO</constant>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>charset</parameter></term>
<listitem>
<para>
One of the <literal>FRIBIDI_CHARSET_XXX</literal> constants.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the visual string on success, or &false; on failure.
</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:"../../../../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
-->