Merge branch 'master' of https://github.com/michael-grunder/phpredis into michael-grunder

Author: nicolasff

README.markdown

@@ -421,6 +421,24 @@ $redis->incr('key1'); /* 4 */
 $redis->incrBy('key1', 10); /* 14 */
 </pre>
 
+## incrByFloat
+##### Description
+Increment the key with floating point precision.
+##### Parameters
+*key*  
+*value*: (float) value that will be added to the key  
+##### Return value
+*FLOAT* the new value
+##### Examples
+<pre>
+$redis->incrByFloat('key1', 1.5); /* key1 didn't exist, so it will now be 1.5 */
+
+
+$redis->incrByFloat('key1', 1.5); /* 3 */
+$redis->incrByFloat('key1', -1.5); /* 1.5 */
+$redis->incrByFloat('key1', 2.5); /* 3.5 */
+</pre>
+
 ## decr, decrBy
 ##### Description
 Decrement the number stored at key by one. If the second argument is filled, it will be used as the integer value of the decrement.
@@ -1561,6 +1579,29 @@ $redis->setBit('key', 7, 1); /* returns 0 */
 $redis->get('key'); /* chr(0x2f) = "/" = b("0010 1111") */
 </pre>
 
+## bitop
+##### *Description*
+Bitwise operation on multiple keys.
+
+##### *Parameters*
+*operation*: either "AND", "OR", "NOT", "XOR"  
+*ret_key*: return key  
+*key1*  
+*key2...*  
+
+##### *Return value*
+*LONG*: The size of the string stored in the destination key.
+
+## bitcount
+##### *Description*
+Count bits in a string.
+
+##### *Parameters*
+*key*  
+
+##### *Return value*
+*LONG*: The number of bits set to 1 in the value behind the input key.
+
 ## flushDB
 
 ##### *Description*
@@ -1626,7 +1667,9 @@ var_dump($redis->sort('s', array('sort' => 'desc', 'store' => 'out'))); // (int)
 
 ## info
 ##### *Description*
-Returns an associative array of strings and integers, with the following keys:
+Returns an associative array from REDIS that provides information about the server.  Passing
+no arguments to INFO will call the standard REDIS INFO command, which returns information such
+as the following:
 
 * redis_version
 * arch_bits
@@ -1642,13 +1685,17 @@ Returns an associative array of strings and integers, with the following keys:
 * total_commands_processed
 * role
 
+You can pass a variety of options to INFO (per the Redis documentation), which will modify what is
+returned.
 
 ##### *Parameters*
-None.
+*option*: The option to provide redis (e.g. "COMMANDSTATS", "CPU")
 
 ##### *Example*
 <pre>
-$redis->info();
+$redis->info(); /* standard redis INFO command */
+$redis->info("COMMANDSTATS"); /* Information on the commands that have been run (>=2.6 only)
+$redis->info("CPU"); /* just CPU information from Redis INFO */
 </pre>
 
 ## resetStat
@@ -2301,6 +2348,23 @@ $redis->hIncrBy('h', 'x', 2); /* returns 2: h[x] = 2 now. */
 $redis->hIncrBy('h', 'x', 1); /* h[x] ← 2 + 1. Returns 3 */
 </pre>
 
+## hIncrByFloat
+##### Description
+Increments the value of a hash member by the provided float value
+##### Parameters
+*key*  
+*member*  
+*value*: (float) value that will be added to the member's value  
+##### Return value
+*FLOAT* the new value
+##### Examples
+<pre>
+$redis->delete('h');
+$redis->hIncrByFloat('h','x', 1.5); /* returns 1.5: h[x] = 1.5 now */
+$redis->hIncrByFLoat('h', 'x', 1.5); /* returns 3.0: h[x] = 3.0 now */
+$redis->hIncrByFloat('h', 'x', -3.0); /* returns 0.0: h[x] = 0.0 now */
+</pre>
+
 ## hMset
 ##### Description
 Fills in a whole hash. Non-string values are converted to string, using the standard `(string)` cast. NULL values are stored as empty strings.
@@ -2347,3 +2411,127 @@ Get or Set the redis config keys.
 $redis->config("GET", "*max-*-entries*");
 $redis->config("SET", "dir", "/var/run/redis/dumps/");
 </pre>
