Book/memcached-Phpdoc专题

Memcached

简介
安装／配置
预定义常量
超时时间
回调
- 结果回调
- 通读缓存回调
Sessions支持
Memcached — Memcached类
- Memcached::add — 向一个新的key下面增加一个元素
- Memcached::addByKey — 在指定服务器上的一个新的key下增加一个元素
- Memcached::addServer — 向服务器池中增加一个服务器
- Memcached::addServers — 向服务器池中增加多台服务器
- Memcached::append — 向已存在元素后追加数据
- Memcached::appendByKey — 向指定服务器上已存在元素后追加数据
- Memcached::cas — 比较并交换值
- Memcached::casByKey — 在指定服务器上比较并交换值
- Memcached::__construct — 创建一个Memcached实例
- Memcached::decrement — 减小数值元素的值
- Memcached::decrementByKey — Decrement numeric item's value, stored on a specific server
- Memcached::delete — 删除一个元素
- Memcached::deleteByKey — 从指定的服务器删除一个元素
- Memcached::deleteMulti — Delete multiple items
- Memcached::deleteMultiByKey — Delete multiple items from a specific server
- Memcached::fetch — 抓取下一个结果
- Memcached::fetchAll — 抓取所有剩余的结果
- Memcached::flush — 作废缓存中的所有元素
- Memcached::get — 检索一个元素
- Memcached::getAllKeys — Gets the keys stored on all the servers
- Memcached::getByKey — 从特定的服务器检索元素
- Memcached::getDelayed — 请求多个元素
- Memcached::getDelayedByKey — 从指定的服务器上请求多个元素
- Memcached::getMulti — 检索多个元素
- Memcached::getMultiByKey — 从特定服务器检索多个元素
- Memcached::getOption — 获取Memcached的选项值
- Memcached::getResultCode — 返回最后一次操作的结果代码
- Memcached::getResultMessage — 返回最后一次操作的结果描述消息
- Memcached::getServerByKey — 获取一个key所映射的服务器信息
- Memcached::getServerList — 获取服务器池中的服务器列表
- Memcached::getStats — 获取服务器池的统计信息
- Memcached::getVersion — 获取服务器池中所有服务器的版本信息
- Memcached::increment — 增加数值元素的值
- Memcached::incrementByKey — Increment numeric item's value, stored on a specific server
- Memcached::isPersistent — Check if a persitent connection to memcache is being used
- Memcached::isPristine — Check if the instance was recently created
- Memcached::prepend — 向一个已存在的元素前面追加数据
- Memcached::prependByKey — Prepend data to an existing item on a specific server
- Memcached::quit — 关闭所有打开的链接。
- Memcached::replace — 替换已存在key下的元素
- Memcached::replaceByKey — Replace the item under an existing key on a specific server
- Memcached::resetServerList — Clears all servers from the server list
- Memcached::set — 存储一个元素
- Memcached::setByKey — 将元素存储到指定的服务器上
- Memcached::setMulti — 存储多个元素
- Memcached::setMultiByKey — Store multiple items on a specific server
- Memcached::setOption — 设置一个memcached选项
- Memcached::setOptions — Set Memcached options
- Memcached::setSaslAuthData — Set the credentials to use for authentication
- Memcached::touch — Set a new expiration on an item
- Memcached::touchByKey — Set a new expiration on an item on a specific server

简介

表征到memcached服务集群的连接。

类摘要

Memcached

class Memcached {

__construct ([ string $persistent_id ] )

public bool add ( string $key , mixed $value [, int $expiration ] )

public bool addByKey ( string $server_key , string $key , mixed $value [, int $expiration ] )

public bool addServer ( string $host , int $port [, int $weight = 0 ] )

public bool addServers ( array $servers )

public bool append ( string $key , string $value )

public bool appendByKey ( string $server_key , string $key , string $value )

public bool cas ( float $cas_token , string $key , mixed $value [, int $expiration ] )

public bool casByKey ( float $cas_token , string $server_key , string $key , mixed $value [, int $expiration ] )

public int decrement ( string $key [, int $offset = 1 ] )

public intfalse decrementByKey ( string $server_key , string $key [, int $offset = 1 [, int $initial_value = 0 [, int $expiry = 0 ]]] )

public bool delete ( string $key [, int $time = 0 ] )

public bool deleteByKey ( string $server_key , string $key [, int $time = 0 ] )

public array deleteMulti ( array $keys [, int $time = 0 ] )

public bool deleteMultiByKey ( string $server_key , array $keys [, int $time = 0 ] )

public array fetch ( void )

public array fetchAll ( void )

public bool flush ([ int $delay = 0 ] )

public mixed get ( string $key [, callback $cache_cb [, float &$cas_token ]] )

public arrayfalse getAllKeys ( void )

public mixed getByKey ( string $server_key , string $key [, callback $cache_cb [, float &$cas_token ]] )

public bool getDelayed ( array $keys [, bool $with_cas [, callback $value_cb ]] )

public bool getDelayedByKey ( string $server_key , array $keys [, bool $with_cas [, callback $value_cb ]] )

public mixed getMulti ( array $keys [, int $flags ] )

public array getMultiByKey ( string $server_key , array $keys [, string &$cas_tokens [, int $flags ]] )

public mixed getOption ( int $option )

public int getResultCode ( void )

public string getResultMessage ( void )

public array getServerByKey ( string $server_key )

public array getServerList ( void )

public array getStats ( void )

public array getVersion ( void )

public int increment ( string $key [, int $offset = 1 ] )

public intfalse incrementByKey ( string $server_key , string $key [, int $offset = 1 [, int $initial_value = 0 [, int $expiry = 0 ]]] )

public bool isPersistent ( void )

public bool isPristine ( void )

public bool prepend ( string $key , string $value )

public bool prependByKey ( string $server_key , string $key , string $value )

public bool quit ( void )

public bool replace ( string $key , mixed $value [, int $expiration ] )

public bool replaceByKey ( string $server_key , string $key , mixed $value [, int $expiration ] )

public bool resetServerList ( void )

public bool set ( string $key , mixed $value [, int $expiration ] )

public bool setByKey ( string $server_key , string $key , mixed $value [, int $expiration ] )

public bool setMulti ( array $items [, int $expiration ] )

public bool setMultiByKey ( string $server_key , array $items [, int $expiration ] )

public bool setOption ( int $option , mixed $value )

public bool setOptions ( array $options )

public void setSaslAuthData ( string $username , string $password )

public bool touch ( string $key , int $expiration )

public bool touchByKey ( string $server_key , string $key , int $expiration )

}

