diff options
author | Nicolas Favre-Felix <n.favrefelix@gmail.com> | 2010-03-16 19:18:52 +0300 |
---|---|---|
committer | Nicolas Favre-Felix <n.favrefelix@gmail.com> | 2010-03-16 19:18:52 +0300 |
commit | 63dfbf7aa621563b830a744d0399bcb9f167b3be (patch) | |
tree | b73237eb45732185156ee32d258ae15544b31082 /README.markdown | |
parent | 0463c527482d57637a6701b8a46379ed64f915a1 (diff) |
Added docs.
Diffstat (limited to 'README.markdown')
-rw-r--r-- | README.markdown | 137 |
1 files changed, 135 insertions, 2 deletions
diff --git a/README.markdown b/README.markdown index 2b415e04..6082b1ab 100644 --- a/README.markdown +++ b/README.markdown @@ -1307,7 +1307,7 @@ Adds a value to the hash stored at key. If this value is already in the hash, `F *value* ##### *Return value* -*LONG* `TRUE` if value didn't exist and was added successfully, `FALSE` if the value was already present and was replaced. +*BOOL* `TRUE` if value didn't exist and was added successfully, `FALSE` if the value was already present and was replaced. ##### *Example* <pre> $redis->delete('h') @@ -1327,4 +1327,137 @@ Gets a value from the hash stored at key. If the hash table doesn't exist, or th ##### *Return value* *STRING* The value, if the command executed successfully -*BOOL* `FALSE` in case of failure (empty list) +*BOOL* `FALSE` in case of failure + + +## hLen +##### *Description* +Returns the length of a hash, in number of items +##### *Parameters* +*key* + +##### *Return value* +*LONG* the number of items in a hash, `FALSE` if the key doesn't exist or isn't a hash. +##### *Example* +<pre> +$redis->delete('h') +$redis->hSet('h', 'key1', 'hello'); +$redis->hSet('h', 'key2', 'plop'); +$redis->hLen('h'); /* returns 2 */ +</pre> + +## hDel +##### *Description* +Removes a value from the hash stored at key. If the hash table doesn't exist, or the key doesn't exist, `FALSE` is returned. +##### *Parameters* +*key* +*hashKey* + +##### *Return value* +*BOOL* `TRUE` in case of success, `FALSE` in case of failure + + +## hKeys +##### *Description* +Returns the keys in a hash, as an array of strings. + +##### *Parameters* +*Key*: key + +##### *Return value* +An array of elements, the keys of the hash. This works like PHP's array_keys(). + +##### *Example* +<pre> +$redis->delete('h'); +$redis->hSet('h', 'a', 'x'); +$redis->hSet('h', 'b', 'y'); +$redis->hSet('h', 'c', 'z'); +$redis->hSet('h', 'd', 't'); +var_dump($redis->hKeys('h')); +</pre> + +Output: +<pre> +array(4) { + [0]=> + string(1) "a" + [1]=> + string(1) "b" + [2]=> + string(1) "c" + [3]=> + string(1) "d" +} +</pre> +The order is random and corresponds to redis' own internal representation of the set structure. + +## hVals +##### *Description* +Returns the values in a hash, as an array of strings. + +##### *Parameters* +*Key*: key + +##### *Return value* +An array of elements, the values of the hash. This works like PHP's array_values(). + +##### *Example* +<pre> +$redis->delete('h'); +$redis->hSet('h', 'a', 'x'); +$redis->hSet('h', 'b', 'y'); +$redis->hSet('h', 'c', 'z'); +$redis->hSet('h', 'd', 't'); +var_dump($redis->hVals('h')); +</pre> + +Output: +<pre> +array(4) { + [0]=> + string(1) "x" + [1]=> + string(1) "y" + [2]=> + string(1) "z" + [3]=> + string(1) "t" +} +</pre> +The order is random and corresponds to redis' own internal representation of the set structure. + +## hGetAll +##### *Description* +Returns the whole hash, as an array of strings indexed by strings. + +##### *Parameters* +*Key*: key + +##### *Return value* +An array of elements, the contents of the hash. + +##### *Example* +<pre> +$redis->delete('h'); +$redis->hSet('h', 'a', 'x'); +$redis->hSet('h', 'b', 'y'); +$redis->hSet('h', 'c', 'z'); +$redis->hSet('h', 'd', 't'); +var_dump($redis->hGetAll('h')); +</pre> + +Output: +<pre> +array(4) { + ["a"]=> + string(1) "x" + ["b"]=> + string(1) "y" + ["c"]=> + string(1) "z" + ["d"]=> + string(1) "t" +} +</pre> +The order is random and corresponds to redis' own internal representation of the set structure. |