Added expireAt + test + documentation.

Author: Nicolas Favre-Felix

README.markdown

@@ -836,7 +836,7 @@ $redis->get('x'); 	// → `FALSE`
 ##### *Description*
 Same as rename, but will not replace a key if the destination already exists. This is the same behaviour as setNx.
 
-## setTimeout
+## setTimeout, expire
 ##### *Description*
 Sets an expiration date (a timeout) on an item.
 
@@ -855,6 +855,26 @@ sleep(5);				// wait 5 seconds
 $this->get('x'); 		// will return `FALSE`, as 'x' has expired.
 </pre>
 
+## expireAt
+##### *Description*
+Sets an expiration date (a timestamp) on an item.
+
+##### *Parameters*
+*Key*: key. The key that will disappear.
+
+*Integer*: Unix timestamp. The key's date of death, in seconds from Epoch time.
+
+##### *Return value*
+*BOOL*: `TRUE` in case of success, `FALSE` in case of failure.
+##### *Example*
+<pre>
+$redis->set('x', '42');
+$now = time(NULL); // current timestamp
+$redis->setTimeout('x', $now + 3);	// x will disappear in 3 seconds.
+sleep(5);				// wait 5 seconds
+$this->get('x'); 		// will return `FALSE`, as 'x' has expired.
+</pre>
+
 ## getKeys
 ##### *Description*
 Returns the keys that match a certain pattern.

php_redis.h

@@ -88,6 +88,7 @@ PHP_METHOD(Redis, zDeleteRangeByScore);
 PHP_METHOD(Redis, zCard);
 PHP_METHOD(Redis, zScore);
 PHP_METHOD(Redis, zIncrBy);
+PHP_METHOD(Redis, expireAt);
 
 PHP_METHOD(Redis, mset);
 PHP_METHOD(Redis, rpoplpush);

redis.c

@@ -108,6 +108,7 @@ static zend_function_entry redis_functions[] = {
      PHP_ME(Redis, zCard, NULL, ZEND_ACC_PUBLIC)
      PHP_ME(Redis, zScore, NULL, ZEND_ACC_PUBLIC)
      PHP_ME(Redis, zIncrBy, NULL, ZEND_ACC_PUBLIC)
+     PHP_ME(Redis, expireAt, NULL, ZEND_ACC_PUBLIC)
 
      /* aliases */
      PHP_MALIAS(Redis, open, connect, NULL, ZEND_ACC_PUBLIC)
@@ -2148,27 +2149,27 @@ PHP_METHOD(Redis, sortDescAlpha)
 }
 /* }}} */
 
-/* {{{ proto array Redis::setTimeout(string key, int timeout)
- */
-PHP_METHOD(Redis, setTimeout) {
-
+PHPAPI void generic_expire_cmd(INTERNAL_FUNCTION_PARAMETERS, char *keyword, int keyword_len TSRMLS_DC) {
     zval *object;
     RedisSock *redis_sock;
     char *key = NULL, *cmd;
     int key_len, cmd_len;
-    long timeout;
+    long t;
 
     if (zend_parse_method_parameters(ZEND_NUM_ARGS() TSRMLS_CC, getThis(), "Osl",
                                      &object, redis_ce, &key, &key_len,
-                                     &timeout) == FAILURE) {
+                                     &t) == FAILURE) {
         RETURN_FALSE;
     }
 
     if (redis_sock_get(object, &redis_sock TSRMLS_CC) < 0) {
         RETURN_FALSE;
     }
 
-    cmd_len = spprintf(&cmd, 0, "EXPIRE %s %d\r\n", key, (int)timeout);
+    cmd_len = redis_cmd_format(&cmd, "%s %s %d\r\n",
+        keyword, keyword_len,
+        key, key_len,
+        (int)t);
 
     if (redis_sock_write(redis_sock, cmd, cmd_len) < 0) {
         efree(cmd);
@@ -2177,8 +2178,22 @@ PHP_METHOD(Redis, setTimeout) {
     efree(cmd);
     redis_1_response(INTERNAL_FUNCTION_PARAM_PASSTHRU, redis_sock TSRMLS_CC);
 }
+
+/* {{{ proto array Redis::setTimeout(string key, int timeout)
+ */
+PHP_METHOD(Redis, setTimeout) {
+    generic_expire_cmd(INTERNAL_FUNCTION_PARAM_PASSTHRU, "EXPIRE", sizeof("EXPIRE")-1 TSRMLS_CC);
+}
 /* }}} */
 
+/* {{{ proto array Redis::expireAt(string key, int timestamp)
+ */
+PHP_METHOD(Redis, expireAt) {
+    generic_expire_cmd(INTERNAL_FUNCTION_PARAM_PASSTHRU, "EXPIREAT", sizeof("EXPIREAT")-1 TSRMLS_CC);
+}
+/* }}} */
+
+
 /* {{{ proto array Redis::lSet(string key, int index, string value)
  */
 PHP_METHOD(Redis, lSet) {

tests/TestRedis.php

@@ -235,6 +235,17 @@ public function testSetTimeout() {
 	$this->assertEquals(False, $this->redis->get('key'));
     }
 
+    public function testExpireAt() {
+
+	$this->redis->delete('key');
+        $this->redis->set('key', 'value');
+	$now = time(NULL);
+	$this->redis->expireAt('key', $now + 1);
+	$this->assertEquals('value', $this->redis->get('key'));
+	sleep(2);
+	$this->assertEquals(FALSE, $this->redis->get('key'));
+    }
+
     public function testSetNX() {
 
 	    $this->redis->set('key', 42);