Memcached::add

向一个新的key下面增加一个元素

说明

public bool Memcached::add ( string $key , mixed $value [, int $expiration ] )

Memcached::add与 Memcached::set类似，但是如果 key已经在服务端存在，此操作会失败。

参数

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如果key已经存在， Memcached::getResultCode方法将会返回Memcached::RES_NOTSTORED。

参见

Memcached::addByKey
Memcached::set
Memcached::replace

Memcached::addByKey

在指定服务器上的一个新的key下增加一个元素

说明

public bool Memcached::addByKey ( string $server_key , string $key , mixed $value [, int $expiration ] )

Memcached::addByKey在功能上等同于 Memcached::add，不过这种方式可以自由的指定server_key用于将key 映射到特定的服务器。这在你需要将一些相关联的key保存在一个特定的服务器时非常有用。(译注: $server_key也是一个普通的key, *ByKey系列接口的工作过程是: 首先, 对$server_key进行hash, 得到$server_key应该存储的服务器, 然后将相应的操作在 $server_key所在的服务器上进行.)

参数

server_key
本键名用于识别储存和读取值的服务器。没有将实际的键名散列到具体的项目，而是在决定与哪一个 memcached 服务器通信时将其散列为服务器键名。这使得关联的项目在单一的服务上被组合起来以提高多重操作的效率。

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如果key已经存在， Memcached::getResultCode方法将会返回Memcached::RES_NOTSTORED。

参见

Memcached::add
Memcached::set
Memcached::replace

Memcached::addServer

向服务器池中增加一个服务器

说明

public bool Memcached::addServer ( string $host , int $port [, int $weight = 0 ] )

Memcached::addServer增加指定服务器到服务器池中。此时不会建立与服务端的连接，但是，如果你使用一致性key分布选项（Memcached::DISTRIBUTION_CONSISTENT或 Memcached::OPT_LIBKETAMA_COMPATIBLE），一些内部的数据结构将会被更新。因此，如果你需要增加多台服务器，更好的方式是使用 Memcached::addServers 以确保这种更新只发生一次。

同一台服务器可以在服务器池中多次出现，因为这里没有做重复检测。但这是不推荐的做法，对于期望提高某台服务器权重的需求，请使用weight参数。

参数

host
memcached服务端主机名。如果主机名无效，相关的数据操作的返回代码将被设置为Memcached::RES_HOST_LOOKUP_FAILURE。

port
memcached服务端端口号，通常是11211。

weight
此服务器相对于服务器池中所有服务器的权重。此参数用来控制服务器在操作时被选种的概率。这个仅用于一致性分布选项，并且这个值通常是由服务端分配的内存来设置的。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 Memcached::addServer example

<?php
$m = new Memcached();

/* Add 2 servers, so that the second one
   is twice as likely to be selected. */
$m->addServer('mem1.domain.com', 11211, 33);
$m->addServer('mem2.domain.com', 11211, 67);
?>

参见

Memcached::addServers

Memcached::addServers

向服务器池中增加多台服务器

说明

public bool Memcached::addServers ( array $servers )

Memcached::addServers向服务器池中增加servers参数指定的服务器。 servers中的每一条都是一个包含主机名，端口以及可选的权重等服务器参数。此时并不会与这些服务端建立连接。

参数

array
将要增加到池中的服务器列表数组。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 Memcached::addServers示例

<?php
$m = new Memcached();

$servers = array(
    array('mem1.domain.com', 11211, 33),
    array('mem2.domain.com', 11211, 67)
);
$m->addServers($servers);
?>

参见

Memcached::addServer

Memcached::append

向已存在元素后追加数据

说明

public bool Memcached::append ( string $key , string $value )

Memcached::append向已经存在的元素后追加value参数对应的字符串值。 value被强制转换成字符串类型主要是因为对于mix类型的追加没有很好的定义。

Note:

如果Memcached::OPT_COMPRESSION常量开启，这个操作会失败，并引发一个警告，因为向压缩数据后追加数据可能会导致解压不了。

参数

key
用于存储值的键名。

value
将要追加的值。

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在， Memcached::getResultCode将返回Memcached::RES_NOTSTORED。

范例

示例 #1 Memcached::append示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);
$m->setOption(Memcached::OPT_COMPRESSION, false);

$m->set('foo', 'abc');
$m->append('foo', 'def');
var_dump($m->get('foo'));
?>

以上例程会输出：

string(6) "abcdef"

参见

Memcached::appendByKey
Memcached::prepend

Memcached::appendByKey

向指定服务器上已存在元素后追加数据

说明

public bool Memcached::appendByKey ( string $server_key , string $key , string $value )

除了可以使用server_key自由的将key映射到指定服务器外， Memcached::appendByKey在功能上等同于 Memcached::append。 (译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)

参数

key
用于存储值的键名。

value
要追加的字符串。

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在， Memcached::getResultCode将返回 Memcached::RES_NOTSTORED。

参见

Memcached::append
Memcached::prepend

Memcached::cas

比较并交换值

说明

public bool Memcached::cas ( float $cas_token , string $key , mixed $value [, int $expiration ] )

Memcached::cas执行一个“检查并设置”的操作，因此，它仅在当前客户端最后一次取值后，该key 对应的值没有被其他客户端修改的情况下，才能够将值写入。检查是通过cas_token参数进行的，这个参数是Memcach指定给已经存在的元素的一个唯一的64位值，怎样获取这个值请查看 Memcached::get* 系列方法的文档。注意：这个值作为double类型是因为PHP的整型空间限制。

