From f53dce95c0f5bc0207f1f2337ddcce48d805888d Mon Sep 17 00:00:00 2001
From: Jeroen van Wolffelaar <jeroen@php.net>
Date: Wed, 27 Jun 2001 09:58:49 +0000
Subject: [PATCH] Implemented zak's notes on addcslashes

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@50266 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/strings.xml | 42 +++++++++++++++++++++++++++++++++++++++---
 1 file changed, 39 insertions(+), 3 deletions(-)

diff --git a/functions/strings.xml b/functions/strings.xml
index 9c2cc04e0a..38e93ac596 100644
--- a/functions/strings.xml
+++ b/functions/strings.xml
@@ -38,8 +38,17 @@
      listed in <parameter>charlist</parameter> parameter. It escapes
      <literal>\n</literal>, <literal>\r</literal> etc. in C-like
      style, characters with ASCII code lower than 32 and higher than
-     126 are converted to octal representation. Be carefull when
-     escaping alphanumeric characters. You can specify a range in
+     126 are converted to octal representation. 
+	</para>
+	<para>
+     Be careful if you choose to escape characters 0, a, b, f, n, r, 
+	 t and v. They will be converted to \0, \a, \b, \f, \n, \r, \t 
+	 and \v. 
+     In PHP \0 (NULL), \r (carriage return), \n (newline) and \t (tab) 
+	 are predefined escape sequences, while in C all of these are 
+	 predefined escape sequences.
+	</para>
+	<para>
      <parameter>charlist</parameter> like "\0..\37", which would
      escape all characters with ASCII code between 0 and 31.
      <example>
@@ -48,9 +57,36 @@
 $escaped = addcslashes ($not_escaped, "\0..\37!@\177..\377");
       </programlisting>
      </example>
+	</para>
+	<para>
+	 When you define a sequence of characters in the charlist argument 
+	 make sure that you know what characters come between the characters 
+	 that you set as the start and end of the range. 
+     <informalexample>
+      <programlisting role="php">
+echo addcslashes('foo[]', 'A..z'); 
+// All upper and lower-case letters will be escaped 
+// ..but so will the [\]^_` and space characters. 
+      </programlisting>
+     </informalexample>
+
+	 Also, if the first character in a range has a lower ASCII value 
+	 than the second character in the range, no range will be constructed. 
+	 Only the start, end and period characters will be escaped. Use the 
+	 <function>ord</function> function to find the ASCII value for a character. 
+     <informalexample>
+      <programlisting role="php">
+echo addcslashes("zoo['.']", 'z..A');
+/* output:
+\zoo['\.']
+
+*/
+      </programlisting>
+     </informalexample>
+
      <note>
       <simpara>
-       Added in PHP4b3-dev.</simpara>
+       Added in PHP 4</simpara>
      </note>
     </para>
     <para>