| Methods |
public
|
connect(string $host, int $port, int $timeout = 1)
(PECL memcache >= 0.2.0)<br/>
Open memcached server connection
(PECL memcache >= 0.2.0)
Open memcached server connection
Parameters
| $host |
Point to the host where memcached is listening for connections. This parameter
may also specify other transports like unix:///path/to/memcached.sock
to use UNIX domain sockets, in this case port must also
be set to 0.
|
| $port |
[optional]
Point to the port where memcached is listening for connections. Set this
parameter to 0 when using UNIX domain sockets.
Please note: port defaults to
{@link https://php.net/manual/en/memcache.ini.php#ini.memcache.default-port memcache.default_port}
if not specified. For this reason it is wise to specify the port
explicitly in this method call.
|
| $timeout |
[optional] Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow.
|
|
#
|
public
|
addServer(
string $host,
int $port = 11211,
bool $persistent = true,
int $weight = null,
int $timeout = 1,
int $retry_interval = 15,
bool $status = true,
callable $failure_callback = null,
int $timeoutms = null,
): bool
(PECL memcache >= 2.0.0)<br/>
Add a memcached server to connection pool
(PECL memcache >= 2.0.0)
Add a memcached server to connection pool
Parameters
| $host |
Point to the host where memcached is listening for connections. This parameter
may also specify other transports like unix:///path/to/memcached.sock
to use UNIX domain sockets, in this case port must also
be set to 0.
|
| $port |
[optional]
Point to the port where memcached is listening for connections.
Set this
parameter to 0 when using UNIX domain sockets.
Please note: port defaults to
memcache.default_port
if not specified. For this reason it is wise to specify the port
explicitly in this method call.
|
| $persistent |
[optional]
Controls the use of a persistent connection. Default to TRUE.
|
| $weight |
[optional]
Number of buckets to create for this server which in turn control its
probability of it being selected. The probability is relative to the
total weight of all servers.
|
| $timeout |
[optional]
Value in seconds which will be used for connecting to the daemon. Think
twice before changing the default value of 1 second - you can lose all
the advantages of caching if your connection is too slow.
|
| $retry_interval |
[optional]
Controls how often a failed server will be retried, the default value
is 15 seconds. Setting this parameter to -1 disables automatic retry.
Neither this nor the persistent parameter has any
effect when the extension is loaded dynamically via dl.
Each failed connection struct has its own timeout and before it has expired
the struct will be skipped when selecting backends to serve a request. Once
expired the connection will be successfully reconnected or marked as failed
for another retry_interval seconds. The typical
effect is that each web server child will retry the connection about every
retry_interval seconds when serving a page.
|
| $status |
[optional]
Controls if the server should be flagged as online. Setting this parameter
to FALSE and retry_interval to -1 allows a failed
server to be kept in the pool so as not to affect the key distribution
algorithm. Requests for this server will then failover or fail immediately
depending on the memcache.allow_failover setting.
Default to TRUE, meaning the server should be considered online.
|
| $failure_callback |
[optional]
Allows the user to specify a callback function to run upon encountering an
error. The callback is run before failover is attempted. The function takes
two parameters, the hostname and port of the failed server.
|
| $timeoutms |
[optional]
|
Returns
TRUE on success or FALSE on failure.
|
#
|
public
|
setServerParams(
string $host,
int $port = 11211,
int $timeout = 1,
int $retry_interval = 15,
bool $status = true,
callable $failure_callback = null,
)
(PECL memcache >= 2.1.0)<br/>
Changes server parameters and status at runtime
(PECL memcache >= 2.1.0)
Changes server parameters and status at runtime
Parameters
| $host |
Point to the host where memcached is listening for connections. .
|
| $port |
[optional]
Point to the port where memcached is listening for connections.
|
| $timeout |
[optional]
Value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow.
|
| $retry_interval |
[optional]
Controls how often a failed server will be retried, the default value
is 15 seconds. Setting this parameter to -1 disables automatic retry.
Neither this nor the persistent parameter has any
effect when the extension is loaded dynamically via {@link https://secure.php.net/manual/en/function.dl.php dl()}.
|
| $status |
[optional]
Controls if the server should be flagged as online. Setting this parameter
to FALSE and retry_interval to -1 allows a failed
server to be kept in the pool so as not to affect the key distribution
algorithm. Requests for this server will then failover or fail immediately
depending on the memcache.allow_failover setting.
Default to TRUE, meaning the server should be considered online.
|
| $failure_callback |
[optional]
Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attempted.
The function takes two parameters, the hostname and port of the failed server.
|
|
#
|
public
|
setFailureCallback()
|
#
|
public
|
getServerStatus(string $host, int $port = 11211): int
(PECL memcache >= 2.1.0)<br/>
Returns server status
(PECL memcache >= 2.1.0)
Returns server status
Parameters
| $host |
Point to the host where memcached is listening for connections.
|
| $port |
Point to the port where memcached is listening for connections.
|
Returns
Returns a the servers status. 0 if server is failed, non-zero otherwise
|
#
|
public
|
findServer()
|
#
|
public
|
getVersion(): string|false
(PECL memcache >= 0.2.0)<br/>
Return version of the server
(PECL memcache >= 0.2.0)
Return version of the server
Returns
Returns a string of server version number or FALSE on failure.
|
#
|
public
|
add(string $key, mixed $var, int $flag = null, int $expire = null): bool
(PECL memcache >= 2.0.0)<br/>
Add an item to the server. If the key already exists, the value will not be added and …
(PECL memcache >= 2.0.0)
Add an item to the server. If the key already exists, the value will not be added and FALSE will be returned.
Parameters
| $key |
The key that will be associated with the item.
|
| $var |
The variable to store. Strings and integers are stored as is, other types are stored serialized.
|
| $flag |
[optional]
Use MEMCACHE_COMPRESSED to store the item
compressed (uses zlib).
|
| $expire |
[optional] Expiration time of the item.
If it's equal to zero, the item will never expire.
You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).
|
Returns
Returns TRUE on success or FALSE on failure. Returns FALSE if such key already exist. For the rest Memcache::add() behaves similarly to Memcache::set().
|
#
|
public
|
set(string $key, mixed $var, int $flag = null, int $expire = null): bool
(PECL memcache >= 0.2.0)<br/>
Stores an item var with key on the memcached server. Parameter expire is expiration…
(PECL memcache >= 0.2.0)
Stores an item var with key on the memcached server. Parameter expire is expiration time in seconds.
If it's 0, the item never expires (but memcached server doesn't guarantee this item to be stored all the time,
it could be deleted from the cache to make place for other items).
You can use MEMCACHE_COMPRESSED constant as flag value if you want to use on-the-fly compression (uses zlib).
Parameters
| $key |
The key that will be associated with the item.
|
| $var |
The variable to store. Strings and integers are stored as is, other types are stored serialized.
|
| $flag |
[optional] Use MEMCACHE_COMPRESSED to store the item compressed (uses zlib).
|
| $expire |
[optional] Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).
|
Returns
Returns TRUE on success or FALSE on failure.
|
#
|
public
|
replace(string $key, mixed $var, int $flag = null, int $expire = null): bool
(PECL memcache >= 0.2.0)<br/>
Replace value of the existing item
(PECL memcache >= 0.2.0)
Replace value of the existing item
Parameters
| $key |
The key that will be associated with the item.
|
| $var |
The variable to store. Strings and integers are stored as is, other types are stored serialized.
|
| $flag |
[optional] Use MEMCACHE_COMPRESSED to store the item compressed (uses zlib).
|
| $expire |
[optional] Expiration time of the item. If it's equal to zero, the item will never expire. You can also use Unix timestamp or a number of seconds starting from current time, but in the latter case the number of seconds may not exceed 2592000 (30 days).
|
Returns
Returns TRUE on success or FALSE on failure.
|
#
|
public
|
cas()
|
#
|
public
|
append()
|
#
|
public
|
prepend(): string
|
#
|
public
|
get(string|array $key, int|array &$flags = null): string|array|false
(PECL memcache >= 0.2.0)<br/>
Retrieve item from the server
(PECL memcache >= 0.2.0)
Retrieve item from the server
Parameters
| $key |
The key or array of keys to fetch.
|
| $flags |
[optional]
If present, flags fetched along with the values will be written to this parameter. These
flags are the same as the ones given to for example {@link https://php.net/manual/en/memcache.set.php Memcache::set()}.
The lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to indicate
compression and serialization status).
|
Returns
Returns the string associated with the key or
an array of found key-value pairs when key is an {@link https://php.net/manual/en/language.types.array.php array}.
Returns FALSE on failure, key is not found or
key is an empty {@link https://php.net/manual/en/language.types.array.php array}.
|
#
|
public
|
delete(string $key, int $timeout = 0): bool
(PECL memcache >= 0.2.0)<br/>
Delete item from the server
https://secure.php.net/manual/en/memcache.delete.php
Parameters
| $key |
The key associated with the item to delete.
|
| $timeout |
[optional] This deprecated parameter is not supported, and defaults to 0 seconds. Do not use this parameter.
|
Returns
Returns TRUE on success or FALSE on failure.
|
#
|
public
|
getStats(string $type = null, int $slabid = null, int $limit = 100): array|false
(PECL memcache >= 0.2.0)<br/>
Get statistics of the server
(PECL memcache >= 0.2.0)
Get statistics of the server
Parameters
| $type |
[optional]
The type of statistics to fetch.
Valid values are {reset, malloc, maps, cachedump, slabs, items, sizes}.
According to the memcached protocol spec these additional arguments "are subject to change for the convenience of memcache developers".
|
| $slabid |
[optional]
Used in conjunction with type set to
cachedump to identify the slab to dump from. The cachedump
command ties up the server and is strictly to be used for
debugging purposes.
|
| $limit |
[optional]
Used in conjunction with type set to cachedump to limit the number of entries to dump.
|
Returns
Returns an associative array of server statistics or FALSE on failure.
|
#
|
public
|
getExtendedStats(string $type = null, int $slabid = null, int $limit = 100): array|false
(PECL memcache >= 2.0.0)<br/>
Get statistics from all servers in pool
(PECL memcache >= 2.0.0)
Get statistics from all servers in pool
Parameters
| $type |
[optional] The type of statistics to fetch. Valid values are {reset, malloc, maps, cachedump, slabs, items, sizes}. According to the memcached protocol spec these additional arguments "are subject to change for the convenience of memcache developers".
|
| $slabid |
[optional]
Used in conjunction with type set to
cachedump to identify the slab to dump from. The cachedump
command ties up the server and is strictly to be used for
debugging purposes.
|
| $limit |
Used in conjunction with type set to cachedump to limit the number of entries to dump.
|
Returns
Returns a two-dimensional associative array of server statistics or FALSE
Returns a two-dimensional associative array of server statistics or FALSE
on failure.
|
#
|
public
|
setCompressThreshold(int $thresold, float $min_saving = 0.2): bool
(PECL memcache >= 2.0.0)<br/>
Enable automatic compression of large values
(PECL memcache >= 2.0.0)
Enable automatic compression of large values
Parameters
| $thresold |
Controls the minimum value length before attempting to compress automatically.
|
| $min_saving |
[optional] Specifies the minimum amount of savings to actually store the value compressed. The supplied value must be between 0 and 1. Default value is 0.2 giving a minimum 20% compression savings.
|
Returns
Returns TRUE on success or FALSE on failure.
|
#
|
public
|
increment(string $key, int $value = 1): int|false
(PECL memcache >= 0.2.0)<br/>
Increment item's value
(PECL memcache >= 0.2.0)
Increment item's value
Parameters
| $key |
Key of the item to increment.
|
| $value |
[optional] increment the item by value
|
Returns
Returns new items value on success or FALSE on failure.
|
#
|
public
|
decrement(string $key, int $value = 1): int|false
(PECL memcache >= 0.2.0)<br/>
Decrement item's value
(PECL memcache >= 0.2.0)
Decrement item's value
Parameters
| $key |
Key of the item do decrement.
|
| $value |
Decrement the item by value.
|
Returns
Returns item's new value on success or FALSE on failure.
|
#
|
public
|
close(): bool
(PECL memcache >= 0.4.0)<br/>
Close memcached server connection
(PECL memcache >= 0.4.0)
Close memcached server connection
Returns
Returns TRUE on success or FALSE on failure.
|
#
|
public
|
flush(): bool
(PECL memcache >= 1.0.0)<br/>
Flush all existing items at the server
(PECL memcache >= 1.0.0)
Flush all existing items at the server
Returns
Returns TRUE on success or FALSE on failure.
|
#
|