译注：这是Memcached扩展比Memcache扩展一个非常重要的优势，在这样一个系统级（Memcache自身提供）的冲突检测机制（乐观锁）下，我们才能保证高并发下的数据安全。

参数

cas_token
与已存在元素关联的唯一的值，由Memcache生成。

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如果在元素尝试存储时发现在本客户端最后一次获取后被其他客户端修改， Memcached::getResultCode 将返回Memcached::RES_DATA_EXISTS。

范例

示例 #1 Memcached::cas 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

do {
    /* 获取ip列表以及它的标记 */
    $ips = $m->get('ip_block', null, $cas);
    /* 如果列表不存在， 创建并进行一个原子添加（如果其他客户端已经添加， 这里就返回false）*/
    if ($m->getResultCode() == Memcached::RES_NOTFOUND) {
        $ips = array($_SERVER['REMOTE_ADDR']);
        $m->add('ip_block', $ips);
    /* 其他情况下，添加ip到列表中， 并以cas方式去存储， 这样当其他客户端修改过， 则返回false */
    } else { 
        $ips[] = $_SERVER['REMOTE_ADDR'];
        $m->cas($cas, 'ip_block', $ips);
    }   
} while ($m->getResultCode() != Memcached::RES_SUCCESS);

?>

参见

Memcached::casByKey

Memcached::casByKey

在指定服务器上比较并交换值

说明

public bool Memcached::casByKey ( float $cas_token , string $server_key , string $key , mixed $value [, int $expiration ] )

除了可以使用server_key将key自由的映射到指定服务器外， Memcached::casByKey和 Memcached::cas在功能上是等同的。这通常用于你需要保持一批相关的key在一个中心服务器上的情况。(译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)

参数

cas_token
与已存在元素关联的唯一的值，由Memcache生成。

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

参见

Memcached::cas

Memcached::__construct

创建一个Memcached实例

说明

Memcached::__construct ([ string $persistent_id ] )

创建一个代表到Memcached服务端连接的Memcached实例。

参数

persistent_id
默认情况下，Memcached实例在请求结束后会被销毁。但可以在创建时通过persistent_id为每个实例指定唯一的ID，在请求间共享实例。所有通过相同的persistent_id值创建的实例共享同一个连接。

返回值

一个Memcached对象。

范例

示例 #1 创建一个Memcached对象

<?php
/* 创建一个普通的对象 */
$m1 = new Memcached();
echo get_class($m);

/* 创建持久化对象 */
$m2 = new Memcached('story_pool');
$m3 = new Memcached('story_pool');

/* 现在$m2和$m3共享相同的连接 */
?>

Memcached::decrement

减小数值元素的值

说明

public int Memcached::decrement ( string $key [, int $offset = 1 ] )

Memcached::decrement减小一个数值元素的值，减小多少由参数offset决定。如果元素的值不是数值，以0值对待。如果减小后的值小于0,则新的值被设置为0.如果元素不存在，Memcached::decrement 失败。

参数

key
将要减小值的元素的key。

offset
要将减小指定元素的值减小多少。

返回值

成功时返回元素新的值，或者在失败时返回 false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTFOUND。

范例

示例 #1 Memcached::decrement 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->set('counter', 5);
$m->decrement('counter');
var_dump($m->get('counter'));

$m->decrement('counter', 10);
var_dump($m->get('counter'));
?>

以上例程会输出：

int(4)
int(0)

参见

Memcached::increment

Memcached::decrementByKey

Decrement numeric item's value, stored on a specific server

说明

public intfalse Memcached::decrementByKey ( string $server_key , string $key [, int $offset = 1 [, int $initial_value = 0 [, int $expiry = 0 ]]] )

Memcached::decrementByKey decrements a numeric item's value by the specified offset. If the item's value is not numeric, an error will result. If the operation would decrease the value below 0, the new value will be 0. Memcached::decrementByKey will set the item to the initial_value parameter if the key doesn't exist.

参数

key
The key of the item to decrement.

offset
The amount by which to decrement the item's value.

initial_value
The value to set the item to if it doesn't currently exist.

expiry
The expiry time to set on the item.

返回值

Returns item's new value on success 或者在失败时返回 false.

参见

Memcached::decrement
Memcached::increment
Memcached::incrementByKey

Memcached::delete

删除一个元素

说明

public bool Memcached::delete ( string $key [, int $time = 0 ] )

Memcached::delete从服务端删除key对应的元素. 参数time是一个秒为单位的时间(或一个UNIX时间戳表明直到那个时间), 用来表明客户端希望服务端在这段时间拒绝对这个key的add和replace命令. 由于这个时间段的存在, 元素被放入一个删除队列, 表明它不可以通过get命令获取到值, 但是同时 add和replace命令也会失败(无论如何set命令都会成功). 在这段时间过去后, 元素最终被从服务端内存删除.time参数默认0(表明元素会被立即删除并且之后对这个 key的存储命令也会成功).

参数

key
要删除的key

time
服务端等待删除该元素的总时间(或一个Unix时间戳表明的实际删除时间).

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在, Memcached::getResultCode将会返回Memcached::RES_NOTFOUND.

范例

示例 #1 Memcached::delete 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->delete('key1');
?>

参见

Memcached::deleteByKey

Memcached::deleteByKey

从指定的服务器删除一个元素

说明

public bool Memcached::deleteByKey ( string $server_key , string $key [, int $time = 0 ] )

Memcached::deleteByKey除了可以通过server_key参数自由的指定key 所映射的服务器外，在功能上等同于 Memcached::delete。(译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)

参数

key
要删除的key。

time
服务端等待删除该元素的总时间(或一个Unix时间戳表明的实际删除时间).

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTFOUND。

参见

Memcached::delete

Memcached::deleteMulti

Delete multiple items

说明

public array Memcached::deleteMulti ( array $keys [, int $time = 0 ] )

Memcached::deleteMulti deletes the array of keys from the server. The time parameter is the amount of time in seconds (or Unix time until which) the client wishes the server to refuse add and replace commands for these keys. For this amount of time, the item is put into a delete queue, which means that it won't be possible to retrieve it by the get command, but add and replace command with these keys will also fail (the set command will succeed, however). After the time passes, the item is finally deleted from server memory. The parameter time defaults to 0 (which means that the item will be deleted immediately and further storage commands with these keys will succeed).

