php-doc-en/reference/recode/functions/recode-string.xml
2003-12-15 16:55:22 +00:00

58 lines
1.8 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/recode.xml, last change in rev 1.2 -->
<refentry id="function.recode-string">
<refnamediv>
<refname>recode_string</refname>
<refpurpose>Recode a string according to a recode request</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>recode_string</methodname>
<methodparam><type>string</type><parameter>request</parameter></methodparam>
<methodparam><type>string</type><parameter>string</parameter></methodparam>
</methodsynopsis>
<para>
Recode the string <parameter>string</parameter> according to
the recode request <parameter>request</parameter>. Returns the
recoded string or &false;, if unable to perform the recode request.
</para>
<para>
A simple recode request may be &quot;lat1..iso646-de&quot;.
See also the GNU Recode documentation of your installation
for detailed instructions about recode requests.
<example>
<title>Basic <function>recode_string</function> example:</title>
<programlisting role="php">
<![CDATA[
<?php
echo recode_string("us..flat", "The following character has a diacritical mark: &aacute;");
?>
]]>
</programlisting>
</example>
</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
-->