php-doc-en/reference/strings/functions/str-rot13.xml
Nuno Lopes ac7df6a5cc remove that funny tip
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@149565 c90b9560-bf6c-de11-be94-00142212c4b1
2004-01-23 20:06:32 +00:00

66 lines
1.9 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/strings.xml, last change in rev 1.2 -->
<refentry id='function.str-rot13'>
<refnamediv>
<refname>str_rot13</refname>
<refpurpose>Perform the rot13 transform on a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>str_rot13</methodname>
<methodparam><type>string</type><parameter>str</parameter></methodparam>
</methodsynopsis>
<para>
This function performs the ROT13 encoding on the
<parameter>str</parameter> argument and returns the resulting
string. The ROT13 encoding simply shifts every letter by 13
places in the alphabet while leaving non-alpha characters
untouched. Encoding and decoding are done by the same function,
passing an encoded string as argument will return the original version.
</para>
<para>
<example>
<title><function>str_rot13</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
echo str_rot13('PHP 4.3.0'); // CUC 4.3.0
?>
]]>
</programlisting>
</example>
</para>
<note>
<para>
The behaviour of this function was buggy until PHP 4.3.0. Before
this, the <parameter>str</parameter> was also modified, as if
passed by reference.
</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:"../../../../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
-->