参数

keys
The keys to be deleted.

time
The amount of time the server will wait to delete the items.

返回值

Returns array indexed by keys and where values are indicating whether operation succeeded or not. The Memcached::getResultCode will return Memcached::RES_NOTFOUND if the key does not exist.

参见

Memcached::delete
Memcached::deleteByKey
Memcached::deleteMultiByKey

Memcached::deleteMultiByKey

Delete multiple items from a specific server

说明

public bool Memcached::deleteMultiByKey ( string $server_key , array $keys [, int $time = 0 ] )

Memcached::deleteMultiByKey is functionally equivalent to Memcached::deleteMulti, except that the free-form server_key can be used to map the keys to a specific server.

参数

keys
The keys to be deleted.

time
The amount of time the server will wait to delete the items.

返回值

成功时返回 true，或者在失败时返回 false。 The Memcached::getResultCode will return Memcached::RES_NOTFOUND if the key does not exist.

参见

Memcached::delete
Memcached::deleteByKey
Memcached::deleteMulti

Memcached::fetch

抓取下一个结果

说明

public array Memcached::fetch ( void )

Memcached::fetch从最后一次请求中抓取下一个结果。

参数

此函数没有参数。

返回值

返回下一个结果或其他情况下返回false。如果结果集已经抓取完毕， Memcached::getResultCode将返回Memcached::RES_END。

范例

示例 #1 Memcached::fetch 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->set('int', 99);
$m->set('string', 'a simple string');
$m->set('array', array(11, 12));

//延迟的获取int和array这两个key的值
$m->getDelayed(array('int', 'array'), true);
//循环抓取上面的延迟抓取得到的结果
while ($result = $m->fetch()) {
    var_dump($result);
}
?>

以上例程的输出类似于：

array(3) {
  ["key"]=>
  string(3) "int"
  "value"]=>
  int(99)
  ["cas"]=>
  float(2363)
}
array(3) {
  ["key"]=>
  string(5) "array"
  ["value"]=>
  array(2) {
    [0]=>
    int(11)
    [1]=>
    int(12)
  }
  ["cas"]=>
  float(2365)
}

参见

Memcached::fetchAll
Memcached::getDelayed

Memcached::fetchAll

抓取所有剩余的结果

说明

public array Memcached::fetchAll ( void )

Memcached::fetchAll抓取最后一次请求的结果集中剩余的所有结果。需要注意的是fetchAll和fetch的返回不同，因为fetchAll抓取的是结果集中剩余所有元素，所以比fetch的结果多一个维度。

参数

此函数没有参数。

返回值

返回结果集或者在失败时返回 false. 如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::getDelayed 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->set('int', 99);
$m->set('string', 'a simple string');
$m->set('array', array(11, 12));

//延迟抓取int和array两个key的值
$m->getDelayed(array('int', 'array'), true);
//抓取上面delay抓取的所有结果
var_dump($m->fetchAll());
?>

以上例程会输出：

array(2) {
  [0]=>
  array(3) {
    ["key"]=>
    string(3) "int"
    ["value"]=>
    int(99)
    ["cas"]=>
    float(2363)
  }
  [1]=>
  array(3) {
    ["key"]=>
    string(5) "array"
    ["value"]=>
    array(2) {
      [0]=>
      int(11)
      [1]=>
      int(12)
    }
    ["cas"]=>
    float(2365)
  }
}

参见

Memcached::fetch
Memcached::getDelayed

Memcached::flush

作废缓存中的所有元素

说明

public bool Memcached::flush ([ int $delay = 0 ] )

Memcached::flush立即（默认）或者在delay延迟后作废所有缓存中已经存在的元素。在作废之后检索命令将不会有任何返回（除非在执行Memcached::flush作废之后，该key下被重新存储过）。flush不会真正的释放已有元素的内存，而是逐渐的存入新元素重用那些内存。

参数

delay
在作废所有元素之前等待的时间（单位秒）。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::flush 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

/* 10秒内清除所有元素 */
$m->flush(10);
?>

Memcached::get

检索一个元素

说明

public mixed Memcached::get ( string $key [, callback $cache_cb [, float &$cas_token ]] )

Memcached::get返回之前存储在key下的元素。如果元素被找到，并且提供了cas_token参数，这个参数（译注：这个参数在函数定义中是引用参数，用来传出元素的版本标记，原理可以查阅乐观锁资料）将会包含该元素的CAS标记值。关于CAS标记值的使用，请查看 Memcached::cas的说明。另外，可以通过cache_cb参数设置Read-through caching callback。

参数

key
要检索的元素的key。

cache_cb
通读缓存回掉函数或null.

cas_token
检索的元素的CAS标记值。

返回值

返回存储在服务端的元素的值或者在其他情况下返回false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTFOUND。

范例

示例 #1 Memcached::get 示例 #1

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->set('foo', 100);
var_dump($m->get('foo'));
?>

以上例程会输出：

int(100)

示例 #2 Memcached::get 示例 #2

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

if (!($ip = $m->get('ip_block'))) {
    if ($m->getResultCode() == Memcached::RES_NOTFOUND) {
        $ip = array();
        $m->set('ip_block', $ip);
    } else {
        /* log error */
        /* ...       */
    }
}
?>

参见

Memcached::getByKey
Memcached::getMulti
Memcached::getDelayed

Memcached::getAllKeys

Gets the keys stored on all the servers

说明

public arrayfalse Memcached::getAllKeys ( void )

Memcached::getAllKeys queries each memcache server and retrieves an array of all keys stored on them at that point in time. This is not an atomic operation, so it isn't a truly consistent snapshot of the keys at point in time. As memcache doesn't guarantee to return all keys you also cannot assume that all keys have been returned.

参数

此函数没有参数。

返回值

Returns the keys stored on all the servers on success 或者在失败时返回 false.

Memcached::getByKey

从特定的服务器检索元素

说明

