PHP 8.1.31 Released!

    The Memcached class

    (PECL memcached >= 0.1.0)

    Introduction

    Represents a connection to a set of memcached servers.

    Class synopsis

    class Memcached {
    /* Methods */
    public __construct(?string $persistent_id = null, ?callable $callback = null, ?string $connection_str = null)
    public add(string $key, mixed $value, int $expiration = 0): bool
    public addByKey(
        string $server_key,
        string $key,
        mixed $value,
        int $expiration = 0
    ): bool
    public addServer(string $host, int $port, int $weight = 0): bool
    public addServers(array $servers): bool
    public append(string $key, string $value): ?bool
    public appendByKey(string $server_key, string $key, string $value): ?bool
    public cas(
        string|int|float $cas_token,
        string $key,
        mixed $value,
        int $expiration = 0
    ): bool
    public casByKey(
        string|int|float $cas_token,
        string $server_key,
        string $key,
        mixed $value,
        int $expiration = 0
    ): bool
    public decrement(
        string $key,
        int $offset = 1,
        int $initial_value = 0,
        int $expiry = 0
    ): int|false
    public decrementByKey(
        string $server_key,
        string $key,
        int $offset = 1,
        int $initial_value = 0,
        int $expiry = 0
    ): int|false
    public delete(string $key, int $time = 0): bool
    public deleteByKey(string $server_key, string $key, int $time = 0): bool
    public deleteMulti(array $keys, int $time = 0): array
    public deleteMultiByKey(string $server_key, array $keys, int $time = 0): array
    public fetch(): array|false
    public fetchAll(): array|false
    public flush(int $delay = 0): bool
    public get(string $key, ?callable $cache_cb = null, int $get_flags = 0): mixed
    public getAllKeys(): array|false
    public getByKey(
        string $server_key,
        string $key,
        ?callable $cache_cb = null,
        int $get_flags = 0
    ): mixed
    public getDelayed(array $keys, bool $with_cas = false, ?callable $value_cb = null): bool
    public getDelayedByKey(
        string $server_key,
        array $keys,
        bool $with_cas = false,
        ?callable $value_cb = null
    ): bool
    public getMulti(array $keys, int $get_flags = 0): array|false
    public getMultiByKey(string $server_key, array $keys, int $get_flags = 0): array|false
    public getOption(int $option): mixed
    public getResultCode(): int
    public getResultMessage(): string
    public getServerByKey(string $server_key): array|false
    public getServerList(): array
    public getStats(?string $type = null): array|false
    public getVersion(): array|false
    public increment(
        string $key,
        int $offset = 1,
        int $initial_value = 0,
        int $expiry = 0
    ): int|false
    public incrementByKey(
        string $server_key,
        string $key,
        int $offset = 1,
        int $initial_value = 0,
        int $expiry = 0
    ): int|false
    public isPersistent(): bool
    public isPristine(): bool
    public prepend(string $key, string $value): ?bool
    public prependByKey(string $server_key, string $key, string $value): ?bool
    public quit(): bool
    public replace(string $key, mixed $value, int $expiration = 0): bool
    public replaceByKey(
        string $server_key,
        string $key,
        mixed $value,
        int $expiration = 0
    ): bool
    public resetServerList(): bool
    public set(string $key, mixed $value, int $expiration = 0): bool
    public setByKey(
        string $server_key,
        string $key,
        mixed $value,
        int $expiration = 0
    ): bool
    public setEncodingKey(string $key): bool
    public setMulti(array $items, int $expiration = 0): bool
    public setMultiByKey(string $server_key, array $items, int $expiration = 0): bool
    public setOption(int $option, mixed $value): bool
    public setOptions(array $options): bool
    public setSaslAuthData(string $username, string $password): bool
    public touch(string $key, int $expiration = 0): bool
    public touchByKey(string $server_key, string $key, int $expiration = 0): bool
    }

    Table of Contents

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top