+
+## eval
+##### Description
+Evaluate a LUA script serverside
+##### Parameters
+*script* string.  
+*args* array, optional.  
+*num_keys* int, optional.  
+##### Return value
+Mixed.  What is returned depends on what the LUA script itself returns, which could be a scalar value (int/string), or an array.
+Arrays that are returned can also contain other arrays, if that's how it was set up in your LUA script.  If there is an error
+executing the LUA script, the getLastError() function can tell you the message that came back from Redis (e.g. compile error).
+##### Examples
+<pre>
+$redis->eval("return 1"); // Returns an integer: 1
+$redis->eval("return {1,2,3}"); // Returns Array(1,2,3)
+$redis->del('mylist');
+$redis->rpush('mylist','a');
+$redis->rpush('mylist','b');
+$redis->rpush('mylist','c');
+// Nested response:  Array(1,2,3,Array('a','b','c'));
+$redis->eval("return {1,2,3,redis.call('lrange','mylist',0,-1)}}");
+</pre>
+
+## evalSha
+##### Description
+Evaluate a LUA script serverside, from the SHA1 hash of the script instead of the script itself.  In order to run this command Redis
+will have to have already loaded the script, either by running it or via the SCRIPT LOAD command.
+##### Parameters
+*script_sha* string.  The sha1 encoded hash of the script you want to run.  
+*args* array, optional.  Arguments to pass to the LUA script.  
+*num_keys* int, optional.  The number of arguments that should go into the KEYS array, vs. the ARGV array when Redis spins the script  
+##### Return value
+Mixed.  See EVAL
+##### Examples
+<pre>
+$script = 'return 1';
+$sha = $redis->script('load', $script);
+$redis->evalSha($sha); // Returns 1
+</pre>
+
+## script
+##### Description
+Execute the Redis SCRIPT command to perform various operations on the scripting subsystem.
+##### Usage
+<pre>
+$redis->script('load', $script);
+$redis->script('flush');
+$redis->script('kill');
+$redis->script('exists', $script1, [$script2, $script3, ...]);
+</pre>
+##### Return value
+* SCRIPT LOAD will return the SHA1 hash of the passed script on success, and FALSE on failure.
+* SCRIPT FLUSH should always return TRUE
+* SCRIPT KILL will return true if a script was able to be killed and false if not
+* SCRIPT EXISTS will return an array with TRUE or FALSE for each passed script
+
+## getLastError
+##### Description
+The last error message (if any) returned from a SCRIPT call
+##### Parameters
+*none*  
+##### Return Value
+A string with the last returned script based error message, or NULL if there is no error
+##### Examples
+<pre>
+$redis->eval('this-is-not-lua');
+$err = $redis->getLastError(); 
+// "ERR Error compiling script (new function): user_script:1: '=' expected near '-'"
+</pre>
+
+## _prefix
+##### Description
+A utility method to prefix the value with the prefix setting for phpredis.
+##### Parameters
+*value* string.  The value you wish to prefix  
+##### Return value
+If a prefix is set up, the value now prefixed.  If there is no prefix, the value will be returned unchanged.
+##### Examples
+<pre>
+$redis->setOpt(Redis::OPT_PREFIX, 'my-prefix:');
+$redis->_prefix('my-value'); // Will return 'my-prefix:my-value'
+</pre>
+
+## _unserialize
+##### Description
+A utility method to unserialize data with whatever serializer is set up.  If there is no serializer set, the value will be
+returned unchanged.  If there is a serializer set up, and the data passed in is malformed, an exception will be thrown.
+This can be useful if phpredis is serializing values, and you return something from redis in a LUA script that is serialized.
+##### Parameters
+*value* string.  The value to be unserialized  
+##### Examples
+<pre>
+$redis->setOpt(Redis::OPT_SERIALIZER, Redis::SERIALIZER_PHP);
+$redis->_unserialize('a:3:{i:0;i:1;i:1;i:2;i:2;i:3;}'); // Will return Array(1,2,3)
+</pre>
+
+## dump
+##### Description
+Dump a key out of a redis database, the value of which can later be passed into redis using the RESTORE command.  The data
+that comes out of DUMP is a binary representation of the key as Redis stores it.
+##### Parameters
+*key* string  
+##### Return value
+The Redis encoded value of the key, or FALSE if the key doesn't exist
+##### Examples
+<pre>
+$redis->set('foo', 'bar');
+$val = $redis->dump('foo'); // $val will be the Redis encoded key value
+</pre>
+
+## restore
+##### Description
+Restore a key from the result of a DUMP operation.
+##### Parameters
+*key* string.  The key name  
+*ttl* integer.  How long the key should live (if zero, no expire will be set on the key)  
+*value* string (binary).  The Redis encoded key value (from DUMP)  
+##### Examples
+<pre>
+$redis->set('foo', 'bar');
+$val = $redis->dump('foo');
+$redis->restore('bar', 0, $val); // The key 'bar', will now be equal to the key 'foo'
+</pre>

common.h

@@ -22,9 +22,18 @@
 #define REDIS_ZSET 4
 #define REDIS_HASH 5
 
+/* reply types */
+typedef enum _REDIS_REPLY_TYPE {
+	TYPE_LINE      = '+',
+	TYPE_INT       = ':',
+	TYPE_ERR       = '-',
+	TYPE_BULK      = '$',
+	TYPE_MULTIBULK = '*'
+} REDIS_REPLY_TYPE;
+
 /* options */
 #define REDIS_OPT_SERIALIZER		1
-#define REDIS_OPT_PREFIX		2
+#define REDIS_OPT_PREFIX		    2
 
 /* serializers */
 #define REDIS_SERIALIZER_NONE		0
@@ -164,6 +173,9 @@ typedef struct {
 
     request_item   *pipeline_head;
     request_item   *pipeline_current;
+
+    char           *err;
+    int            err_len;
 } RedisSock;
 /* }}} */