public mixed Memcached::getByKey ( string $server_key , string $key [, callback $cache_cb [, float &$cas_token ]] )

Memcached::getByKey除了可以通过server_key参数自由的指定key 所映射的服务器外，在功能上等同于 Memcached::get。(译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)

参数

key
要抓取的元素的key。

cache_cb
通读缓存回掉函数或null.

cas_token
检索的元素的CAS标记值。

返回值

返回存储在服务端的元素的值或者在其他情况下返回false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTFOUND。

参见

Memcached::get
Memcached::getMulti
Memcached::getDelayed

Memcached::getDelayed

请求多个元素

说明

public bool Memcached::getDelayed ( array $keys [, bool $with_cas [, callback $value_cb ]] )

Memcached::getDelayed向Memcached服务端发出一个检索keys指定的多个 key对应元素的请求。这个方法不会等待响应而是立即返回。当你需要收集元素值时，调用 Memcached::fetch或 Memcached::fetchAll。如果with_cas设置为true，会同时请求每个元素的CAS标记。

可以通过参数value_cb指定一个result callback来替代明确的抓取结果（fetch或fetchAll为明确抓取方式）。

参数

keys
要请求的key的数组。

with_cas
是否同时请求CAS标记。

value_cb
结果回掉函数或null。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::getDelayed 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->set('int', 99);
$m->set('string', 'a simple string');
$m->set('array', array(11, 12));

$m->getDelayed(array('int', 'array'), true);
var_dump($m->fetchAll());
?>

以上例程会输出：

array(2) {
  [0]=>
  array(3) {
    ["key"]=>
    string(3) "int"
    ["value"]=>
    int(99)
    ["cas"]=>
    float(2363)
  }
  [1]=>
  array(3) {
    ["key"]=>
    string(5) "array"
    ["value"]=>
    array(2) {
      [0]=>
      int(11)
      [1]=>
      int(12)
    }
    ["cas"]=>
    float(2365)
  }
}

参见

Memcached::getDelayedByKey
Memcached::fetch
Memcached::fetchAll

Memcached::getDelayedByKey

从指定的服务器上请求多个元素

说明

public bool Memcached::getDelayedByKey ( string $server_key , array $keys [, bool $with_cas [, callback $value_cb ]] )

Memcached::getDelayedByKey除了可以通过server_key参数自由的指定key 所映射的服务器外，在功能上等同于 Memcached::getDelayed。(译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)

参数

keys
要请求的key的数组。

with_cas
是否同时请求CAS标记。

value_cb
结果回掉函数或null。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

参见

Memcached::getDelayed
Memcached::fetch
Memcached::fetchAll

Memcached::getMulti

检索多个元素

说明

public mixed Memcached::getMulti ( array $keys [, int $flags ] )

Memcached::getMulti 与 Memcached::get 类似，但是这个方法用来检索 keys 数组指定的多个 key 对应的元素。

Note:

在 v3.0 之前，使用的第二个参数是 &cas_tokens。它会填充进元素的 CAS token 值。在本扩展里，&cas_tokens 参数在 v3.0 中已经移除。它被新的附加选项（flag） Memcached::GET_EXTENDED 代替，需要在 flags 值里使用。

flags参数可以用做指定Memcached::getMulti的附加选项。当前，仅可以指定为Memcached::GET_PRESERVE_ORDER以保证返回的key的顺序和请求时一致。 Memcached::GET_EXTENDED 可以确保同时返回了 CAS token 信息。

参数

keys
要检索的key的数组。

flags
Get 操作的附加选项。

返回值

返回检索到的元素的数组或者在失败时返回 false. 如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::getMulti 的 Memcached v3 示例

<?php
// 扩展版本 v3 有效

$m = new Memcached();
$m->addServer('localhost', 11211);

$items = array(
    'key1' => 'value1',
    'key2' => 'value2',
    'key3' => 'value3'
);
$m->setMulti($items);
$result = $m->getMulti(array('key1', 'key3', 'badkey'));
var_dump($result);
?>

以上例程的输出类似于：

array(2) {
  ["key1"]=>
  string(6) "value1"
  ["key3"]=>
  string(6) "value3"
}

示例 #2 Memcached::getMulti 的 Memcached v1 和 v2 示例

<?php
// 仅在扩展版本 v1 和 v2 中有效

$m = new Memcached();
$m->addServer('localhost', 11211);

$items = array(
    'key1' => 'value1',
    'key2' => 'value2',
    'key3' => 'value3'
);
$m->setMulti($items);
$result = $m->getMulti(array('key1', 'key3', 'badkey'), $cas);
var_dump($result, $cas);
?>

以上例程的输出类似于：

array(2) {
  ["key1"]=>
  string(6) "value1"
  ["key3"]=>
  string(6) "value3"
}
array(2) {
  ["key1"]=>
  float(2360)
  ["key3"]=>
  float(2362)
}

示例 #3 Memcached::GET_PRESERVE_ORDER 的 Memcached v3 示例

<?php
//  v3 扩展有效

$m = new Memcached();
$m->addServer('localhost', 11211);

$data = array(
    'foo' => 'foo-data',
    'bar' => 'bar-data',
    'baz' => 'baz-data',
    'lol' => 'lol-data',
    'kek' => 'kek-data',
);

$m->setMulti($data, 3600);

$keys = array_keys($data);
$keys[] = 'zoo';
$got = $m->getMulti($keys, Memcached::GET_PRESERVE_ORDER);

foreach ($got as $k => $v) {
    echo "$k $v\n";
}
?>

以上例程的输出类似于：

foo foo-data
bar bar-data
baz baz-data
lol lol-data
kek kek-data
zoo

示例 #4 Memcached::GET_PRESERVE_ORDER 的 Memcached v1 和 v2 示例

<?php
// 在扩展版本 v1 和 v2  中有效

$m = new Memcached();
$m->addServer('localhost', 11211);

$data = array(
    'foo' => 'foo-data',
    'bar' => 'bar-data',
    'baz' => 'baz-data',
    'lol' => 'lol-data',
    'kek' => 'kek-data',
);

$m->setMulti($data, 3600);

