Memcached::delete

(PECL memcached >= 0.1.0)

Memcached::delete — アイテムを削除する

説明

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

Memcached::delete() は、キー key をサーバから削除します。 time パラメータは、このキーによる add コマンドや replace コマンドをサーバに拒否させたい秒数 (あるいはいつまで拒否するかを表す Unix タイム) を指定します。この時間までの間、アイテムは削除キューに入れられます。つまり、 get コマンドによる取得はできず、 add コマンドや replace コマンドでこのキーを指定した場合も失敗するということです (set コマンドは成功します)。時間が経過したら、アイテムはサーバのメモリ上から削除されます。パラメータ time のデフォルトは 0 (アイテムは即時に削除され、それ以降の格納コマンドが成功するようになる) です。

パラメータ

key: 削除したいキー。
time: サーバがアイテムを削除するまでの待ち時間。デフォルトは 0。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。キーが存在しない場合、 Memcached::getResultCode は Memcached::RES_NOTFOUND を返します。

例

例1 Memcached::delete() の例


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

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

参考

Memcached::deleteByKey - 指定したサーバからアイテムを削除する