diff options
| author | Derek Allard <derek.allard@ellislab.com> | 2009-10-08 18:42:59 +0200 |
|---|---|---|
| committer | Derek Allard <derek.allard@ellislab.com> | 2009-10-08 18:42:59 +0200 |
| commit | 8719a5c7fe75b84f49f584065e5ef4e4e2a0f16f (patch) | |
| tree | 9bcf90c2529519ca8aaf75fc8a7a307a08dde8f3 | |
| parent | 15bc6f50246c864c64fabd55a35be28c3b5ef6c1 (diff) | |
Deprecated the dohash() function in favour of do_hash() for naming consistency.
| -rw-r--r-- | system/helpers/security_helper.php | 20 | ||||
| -rw-r--r-- | user_guide/changelog.html | 1 | ||||
| -rw-r--r-- | user_guide/helpers/security_helper.html | 7 |
3 files changed, 23 insertions, 5 deletions
diff --git a/system/helpers/security_helper.php b/system/helpers/security_helper.php index 9cc70aaff..8fb53e718 100644 --- a/system/helpers/security_helper.php +++ b/system/helpers/security_helper.php @@ -49,13 +49,29 @@ if ( ! function_exists('xss_clean')) /** * Hash encode a string * + * This is simply an alias for do_hash() + * dohash() is now deprecated + */ +if ( ! function_exists('dohash')) +{ + function dohash($str, $type = 'sha1') + { + return $this->do_hash($str, $type); + } +} + +// -------------------------------------------------------------------- + +/** + * Hash encode a string + * * @access public * @param string * @return string */ -if ( ! function_exists('dohash')) +if ( ! function_exists('do_hash')) { - function dohash($str, $type = 'sha1') + function do_hash($str, $type = 'sha1') { if ($type == 'sha1') { diff --git a/user_guide/changelog.html b/user_guide/changelog.html index a941904ce..e61961b39 100644 --- a/user_guide/changelog.html +++ b/user_guide/changelog.html @@ -70,6 +70,7 @@ SVN Revision: </p> <li>Helpers <ul> <li>Added accept-charset to the list of inserted attributes of <kbd>form_open()</kbd> in the <a href="helpers/form_helper.html">Form Helper</a>.</li> + <li>Deprecated the <kbd>dohash()</kbd> function in favour of <kbd>do_hash()</kbd> for naming consistency.</li> </ul> </li> </ul> diff --git a/user_guide/helpers/security_helper.html b/user_guide/helpers/security_helper.html index 5732cb7db..dfc813c66 100644 --- a/user_guide/helpers/security_helper.html +++ b/user_guide/helpers/security_helper.html @@ -75,16 +75,17 @@ Security Helper <a href="../libraries/input.html">Input class</a>. More info can be found there.</p> -<h2>dohash()</h2> +<h2>do_hash()</h2> <p>Permits you to create SHA1 or MD5 one way hashes suitable for encrypting passwords. Will create SHA1 by default. Examples:</p> <code> -$str = dohash($str); // SHA1<br /> +$str = do_hash($str); // SHA1<br /> <br /> -$str = dohash($str, 'md5'); // MD5 +$str = do_hash($str, 'md5'); // MD5 </code> +<p class="important"><strong>Note:</strong> This function was formerly named <kbd>dohash()</kbd>, which has been deprecated in favour of <kbd>do_hash()</kbd>.</p> |