$null = null;
$keys = array_keys($data);
$keys[] = 'zoo';
$got = $m->getMulti($keys, $null, Memcached::GET_PRESERVE_ORDER);

foreach ($got as $k => $v) {
    echo "$k $v\n";
}
?>

以上例程的输出类似于：

foo foo-data
bar bar-data
baz baz-data
lol lol-data
kek kek-data
zoo

更新日志

版本	说明
3.0.0	移出参数 `&cas_tokens`。添加 `Memcached::GET_EXTENDED`，当需要获取 CAS token 信息时，传入 flag 中。

参见

Memcached::getMultiByKey
Memcached::get
Memcached::getDelayed

Memcached::getMultiByKey

从特定服务器检索多个元素

说明

public array Memcached::getMultiByKey ( string $server_key , array $keys [, string &$cas_tokens [, int $flags ]] )

Memcached::getMultiByKey除了可以通过server_key参数自由的指定key 所映射的服务器外，在功能上等同于 Memcached::getMulti。(译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)

参数

keys
要检索的key的数组。

cas_tokens
用来存储检索到的元素的CAS标记。

flags
get操作的附加选项。

返回值

返回检索到的元素的数组或者在失败时返回 false. 如需要则使用 Memcached::getResultCode。

参见

Memcached::getMulti
Memcached::get
Memcached::getDelayed

Memcached::getOption

获取Memcached的选项值

说明

public mixed Memcached::getOption ( int $option )

这个方法返回option指定的Memcached选项的值。一些选项是和libmemcached中相对应的，也有一些特殊的选项仅仅是扩展自身的。关于选项的更多信息请查看Memcached Constants。

参数

option
Memcached::OPT_*系列常量中的一个。

返回值

返回请求的选项的值，或者在发生错误时返回FALSE。

范例

示例 #1 获取Memcached选项

<?php
$m = new Memcached();
var_dump($m->getOption(Memcached::OPT_COMPRESSION));
var_dump($m->getOption(Memcached::OPT_POLL_TIMEOUT));
?>

以上例程的输出类似于：

bool(true)
int(1000)

参见

Memcached::setOption
Memcached Constants

Memcached::getResultCode

返回最后一次操作的结果代码

说明

public int Memcached::getResultCode ( void )

Memcached::getResultCode返回*`Memcached::RES_`**系列常量中的一个来表明最后一次执行Memcached方法的结果。

参数

此函数没有参数。

返回值

最后一次Memcached操作的结果代码。

范例

示例 #1 Memcached::getResultCode 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->add('foo', 'bar');
if ($m->getResultCode() == Memcached::RES_NOTSTORED) {
    /* ... */
}
?>

Memcached::getResultMessage

返回最后一次操作的结果描述消息

说明

public string Memcached::getResultMessage ( void )

Memcached::getResultMessage返回一个字符串来描述最后一次Memcached方法执行的结果。

参数

此函数没有参数。

返回值

最后一次Memcached操作结果的描述消息。

范例

示例 #1 Memcached::getResultMessage 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->add('foo', 'bar'); // first time should succeed
$m->add('foo', 'bar');
echo $m->getResultMessage(),"\n";
?>

以上例程会输出：

NOT STORED

Memcached::getServerByKey

获取一个key所映射的服务器信息

说明

public array Memcached::getServerByKey ( string $server_key )

Memcached::getServerByKey返回server_key所映射的服务器, Memcached::*ByKey系列方法的中的server_key参数, 实际上就是用来获取操作的服务器的.(译注: 可以这样理解, *ByKey系列函数首先调用Memcached::getServerByKey获取服务器, 然后在此服务器上进行操作.)

参数

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::getServerByKey 示例

<?php
$m = new Memcached();
$m->addServers(array(
    array('mem1.domain.com', 11211, 40),
    array('mem2.domain.com', 11211, 40),
    array('mem3.domain.com', 11211, 20),
));

$m->setOption(Memcached::OPT_LIBKETAMA_COMPATIBLE, true);

var_dump($m->getServerByKey('user'));
var_dump($m->getServerByKey('log'));
var_dump($m->getServerByKey('ip'));
?>

以上例程的输出类似于：

array(3) {
  ["host"]=>
  string(15) "mem3.domain.com"
  ["port"]=>
  int(11211)
  ["weight"]=>
  int(20)
}
array(3) {
  ["host"]=>
  string(15) "mem2.domain.com"
  ["port"]=>
  int(11211)
  ["weight"]=>
  int(40)
}
array(3) {
  ["host"]=>
  string(15) "mem2.domain.com"
  ["port"]=>
  int(11211)
  ["weight"]=>
  int(40)
}

Memcached::getServerList

获取服务器池中的服务器列表

说明

public array Memcached::getServerList ( void )

Memcached::getServerList返回服务器池中所有服务器列表.

参数

此函数没有参数。

返回值

服务器池中所有服务器列表.

范例

示例 #1 Memcached::getServerList 示例

<?php
$m = new Memcached();
$m->addServers(array(
    array('mem1.domain.com', 11211, 20),
    array('mem2.domain.com', 11311, 80),
));
var_dump($m->getServerList());
?>

以上例程会输出：

array(2) {
  [0]=>
  array(3) {
    ["host"]=>
    string(15) "mem1.domain.com"
    ["port"]=>
    int(11211)
    ["weight"]=>
    int(20)
  }
  [1]=>
  array(3) {
    ["host"]=>
    string(15) "mem2.domain.com"
    ["port"]=>
    int(11311)
    ["weight"]=>
    int(80)
  }
}

Memcached::getStats

获取服务器池的统计信息

说明

public array Memcached::getStats ( void )

Memcached::getStats返回一个包含所有可用memcache服务器状态的数组. 返回的统计信息的详细描述参见» memcache protocol。（译注：经实验，服务器池中有不可用服务器时，返回false）

参数

此函数没有参数。

返回值

服务器统计信息数组，每个服务器一项。

范例

示例 #1 Memcached::getStats 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

print_r($m->getStats());
?>

以上例程的输出类似于：

