Added GETBIT, SETBIT with doc and unit tests.

Author: nicolasff

README.markdown

@@ -1427,6 +1427,44 @@ $redis->set('key', 'value');
 $redis->strlen('key'); /* 5 */
 </pre>
 
+## getBit
+##### *Description*
+Return a single bit out of a larger string
+
+##### *Parameters*
+*key*  
+*offset*  
+
+##### *Return value*
+*LONG*: the bit value (0 or 1)
+
+##### *Example*
+<pre>
+$redis->set('key', "\x7f"); // this is 0111 1111
+$redis->getBit('key', 0); /* 0 */
+$redis->getBit('key', 1); /* 1 */
+</pre>
+
+## setBit
+##### *Description*
+Changes a single bit of a string.
+
+##### *Parameters*
+*key*  
+*offset*  
+*value*: bool or int (1 or 0)  
+
+##### *Return value*
+*LONG*: 0 or 1, the value of the bit before it was set.
+
+##### *Example*
+<pre>
+$redis->set('key', "*");	// ord("*") = 42 = 0x2f = "0010 1010"
+$redis->setBit('key', 5, 1); /* returns 0 */
+$redis->setBit('key', 7, 1); /* returns 0 */
+$redis->get('key'); /* chr(0x2f) = "/" = b("0010 1111") */
+</pre>
+
 ## flushDB
 
 ##### *Description*

php_redis.h

@@ -47,6 +47,8 @@ PHP_METHOD(Redis, type);
 PHP_METHOD(Redis, append);
 PHP_METHOD(Redis, getRange);
 PHP_METHOD(Redis, setRange);
+PHP_METHOD(Redis, getBit);
+PHP_METHOD(Redis, setBit);
 PHP_METHOD(Redis, strlen);
 PHP_METHOD(Redis, getKeys);
 PHP_METHOD(Redis, sort);

redis.c

@@ -71,6 +71,8 @@ static zend_function_entry redis_functions[] = {
      PHP_ME(Redis, append, NULL, ZEND_ACC_PUBLIC)
      PHP_ME(Redis, getRange, NULL, ZEND_ACC_PUBLIC)
      PHP_ME(Redis, setRange, NULL, ZEND_ACC_PUBLIC)
+     PHP_ME(Redis, getBit, NULL, ZEND_ACC_PUBLIC)
+     PHP_ME(Redis, setBit, NULL, ZEND_ACC_PUBLIC)
      PHP_ME(Redis, strlen, NULL, ZEND_ACC_PUBLIC)
      PHP_ME(Redis, getKeys, NULL, ZEND_ACC_PUBLIC)
      PHP_ME(Redis, sort, NULL, ZEND_ACC_PUBLIC)
@@ -1154,6 +1156,60 @@ PHP_METHOD(Redis, setRange)
 	REDIS_PROCESS_RESPONSE(redis_long_response);
 }
 
