summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/general
diff options
context:
space:
mode:
authorAndrey Andreev <narf@devilix.net>2014-02-18 15:29:53 +0100
committerAndrey Andreev <narf@devilix.net>2014-02-18 15:29:53 +0100
commit9a152a91c982d5f2ba07d0197ef2fe5eb8c8510c (patch)
tree089223cd683e17c84e4a80a4ee3592df3f5a8e9d /user_guide_src/source/general
parent9c7ce322232eb1e55b9caa138dffe67d9acc660f (diff)
Add an ext/hash compatibility layer (just hash_pbkdf2(), for now)
Diffstat (limited to 'user_guide_src/source/general')
-rw-r--r--user_guide_src/source/general/compatibility_functions.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/user_guide_src/source/general/compatibility_functions.rst b/user_guide_src/source/general/compatibility_functions.rst
index e025d2aa3..3495101ac 100644
--- a/user_guide_src/source/general/compatibility_functions.rst
+++ b/user_guide_src/source/general/compatibility_functions.rst
@@ -93,6 +93,35 @@ Function reference
For more information, please refer to the `PHP manual for
password_verify() <http://php.net/password_verify>`_.
+*********************
+Hash (Message Digest)
+*********************
+
+This compatibility layer contains only a single function at
+this time - ``hash_pbkdf2()``, which otherwise requires PHP 5.5.
+
+Dependancies
+============
+
+- None
+
+Function reference
+==================
+
+.. function:: hash_pbkdf2($algo, $password, $salt, $iterations[, $length = 0[, $raw_output = FALSE]])
+
+ :param string $algo: Hashing algorithm
+ :param string $password: Password
+ :param string $salt: Hash salt
+ :param int $iterations: Number of iterations to perform during derivation
+ :param int $length: Output string length
+ :param bool $raw_output: Whether to return raw binary data
+ :returns: Password-derived key or FALSE on failure
+ :rtype: string
+
+ For more information, please refer to the `PHP manual for
+ hash_pbkdf2() <http://php.net/hash_pbkdf2>`_.
+
****************
Multibyte String
****************