Array
(
    [localhost:11211] => Array
        (
            [pid] => 4933
            [uptime] => 786123
            [threads] => 1
            [time] => 1233868010
            [pointer_size] => 32
            [rusage_user_seconds] => 0
            [rusage_user_microseconds] => 140000
            [rusage_system_seconds] => 23
            [rusage_system_microseconds] => 210000
            [curr_items] => 145
            [total_items] => 2374
            [limit_maxbytes] => 67108864
            [curr_connections] => 2
            [total_connections] => 151
            [connection_structures] => 3
            [bytes] => 20345
            [cmd_get] => 213343
            [cmd_set] => 2381
            [get_hits] => 204223
            [get_misses] => 9120
            [evictions] => 0
            [bytes_read] => 9092476
            [bytes_written] => 15420512
            [version] => 1.2.6
        )

)

Memcached::getVersion

获取服务器池中所有服务器的版本信息

说明

public array Memcached::getVersion ( void )

Memcached::getVersion返回一个包含所有可用memcached服务器版本信息的数组。（译注：经实验，服务器池中有不可用服务器时，返回false）

参数

此函数没有参数。

返回值

服务器版本信息的数组，每个服务器占一项。

范例

示例 #1 Memcached::getVersion 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

print_r($m->getVersion());
?>

以上例程的输出类似于：

Array
(
    [localhost:11211] => 1.2.6
)

Memcached::increment

增加数值元素的值

说明

public int Memcached::increment ( string $key [, int $offset = 1 ] )

Memcached::increment 将一个数值元素增加参数 offset 指定的大小。如果元素的值不是数值类型，将返回错误。如果元素不存在， Memcached::increment 会将元素设置成 initial_value 指定的值。

参数

key
要增加值的元素的 key。

offset
要将元素的值增加的大小。

initial_value
如果元素不存在，要设置的默认值。

expiry
设置元素值的过期时间。

返回值

成功时返回元素的新值或者在失败时返回 false。

范例

示例 #1 Memcached::increment 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->set('counter', 0);
$m->increment('counter');
$n = $m->increment('counter', 10);
var_dump($n);

$m->set('counter', 'abc');
$n = $m->increment('counter');
// ^ will fail due to item value not being numeric
var_dump($n);
?>

以上例程会输出：

int(11)
bool(false)

参见

Memcached::decrement
Memcached::decrementByKey
Memcached::incrementByKey

Memcached::incrementByKey

Increment numeric item's value, stored on a specific server

说明

public intfalse Memcached::incrementByKey ( string $server_key , string $key [, int $offset = 1 [, int $initial_value = 0 [, int $expiry = 0 ]]] )

Memcached::incrementByKey increments a numeric item's value by the specified offset. If the item's value is not numeric, an error will result. Memcached::incrementByKey will set the item to the initial_value parameter if the key doesn't exist.

参数

key
The key of the item to increment.

offset
The amount by which to increment the item's value.

initial_value
The value to set the item to if it doesn't currently exist.

expiry
The expiry time to set on the item.

返回值

Returns new item's value on success 或者在失败时返回 false.

参见

Memcached::decrement
Memcached::decrementByKey
Memcached::increment

Memcached::isPersistent

Check if a persitent connection to memcache is being used

说明

public bool Memcached::isPersistent ( void )

Memcached::isPersistent checks if the connections to the memcache servers are persistent connections.

参数

此函数没有参数。

返回值

Returns true if Memcache instance uses a persistent connection, false otherwise.

参见

Memcached::isPristine

Memcached::isPristine

Check if the instance was recently created

说明

public bool Memcached::isPristine ( void )

Memcached::isPristine checks if the Memcache instance was recently created.

参数

此函数没有参数。

返回值

Returns the true if instance is recently created, false otherwise.

参见

Memcached::isPersistent

Memcached::prepend

向一个已存在的元素前面追加数据

说明

public bool Memcached::prepend ( string $key , string $value )

Memcached::prepend向已存在元素的字符串值前追加value。 value被强制转换成字符串类型主要是因为对于mix类型的追加没有很好的定义。

Note:

如果Memcached::OPT_COMPRESSION常量开启，这个操作会失败，并引发一个警告，因为向压缩数据后追加数据可能会导致解压不了。

参数

key
要向前追加数据的元素的key。

value
要追加的字符串。

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTSTORED。

范例

示例 #1 Memcached::prepend 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);
$m->setOption(Memcached::OPT_COMPRESSION, false);

$m->set('foo', 'abc');
$m->prepend('foo', 'def');
var_dump($m->get('foo'));
?>

以上例程会输出：

string(6) "defabc"

参见

Memcached::prependByKey
Memcached::append

Memcached::prependByKey

Prepend data to an existing item on a specific server

说明

public bool Memcached::prependByKey ( string $server_key , string $key , string $value )

除了可以使用server_key自由的将key映射到指定服务器外， Memcached::prependByKey在功能上等同于 Memcached::prepend。 (译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)

参数

key
要向前追加数据的元素的key。

value
要追加的字符串。

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTSTORED。

参见

Memcached::prepend
Memcached::append

Memcached::quit

关闭所有打开的链接。

说明

public bool Memcached::quit ( void )

Memcached::quit 关闭所有memcache服务器的链接。

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

Memcached::replace

替换已存在key下的元素

说明

public bool Memcached::replace ( string $key , mixed $value [, int $expiration ] )

Memcached::replace和 Memcached::set类似，但是如果服务端不存在key，操作将失败。

参数

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTSTORED。

参见

Memcached::replaceByKey
Memcached::set
Memcached::add

Memcached::replaceByKey

Replace the item under an existing key on a specific server

说明

public bool Memcached::replaceByKey ( string $server_key , string $key , mixed $value [, int $expiration ] )

除了可以使用server_key自由的将key映射到指定服务器外， Memcached::replaceByKey在功能上等同于 Memcached::replace。 (译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)。

参数

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如果key不存在， Memcached::getResultCode返回Memcached::RES_NOTSTORED。

参见

Memcached::replace
Memcached::set
Memcached::add

Memcached::resetServerList

Clears all servers from the server list

说明

