summaryrefslogtreecommitdiffstats
path: root/user_guide
diff options
context:
space:
mode:
authorDerek Allard <derek.allard@ellislab.com>2010-01-23 21:03:27 +0100
committerDerek Allard <derek.allard@ellislab.com>2010-01-23 21:03:27 +0100
commit472dd21a7bc60147afff7bf100bbb6c9f339d0fc (patch)
tree48c834abc062a6d4fd2b0b5cb5814f07a75e0247 /user_guide
parent9e94ee10520a9d95eab1b1a0e9c9b27d39b7214a (diff)
Added alpha, and sha1 string types to random_string() in the String Helper.
Diffstat (limited to 'user_guide')
-rw-r--r--user_guide/changelog.html1
-rw-r--r--user_guide/helpers/string_helper.html14
2 files changed, 9 insertions, 6 deletions
diff --git a/user_guide/changelog.html b/user_guide/changelog.html
index b8601ab3a..4214a0de5 100644
--- a/user_guide/changelog.html
+++ b/user_guide/changelog.html
@@ -86,6 +86,7 @@ SVN Revision: </p>
<li>Modified the second parameter of <kbd>directory_map()</kbd> in the <a href="helpers/directory_helper.html">Directory Helper</a> to accept an integer to specify recursion depth.</li>
<li>Modified <kbd>delete_files()</kbd> in the <a href="helpers/file_helper.html">File Helper</a> to return FALSE on failure.</li>
<li>Added an optional second parameter to <kbd>byte_format()</kbd> in the <a href="helpers/number_helper.html">Number Helper</a> to allow for decimal precision.</li>
+ <li>Added alpha, and sha1 string types to <kbd>random_string()</kbd> in the <a href="helpers/string_helper.html">String Helper</a>.</li>
</ul>
</li>
<li>Other Changes
diff --git a/user_guide/helpers/string_helper.html b/user_guide/helpers/string_helper.html
index 36fa40f98..b799390c3 100644
--- a/user_guide/helpers/string_helper.html
+++ b/user_guide/helpers/string_helper.html
@@ -74,13 +74,15 @@ String Helper
<p>The first parameter specifies the type of string, the second parameter specifies the length. The following choices are available:</p>
-
+ alpha, alunum, numeric, nozero, unique, md5, encrypt and sha1
<ul>
-<li><strong>alnum</strong>:&nbsp; Alpha-numeric string with lower and uppercase characters.</li>
-<li><strong>numeric</strong>:&nbsp; Numeric string.</li>
-<li><strong>nozero</strong>:&nbsp; Numeric string with no zeros.</li>
-<li><strong>unique</strong>:&nbsp; Encrypted with MD5 and uniqid(). Note: The length parameter is not available for this type.
-Returns a fixed length 32 character string.</li>
+ <li><strong>alpha</strong>:&nbsp; A string with lower and uppercase letters only.</li>
+ <li><strong>alnum</strong>:&nbsp; Alpha-numeric string with lower and uppercase characters.</li>
+ <li><strong>numeric</strong>:&nbsp; Numeric string.</li>
+ <li><strong>nozero</strong>:&nbsp; Numeric string with no zeros.</li>
+ <li><strong>unique</strong>:&nbsp; Encrypted with MD5 and uniqid(). Note: The length parameter is not available for this type.
+ Returns a fixed length 32 character string.</li>
+ <li><strong>sha1</strong>:&nbsp; An encrypted random number based on <kbd>do_hash()</kbd> from the <a href="security_helper.html">security helper</a>.</li>
</ul>
<p>Usage example:</p>