php8.5
Home/ Manual/ memcached / memcached/ Memcached::setOption

Memcached::setOption

PHP function Edit on GitHub ✎

(PECL memcached >= 0.1.0)

Set a Memcached option

Description

Memcached::setOption(int $option, mixed $value): bool

This method sets the value of a Memcached option. Some options correspond to the ones defined by libmemcached, and some are specific to the extension.

Parameters

option

One of the Memcached::OPT_* constant. See Memcached Constants for more information.

value

The value to be set.

Note

The options listed below require values specified via constants.

  • Memcached::OPT_HASH requires Memcached::HASH_* values.
  • Memcached::OPT_DISTRIBUTION requires Memcached::DISTRIBUTION_* values.
  • Memcached::OPT_SERIALIZER requires Memcached::SERIALIZER_* values.
  • Memcached::OPT_COMPRESSION_TYPE requires Memcached::COMPRESSION_* values.

Return Values

Success

Examples

Setting a Memcached option

php
<?php
$m = new Memcached();
var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT);
$m->setOption(Memcached::OPT_HASH, Memcached::HASH_MURMUR);
$m->setOption(Memcached::OPT_PREFIX_KEY, "widgets");
echo "Prefix key is now: ", $m->getOption(Memcached::OPT_PREFIX_KEY), "\n";
?>

The above example will output:

output
bool(true)
Prefix key is now: widgets

See Also

Source: reference/memcached/memcached/setoption.xml · from the official PHP manual (php/doc-en)