The Memcached class

(PECL memcached >= 0.1.0)

Introduction

Represents a connection to a set of memcached servers.

Class synopsis

class Memcached {

/* Methods */

public function __construct(?string $persistent_id = null, ?callable $callback = null, ?string $connection_str = null)

public function add(string $key, mixed $value, int $expiration = 0): bool

public function addByKey(
    string $server_key,
    string $key,
    mixed $value,
    int $expiration = 0
): bool

public function addServer(string $host, int $port, int $weight = 0): bool

public function addServers(array $servers): bool

public function append(string $key, string $value): ?bool

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

public function cas(
    string|int|float $cas_token,
    string $key,
    mixed $value,
    int $expiration = 0
): bool

public function casByKey(
    string|int|float $cas_token,
    string $server_key,
    string $key,
    mixed $value,
    int $expiration = 0
): bool

public function decrement(
    string $key,
    int $offset = 1,
    int $initial_value = 0,
    int $expiry = 0
): int|false

public function decrementByKey(
    string $server_key,
    string $key,
    int $offset = 1,
    int $initial_value = 0,
    int $expiry = 0
): int|false

public function delete(string $key, int $time = 0): bool

public function deleteByKey(string $server_key, string $key, int $time = 0): bool

public function deleteMulti(array $keys, int $time = 0): array

public function deleteMultiByKey(string $server_key, array $keys, int $time = 0): array

public function fetch(): array|false

public function fetchAll(): array|false

public function flush(int $delay = 0): bool

public function get(string $key, ?callable $cache_cb = null, int $get_flags = 0): mixed

public function getAllKeys(): array|false

public function getByKey(
    string $server_key,
    string $key,
    ?callable $cache_cb = null,
    int $get_flags = 0
): mixed

public function getDelayed(array $keys, bool $with_cas = false, ?callable $value_cb = null): bool

public function getDelayedByKey(
    string $server_key,
    array $keys,
    bool $with_cas = false,
    ?callable $value_cb = null
): bool

public function getMulti(array $keys, int $get_flags = 0): array|false

public function getMultiByKey(string $server_key, array $keys, int $get_flags = 0): array|false

public function getOption(int $option): mixed

public function getResultCode(): int

public function getResultMessage(): string

public function getServerByKey(string $server_key): array|false

public function getServerList(): array

public function getStats(?string $type = null): array|false

public function getVersion(): array|false

public function increment(
    string $key,
    int $offset = 1,
    int $initial_value = 0,
    int $expiry = 0
): int|false

public function incrementByKey(
    string $server_key,
    string $key,
    int $offset = 1,
    int $initial_value = 0,
    int $expiry = 0
): int|false

public function isPersistent(): bool

public function isPristine(): bool

public function prepend(string $key, string $value): ?bool

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

public function quit(): bool

public function replace(string $key, mixed $value, int $expiration = 0): bool

public function replaceByKey(
    string $server_key,
    string $key,
    mixed $value,
    int $expiration = 0
): bool

public function resetServerList(): bool

public function set(string $key, mixed $value, int $expiration = 0): bool

public function setByKey(
    string $server_key,
    string $key,
    mixed $value,
    int $expiration = 0
): bool

public function setEncodingKey(string $key): bool

public function setMulti(array $items, int $expiration = 0): bool

public function setMultiByKey(string $server_key, array $items, int $expiration = 0): bool

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

public function setOptions(array $options): bool

public function setSaslAuthData(string $username, string $password): bool

public function touch(string $key, int $expiration = 0): bool

public function touchByKey(string $server_key, string $key, int $expiration = 0): bool

}

Memcached::add — Add an item under a new key
Memcached::addByKey — Add an item under a new key on a specific server
Memcached::addServer — Add a server to the server pool
Memcached::addServers — Add multiple servers to the server pool
Memcached::append — Append data to an existing item
Memcached::appendByKey — Append data to an existing item on a specific server
Memcached::cas — Compare and swap an item
Memcached::casByKey — Compare and swap an item on a specific server
Memcached::__construct — Create a Memcached instance
Memcached::decrement — Decrement numeric item's value
Memcached::decrementByKey — Decrement numeric item's value, stored on a specific server
Memcached::delete — Delete an item
Memcached::deleteByKey — Delete an item from a specific server
Memcached::deleteMulti — Delete multiple items
Memcached::deleteMultiByKey — Delete multiple items from a specific server
Memcached::fetch — Fetch the next result
Memcached::fetchAll — Fetch all the remaining results
Memcached::flush — Invalidate all items in the cache
Memcached::get — Retrieve an item
Memcached::getAllKeys — Gets the keys stored on all the servers
Memcached::getByKey — Retrieve an item from a specific server
Memcached::getDelayed — Request multiple items
Memcached::getDelayedByKey — Request multiple items from a specific server
Memcached::getMulti — Retrieve multiple items
Memcached::getMultiByKey — Retrieve multiple items from a specific server
Memcached::getOption — Retrieve a Memcached option value
Memcached::getResultCode — Return the result code of the last operation
Memcached::getResultMessage — Return the message describing the result of the last operation
Memcached::getServerByKey — Map a key to a server
Memcached::getServerList — Get the list of the servers in the pool
Memcached::getStats — Get server pool statistics
Memcached::getVersion — Get server pool version info
Memcached::increment — Increment numeric item's value
Memcached::incrementByKey — Increment numeric item's value, stored on a specific server
Memcached::isPersistent — Check if a persistent connection to memcache is being used
Memcached::isPristine — Check if the instance was recently created
Memcached::prepend — Prepend data to an existing item
Memcached::prependByKey — Prepend data to an existing item on a specific server
Memcached::quit — Close any open connections
Memcached::replace — Replace the item under an existing 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 — Store an item
Memcached::setByKey — Store an item on a specific server
Memcached::setEncodingKey — Set AES encryption key for data in Memcached
Memcached::setMulti — Store multiple items
Memcached::setMultiByKey — Store multiple items on a specific server
Memcached::setOption — Set a Memcached option
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

The Memcached class

Introduction

Class synopsis

Table of Contents