PHP マニュアル: 指定したサーバー上にある数値アイテムの値を減らす

説明

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

Memcached::decrementByKey は、数値アイテムの値を offset で指定しただけ減らします。アイテムの値が数値でない場合はエラーとなります。操作後の値が 0 より小さくなる場合は、新しい値は 0 となります。アイテムが存在しない場合、Memcached::decrementByKey は値を initial_value に設定します。

パラメータ

server_key: 値を格納したりデータを取得したりするサーバーを表すキー。アイテムの実際のキーをハッシュするかわりにサーバーのキーをハッシュして、どの memcached サーバーとやりとりするのか選びます。これで、関連するアイテムを一つのサーバーにまとめられるようになり、マルチ操作の効率が上がります。
key: 減らしたいアイテムのキー。
offset: 値を減らしたい量。
initial_value: そのアイテムが存在しない場合に設定する値。
expiry: そのアイテムに設定する有効期限。

戻り値

成功した場合にアイテムの新しい値、失敗した場合に false を返します。

参考

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