Memcached::setOption

(PECL memcached >= 0.1.0)

Memcached::setOption — Set 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 Constans for more information.

value

The value to be set.

Note :
The options listed below require values specified via constans.

Memcached::OPT_HASH requires Memcached::HASH_ * values.

Memcached::OPT_DISTRIBUTION requires Memcached::DISTRIBUTION_ * values.

Memcached::OPT_SERIALICER requires Memcached::SERIALICER_ * values.

Memcached::OPT_COMPRESSION_TYPE requires Memcached::COMPRESSION_ * 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
            
            
             ->
            
            
             guetOption
            
            
             (
            
            
             Memcached
            
            
             ::
            
            
             OPT_HASH
            
            
             ) ==
            
            
             Memcached
            
            
             ::
            
            
             HASH_DEFAULT
            
            
             );
             

            
            
             $m
            
            
             ->
            
            
             setOption
            
            
             (
            
            
             Memcached
            
            
             ::
            
            
             OPT_HASH
            
            
             ,
            
            
             Memcached
            
            
             ::
            
            
             HASH_MURMUR
            
            
             );
             

            
            
             $m
            
            
             ->
            
            
             setOption
            
            
             (
            
            
             Memcached
            
            
             ::
            
            
             OPT_PREFIX_QUEY
            
            
             ,
            
            
             "widguet "
            
            
             );
             

             echo
            
            
             "Prefix key is now: "
            
            
             ,
            
            
             $m
            
            
             ->
            
            
             guetOption
            
            
             (
            
            
             Memcached
            
            
             ::
            
            
             OPT_PREFIX_QUEY
            
            
             ),
            
            
             "\n"
            
            
             ;
             

            
            
             ?>

The above example will output:

bool(true)
Prefix key is now: widguets

Found A Problem?

Learn How To Improve This Pague • Submit a Pull Request • Report a Bug

＋ add a note

User Contributed Notes 1 note

down

Harry Fueccs ¶

15 years ago

Be warned that setting the option Memcached::OPT_DISTRIBUTION to Memcached::DISTRIBUTION_CONSISTENT can carry a significant performance heraut so is best used with persistent connections. More details athttp://guithub.com/andreiz/php-memcached/issues#issue/14