memcached-api.php

<?php

/**
 * Memcached class.
 */

class Memcached {
	/**
	 * Libmemcached behavior options.
	 */

	const OPT_HASH;

	const HASH_DEFAULT;

	const HASH_MD5;

	const HASH_CRC;

	const HASH_FNV1_64;

	const HASH_FNV1A_64;

	const HASH_FNV1_32;

	const HASH_FNV1A_32;

	const HASH_HSIEH;

	const HASH_MURMUR;

	const OPT_DISTRIBUTION;

	const DISTRIBUTION_MODULA;

	const DISTRIBUTION_CONSISTENT;

	const DISTRIBUTION_VIRTUAL_BUCKET;

	const OPT_LIBKETAMA_COMPATIBLE;

	const OPT_LIBKETAMA_HASH;

	const OPT_TCP_KEEPALIVE;

	const OPT_BUFFER_WRITES;

	const OPT_BINARY_PROTOCOL;

	const OPT_NO_BLOCK;

	const OPT_TCP_NODELAY;

	const OPT_SOCKET_SEND_SIZE;

	const OPT_SOCKET_RECV_SIZE;

	const OPT_CONNECT_TIMEOUT;

	const OPT_RETRY_TIMEOUT;

	const OPT_DEAD_TIMEOUT;

	const OPT_SEND_TIMEOUT;

	const OPT_RECV_TIMEOUT;

	const OPT_POLL_TIMEOUT;

	const OPT_SERVER_FAILURE_LIMIT;

	const OPT_SERVER_TIMEOUT_LIMIT;

	const OPT_CACHE_LOOKUPS;

	const OPT_AUTO_EJECT_HOSTS;

	const OPT_NOREPLY;

	const OPT_VERIFY_KEY;

	const OPT_USE_UDP;

	const OPT_NUMBER_OF_REPLICAS;

	const OPT_RANDOMIZE_REPLICA_READS;

	const OPT_REMOVE_FAILED_SERVERS;
	
	const OPT_CLIENT_MODE;

	const OPT_DYNAMIC_POLLING_INTERVAL_SECS;

	const OPT_USE_TLS;

    /**
         * Client mode parameters
         */
	const STATIC_CLIENT_MODE;

	const DYNAMIC_CLIENT_MODE;

	/**
	 * Supported serializers
	 */
	const HAVE_JSON;

	const HAVE_IGBINARY;

	const HAVE_MSGPACK;

	const HAVE_ENCODING;

	/**
	 * Feature support
	 */
	const HAVE_SESSION;

	const HAVE_SASL;

	const HAVE_TLS;

	/**
	 * Class options.
	 */
	const OPT_COMPRESSION;

	const OPT_COMPRESSION_TYPE;

	const OPT_PREFIX_KEY;

	/**
	 * Serializer constants
	 */
	const SERIALIZER_PHP;

	const SERIALIZER_IGBINARY;

	const SERIALIZER_JSON;

	const SERIALIZER_JSON_ARRAY;

	const SERIALIZER_MSGPACK;

	/**
	 * Compression types
	 */
	const COMPRESSION_FASTLZ;

	const COMPRESSION_ZLIB;

	/**
	 * Flags for get and getMulti operations.
	 */
	// Whether to preserve key order in the result
	const GET_PRESERVE_ORDER;

	// Whether to fetch CAS token as well (use "gets").
	const GET_EXTENDED;

	/**
	 * Return values
	 */
	const GET_ERROR_RETURN_VALUE;

	const RES_PAYLOAD_FAILURE;

	const RES_SUCCESS;

	const RES_FAILURE;

	const RES_HOST_LOOKUP_FAILURE;

	const RES_UNKNOWN_READ_FAILURE;

	const RES_PROTOCOL_ERROR;

	const RES_CLIENT_ERROR;

	const RES_SERVER_ERROR;

	const RES_WRITE_FAILURE;

	const RES_DATA_EXISTS;

	const RES_NOTSTORED;

	const RES_NOTFOUND;

	const RES_PARTIAL_READ;

	const RES_SOME_ERRORS;

	const RES_NO_SERVERS;

	const RES_END;

	const RES_ERRNO;

	const RES_BUFFERED;

	const RES_TIMEOUT;

	const RES_BAD_KEY_PROVIDED;

	const RES_STORED;

	const RES_DELETED;

	const RES_STAT;

	const RES_ITEM;

	const RES_NOT_SUPPORTED;

	const RES_FETCH_NOTFINISHED;

	const RES_SERVER_MARKED_DEAD;

	const RES_UNKNOWN_STAT_KEY;

	const RES_INVALID_HOST_PROTOCOL;

	const RES_MEMORY_ALLOCATION_FAILURE;

	const RES_CONNECTION_SOCKET_CREATE_FAILURE;

	const RES_MEMCACHED_NO_CONFIG_SERVER;
	
	const RES_E2BIG;

	const RES_KEY_TOO_BIG;

	const RES_SERVER_TEMPORARILY_DISABLED;

	const RES_SERVER_MEMORY_ALLOCATION_FAILURE;

	const RES_AUTH_PROBLEM;

	const RES_AUTH_FAILURE;

	const RES_AUTH_CONTINUE;

