Skip to content

Commit

Permalink
Doc.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicolas Favre-Felix committed Nov 23, 2009
1 parent d3dfa8a commit f0f722a
Showing 1 changed file with 188 additions and 5 deletions.
193 changes: 188 additions & 5 deletions README.markdown
Expand Up @@ -112,31 +112,102 @@ $redis->incr('key1'); /* 4 */
##### Return value
##### Examples

## rpush
## lpush
##### Description
##### Parameters
##### Return value
##### Examples

## lpush
## rpush
##### Description
##### Parameters
##### Return value
##### Examples
## rpop

## lpop
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## rpop
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## llen
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## lindex
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## lset
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## lrange
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## ltrim
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## lrem
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## sadd
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## srem
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## smove
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## sismember
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## scard
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## spop
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## sinter

##### *Description*
Expand Down Expand Up @@ -184,42 +255,154 @@ array(2) {
</pre>

## sinterstore
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## sunion
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## sunionstore
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## sdiff
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## sdiffstore
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## smembers
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## incrby
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## decrby
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## getset
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## randomkey
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## select
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## move
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## rename
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## renamenx
## expire
##### *Description*
##### *Parameters*
##### *Return value*
##### *Example*

## setTimeout
##### *Description*
Sets an expiration date (a timeout) on an item.

##### *Parameters*
key: string. The key that will disappear.
ttl: integer. The key's remaining Time To Live, in seconds.

##### *Return value*
TRUE in case of success, FALSE in case of failure.
##### *Example*
<pre>
$this->set('x', '42');
$this->setTimeout('x', 3); // x will disappear in 3 seconds.
sleep(5); // wait 5 seconds
$this->get('x'); // will return NULL.
</pre>

## keys
##### *Description*
Returns the keys that match a certain pattern.

##### *Parameters*
pattern: string using '*' as a wildcard.

##### *Return value*
A list of strings, corresponding to keys matching the given pattern.

##### *Example*
<pre>
$allKeys = $this->redis->getKeys('*'); // all keys will match this.
$keyWithUserPrefix = $this->redis->getKeys('user*');
</pre>

## dbsize
## dbSize
##### *Description*
Returns the current database's size.

##### *Parameters*
None.

##### *Return value*
DB size, in number of keys.

##### *Example*
<pre>
$count = $redis->dbSize();
echo "Redis has $count keys\n";
</pre>

## auth
##### *Description*
Authenticate the connection using a password.
*Warning*: The password is sent in plain-text over the network.

##### *Parameters*
password: string

##### *Return value*
TRUE if the connection is authenticated, FALSE otherwise.

##### *Example*
<pre>
$redis->auth('foobared');
</pre>

## save
##### *Description*
Expand Down

0 comments on commit f0f722a

Please sign in to comment.