+PHP_METHOD(Redis, getBit)
+{
+	zval *object;
+	RedisSock *redis_sock;
+	char *key = NULL, *cmd;
+	int key_len, cmd_len;
+	long offset;
+
+	if (zend_parse_method_parameters(ZEND_NUM_ARGS() TSRMLS_CC, getThis(), "Osl",
+                                     &object, redis_ce, &key, &key_len,
+                                     &offset) == FAILURE) {
+		RETURN_FALSE;
+	}
+
+	if (redis_sock_get(object, &redis_sock TSRMLS_CC) < 0) {
+		RETURN_FALSE;
+	}
+
+	cmd_len = redis_cmd_format_static(&cmd, "GETBIT", "sd", key, key_len, (int)offset);
+	REDIS_PROCESS_REQUEST(redis_sock, cmd, cmd_len);
+	IF_ATOMIC() {
+		redis_long_response(INTERNAL_FUNCTION_PARAM_PASSTHRU, redis_sock, NULL, NULL);
+	}
+	REDIS_PROCESS_RESPONSE(redis_long_response);
+}
+
+PHP_METHOD(Redis, setBit)
+{
+	zval *object;
+	RedisSock *redis_sock;
+	char *key = NULL, *cmd;
+	int key_len, cmd_len;
+	long offset;
+	zend_bool val;
+
+	if (zend_parse_method_parameters(ZEND_NUM_ARGS() TSRMLS_CC, getThis(), "Oslb",
+                                     &object, redis_ce, &key, &key_len,
+                                     &offset, &val) == FAILURE) {
+		RETURN_FALSE;
+	}
+
+	if (redis_sock_get(object, &redis_sock TSRMLS_CC) < 0) {
+		RETURN_FALSE;
+	}
+
+	cmd_len = redis_cmd_format_static(&cmd, "SETBIT", "sdd", key, key_len, (int)offset, (int)val);
+	REDIS_PROCESS_REQUEST(redis_sock, cmd, cmd_len);
+	IF_ATOMIC() {
+		redis_long_response(INTERNAL_FUNCTION_PARAM_PASSTHRU, redis_sock, NULL, NULL);
+	}
+	REDIS_PROCESS_RESPONSE(redis_long_response);
+}
+
+
 PHP_METHOD(Redis, strlen)
 {
 	zval *object;

tests/TestRedis.php

@@ -55,6 +55,46 @@ public function testPing()
 
     }
 
+    public function testBitsets() {
+
+	    $this->redis->delete('key');
+	    $this->assertTrue(0 === $this->redis->getBit('key', 0));
+	    $this->assertTrue(FALSE === $this->redis->getBit('key', -1));
+	    $this->assertTrue(0 === $this->redis->getBit('key', 100000));
+
+	    $this->redis->set('key', "\xff");
+	    for($i = 0; $i < 8; $i++) {
+		    $this->assertTrue(1 === $this->redis->getBit('key', $i));
+	    }
+	    $this->assertTrue(0 === $this->redis->getBit('key', 8));
+
+	    // negative offset doesn't work
+	    $this->assertTrue(FALSE === $this->redis->setBit('key', -1, 0));
+	    $this->assertTrue(1 === $this->redis->getBit('key', 0));
+
+	    // change bit 0
+	    $this->assertTrue(1 === $this->redis->setBit('key', 0, 0));
+	    $this->assertTrue(0 === $this->redis->setBit('key', 0, 0));
+	    $this->assertTrue(0 === $this->redis->getBit('key', 0));
+	    $this->assertTrue("\x7f" === $this->redis->get('key'));
+
+	    // change bit 1
+	    $this->assertTrue(1 === $this->redis->setBit('key', 1, 0));
+	    $this->assertTrue(0 === $this->redis->setBit('key', 1, 0));
+	    $this->assertTrue(0 === $this->redis->getBit('key', 1));
+	    $this->assertTrue("\x3f" === $this->redis->get('key'));
+
+	    // change bit > 1
+	    $this->assertTrue(1 === $this->redis->setBit('key', 2, 0));
+	    $this->assertTrue(0 === $this->redis->setBit('key', 2, 0));
+	    $this->assertTrue(0 === $this->redis->getBit('key', 2));
+	    $this->assertTrue("\x1f" === $this->redis->get('key'));
+
+	    // values above 1 are changed to 1 but don't overflow on bits to the right.
+	    $this->assertTrue(0 === $this->redis->setBit('key', 0, 0xff));
+	    $this->assertTrue("\x9f" === $this->redis->get('key'));
+    }
+
     public function test1000() {
 
 	 $s = str_repeat('A', 1000);
@@ -1793,8 +1833,6 @@ public function testSetRange() {
 	    $this->redis->delete('key');
 	    $this->redis->setRange('key', 6, 'foo');
 	    $this->assertTrue("\x00\x00\x00\x00\x00\x00foo" === $this->redis->get('key'));
-
-
     }
 
     public function testMultiExec() {