public bool Memcached::resetServerList ( void )

Memcached::resetserverlist removes all memcache servers from the known server list, resetting it back to empty.

参数

此函数没有参数。

返回值

成功时返回 true，或者在失败时返回 false。

参见

Memcached::addServer
Memcached::addServers

Memcached::set

存储一个元素

说明

public bool Memcached::set ( string $key , mixed $value [, int $expiration ] )

Memcached::set将value 存储在一个memcached服务器上的key下。expiration参数用于控制值的过期时间。

值可以是任何有效的非资源型php类型，因为资源类型不能被序列化存储。如果Memcached::OPT_COMPRESSION 选项开启，序列化的值同样会被压缩存储。

参数

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::set 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$m->set('int', 99);
$m->set('string', 'a simple string');
$m->set('array', array(11, 12));
/* 'object'这个key将在5分钟后过期 */
$m->set('object', new stdclass, time() + 300);


var_dump($m->get('int'));
var_dump($m->get('string'));
var_dump($m->get('array'));
var_dump($m->get('object'));
?>

以上例程的输出类似于：

int(99)
string(15) "a simple string"
array(2) {
  [0]=>
  int(11)
  [1]=>
  int(12)
}
object(stdClass)#1 (0) {
}

参见

Memcached::setByKey
Memcached::add
Memcached::replace

Memcached::setByKey

将元素存储到指定的服务器上

说明

public bool Memcached::setByKey ( string $server_key , string $key , mixed $value [, int $expiration ] )

除了可以使用server_key自由的将key映射到指定服务器外， Memcached::setByKey在功能上等同于 Memcached::set。 (译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)。

参数

key
用于存储值的键名。

value
存储的值。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::setByKey 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

/* 保证block-ip系列key的存储在同一台服务器上。*/
$m->setByKey('api-cache', 'block-ip:169.254.253.252', 1);
$m->setByKey('api-cache', 'block-ip:169.127.127.202', 1);
?>

参见

Memcached::set

Memcached::setMulti

存储多个元素

说明

public bool Memcached::setMulti ( array $items [, int $expiration ] )

Memcached::setMulti类似于 Memcached::set，但是使用了参数items指定多个元素来替代单独的key/value设置以便于对多个元素的操作。expiration 参数指定的时候一次应用到所有的元素上。

参数

items
存放在服务器上的键／值对数组。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

范例

示例 #1 Memcached::setMulti 示例

<?php
$m = new Memcached();
$m->addServer('localhost', 11211);

$items = array(
    'key1' => 'value1',
    'key2' => 'value2',
    'key3' => 'value3'
);
$m->setMulti($items, time() + 300);
?>

参见

Memcached::setMultiByKey
Memcached::set

Memcached::setMultiByKey

Store multiple items on a specific server

说明

public bool Memcached::setMultiByKey ( string $server_key , array $items [, int $expiration ] )

除了可以使用server_key自由的将key映射到指定服务器外， Memcached::setMultiByKey在功能上等同于 Memcached::setMulti。 (译注: 关于*ByKey系列方法及$server_key的工作原理请参照addByKey方法文档)。

参数

items
存放在服务器上的键／值对数组。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

参见

Memcached::setMulti
Memcached::set

Memcached::setOption

设置一个memcached选项

说明

public bool Memcached::setOption ( int $option , mixed $value )

这个方法用来设置Memcached option的值。一些选项和libmemcached中定义的类似，还有一些则是扩展所特有的。关于选项的更多信息请参阅Memcached Constants。

下面的选项列表需要通过特定的常量指定值。

Memcached::OPT_HASH需要Memcached::HASH_*系列常量值。
Memcached::OPT_DISTRIBUTION需要Memcached::DISTRIBUTION_*系列常量值。

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 设置一个memcached选项值

<?php
$m = new Memcached();
var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT);
$m->setOption(Memcached::OPT_HASH, Memcached::HASH_MURMUR);
$m->setOption(Memcached::OPT_PREFIX_KEY, "widgets");
echo "Prefix key is now: ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n";
?>

以上例程会输出：

bool(true)
Prefix key is now: widgets

参见

Memcached::getOption

Memcached::setOptions

Set Memcached options

说明

public bool Memcached::setOptions ( array $options )

Memcached::setOptions is a variation of the Memcached::setOption that takes an array of options to be set.

参数

options
An associative array of options where the key is the option to set and the value is the new value for the option.

返回值

成功时返回 true，或者在失败时返回 false。

范例

示例 #1 Setting Memcached options

<?php
$m = new Memcached();
var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT);

$m->setOptions(array(Memcached::OPT_HASH => Memcached::HASH_MURMUR, Memcached::OPT_PREFIX_KEY => "widgets"));

var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT);
echo "Prefix key is now: ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n";
?>

以上例程会输出：

bool(true)
bool(false)
Prefix key is now: widgets

参见

Memcached::getOption
Memcached::setOption
Memcached Constants

Memcached::setSaslAuthData

Set the credentials to use for authentication

说明

public void Memcached::setSaslAuthData ( string $username , string $password )

Memcached::setSaslAuthData sets the username and password that should be used for SASL authentication with the memcache servers.

This method is only available when the memcached extension is built with SASL support. Please refer to Memcached setup for how to do this.

参数

username
The username to use for authentication.

password
The password to use for authentication.

返回值

没有返回值。

Memcached::touch

Set a new expiration on an item

说明

public bool Memcached::touch ( string $key , int $expiration )

Memcached::touch sets a new expiration value on the given key.

参数

key
用于存储值的键名。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

参见

Memcached::touchByKey

Memcached::touchByKey

Set a new expiration on an item on a specific server

说明

public bool Memcached::touchByKey ( string $server_key , string $key , int $expiration )

Memcached::touchByKey is functionally equivalent to Memcached::touch, except that the free-form server_key can be used to map the key to a specific server.

参数

key
用于存储值的键名。

expiration
到期时间，默认为 0。更多信息请参见到期时间。

返回值

成功时返回 true，或者在失败时返回 false。如需要则使用 Memcached::getResultCode。

参见

Memcached::touch