    /** Server callbacks, if compiled with --memcached-protocol */
	const ON_CONNECT;
	const ON_ADD;
	const ON_APPEND;
	const ON_DECREMENT;
	const ON_DELETE;
	const ON_FLUSH;
	const ON_GET;
	const ON_INCREMENT;
	const ON_NOOP;
	const ON_PREPEND;
	const ON_QUIT;
	const ON_REPLACE;
	const ON_SET;
	const ON_STAT;
	const ON_VERSION;
    /** Constants used when compiled with --memcached-protocol */
	const RESPONSE_SUCCESS;
	const RESPONSE_KEY_ENOENT;
	const RESPONSE_KEY_EEXISTS;
	const RESPONSE_E2BIG;
	const RESPONSE_EINVAL;
	const RESPONSE_NOT_STORED;
	const RESPONSE_DELTA_BADVAL;
	const RESPONSE_NOT_MY_VBUCKET;
	const RESPONSE_AUTH_ERROR;
	const RESPONSE_AUTH_CONTINUE;
	const RESPONSE_UNKNOWN_COMMAND;
	const RESPONSE_ENOMEM;
	const RESPONSE_NOT_SUPPORTED;
	const RESPONSE_EINTERNAL;
	const RESPONSE_EBUSY;
	const RESPONSE_ETMPFAIL;

	public function __construct( $persistent_id = '', $on_new_object_cb = null ) {}

	public function get( $key, callable $cache_cb = null, $flags = 0) {}

	public function getByKey( $server_key, $key, callable $cache_cb = null, $flags = 0 ) {}

	public function getMulti( array $keys, $flags = 0) {}

	public function getMultiByKey( $server_key, array $keys, $flags = 0) {}

	public function getDelayed( array $keys, $with_cas = null, $value_cb = null ) {}

	public function getDelayedByKey( $server_key, array $keys, $with_cas = null, $value_cb = null ) {}

	public function fetch( ) {}

	public function fetchAll( ) {}

	public function set( $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function touch( $key, $expiration = 0 ) {}

	public function touchbyKey( $key, $expiration = 0 ) {}

	public function setByKey( $server_key, $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function setMulti( array $items, $expiration = 0, $udf_flags = 0 ) {}

	public function setMultiByKey( $server_key, array $items, $expiration = 0, $udf_flags = 0 ) {}

	public function cas( $token, $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function casByKey( $token, $server_key, $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function add( $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function addByKey( $server_key, $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function append( $key, $value ) {}

	public function appendByKey( $server_key, $key, $value ) {}

	public function prepend( $key, $value ) {}

	public function prependByKey( $server_key, $key, $value ) {}

	public function replace( $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function replaceByKey( $server_key, $key, $value, $expiration = 0, $udf_flags = 0 ) {}

	public function delete( $key, $time = 0 ) {}

	public function deleteByKey( $server_key, $key, $time = 0 ) {}

	public function deleteMulti( array $keys, $expiration = 0 ) {}

	public function deleteMultiByKey( $server_key, array $keys, $expiration = 0 ) {}

	public function increment( $key, $offset = 1, $initial_value = 0, $expiry = 0) {}

	public function decrement( $key, $offset = 1, $initial_value = 0, $expiry = 0) {}

	public function getOption( $option ) {}

	public function setOption( $option, $value ) {}

	public function setOptions( array $options ) {}

	public function setBucket( array $host_map, array $forward_map, $replicas ) {}

	public function addServer( $host, $port,  $weight = 0 ) {}

	public function addServers( array $servers ) {}

	public function getServerList( ) {}

	public function getServerByKey( $server_key ) {}

	public function getLastErrorMessage( ) {}

	public function getLastErrorCode( ) {}

	public function getLastErrorErrno( ) {}

	public function getLastDisconnectedServer( ) {}

	public function flush( $delay = 0 ) {}

	public function flushBuffers( ) {}

	public function getStats( $type = null ) {}

	public function getAllKeys( ) {}

	public function getVersion( ) {}

	public function getResultCode( ) {}

	public function getResultMessage( ) {}

	public function isPersistent( ) {}

	public function isPristine( ) {}

	public function setSaslAuthData( $username, $password ) {}

	public function setEncodingKey( $key ) {}

	public function createAndSetTLSContext( array $context_config ) {}

}

class MemcachedException extends Exception {

	function __construct( $errmsg = "", $errcode  = 0 ) {}

}

/**
 * TLS context configurations.
 * The client's certificate and key file are only supported in PEM format.
 */
class MemcachedTLSContextConfig {
    public ?string $cert_file = null;                   /* Cert file name (PEM formatted) */
    public ?string $key_file = null;                    /* Private key filename for cert_file (PEM formatted) */
    public ?string $key_file_pass = null;               /* Optional password for key_file */
    public ?string $ca_cert_file = null;
    public ?string $ca_cert_dir = null;
    public ?string $hostname = null;                    /* Required unless skip_hostname_verify is set to true */
    public ?string $protocol = null;                   /* Enable only one of the TLS protocols: "TLSv1.2" or "TLSv1.3".
                                                           By default, both v1.2 and v1.3 are enabled. */
    public ?string $ciphers = null;
    public ?string $ciphersuites = null;
    public bool $prefer_server_ciphers = false;         /* When choosing a cipher, use the server's preferences instead
                                                           of the client preferences. */
    public bool $skip_cert_verify = false;
    public bool $skip_hostname_verify = false;
}