summaryrefslogtreecommitdiff
path: root/ext/hash/README
diff options
context:
space:
mode:
authorMark A. Hershberger <mah@debian.(none)>2009-03-25 00:35:13 -0400
committerMark A. Hershberger <mah@debian.(none)>2009-03-25 00:35:13 -0400
commit0a36161e13484a99ccf69bb38f206462d27cc6d6 (patch)
treed5107db4b7369603ac7c753829e8972ee74949f7 /ext/hash/README
parentce7edc9b3c7370f32fec0bc7a8ec3e29ed9a5f61 (diff)
downloadphp-0a36161e13484a99ccf69bb38f206462d27cc6d6.tar.gz
Imported Upstream version 5.1.2upstream/5.1.2
Diffstat (limited to 'ext/hash/README')
-rw-r--r--ext/hash/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/ext/hash/README b/ext/hash/README
new file mode 100644
index 000000000..97eb206d0
--- /dev/null
+++ b/ext/hash/README
@@ -0,0 +1,19 @@
+Generic hashing framework for PHP
+
+Simplest usages:
+
+$digest = hash($algoname, $message);
+$digest = hash_file($algoname, $filename);
+
+Examples:
+
+$digest = hash('md5', 'The quick brown fox jumped over the lazy dog.');
+
+Feeder usage:
+
+$context = hash_init($algoname);
+hash_update($context, $message);
+$digest = hash_final($context);
+
+hash(), hash_file(), and hash_final() each support an optional boolean parameter $raw_output which behaves in the same
+manner as sha1()'s optional parameter.