hholzgra Sat Dec 15 09:52:27 2001 EDT
Modified files:
/phpdoc/en/functions strings.xml
Log:
added str_rot13
Index: phpdoc/en/functions/strings.xml
diff -u phpdoc/en/functions/strings.xml:1.138 phpdoc/en/functions/strings.xml:1.139
--- phpdoc/en/functions/strings.xml:1.138 Fri Dec 14 15:27:08 2001
+++ phpdoc/en/functions/strings.xml Sat Dec 15 09:52:19 2001
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.138 $ -->
+<!-- $Revision: 1.139 $ -->
<reference id="ref.strings">
<title>String functions</title>
<titleabbrev>Strings</titleabbrev>
@@ -1868,6 +1868,30 @@
<function>nl2br</function>, and
<function>stripslashes</function>.
</simpara>
+ </refsect1>
+ </refentry>
+
+ <refentry id='function.str-rot13'>
+ <refnamediv>
+ <refname>str_rot13</refname>
+ <refpurpose>Perform the rot13 transform on a string</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>str_rot13</function></funcdef>
+ <paramdef>string <parameter>str</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <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>
</refsect1>
</refentry>
