PHP 8.1.0 Released!

Memcached::setOption

(PECL memcached >= 0.1.0)

Memcached::setOptionSet a Memcached option

Description

public 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.

Return Values

Returns true on success or false on failure.

Examples

Example #1 Setting a Memcached option

<?php
$m 
= new Memcached();
var_dump($m->getOption(Memcached::OPT_HASH) == Memcached::HASH_DEFAULT);
$m->setOption(Memcached::OPT_HASHMemcached::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:

bool(true)
Prefix key is now: widgets

See Also

add a note add a note

User Contributed Notes 1 note

up
0
Harry Fuecks
11 years ago
Be warned that setting the option Memcached::OPT_DISTRIBUTION to Memcached::DISTRIBUTION_CONSISTENT can carry a significant performance hit so is best used with persistent connections. More details at http://github.com/andreiz/php-memcached/issues#issue/14
To Top