<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Set a Memcached option</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="memcached.setmultibykey.html">Memcached::setMultiByKey</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcached.setoptions.html">Memcached::setOptions</a></div> <div class="up"><a href="class.memcached.html">Memcached</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="memcached.setoption" class="refentry"> <div class="refnamediv"> <h1 class="refname">Memcached::setOption</h1> <p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::setOption</span> — <span class="dc-title">Set a Memcached option</span></p> </div> <div class="refsect1 description" id="refsect1-memcached.setoption-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Memcached::setOption</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$option</code></span> , <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span> )</div> <p class="para rdfs-comment"> This method sets the value of a Memcached <em><code class="parameter">option</code></em>. Some options correspond to the ones defined by libmemcached, and some are specific to the extension. See <a href="memcached.constants.html" class="link">Memcached Constants</a> for more information. </p> <p class="para"> The options listed below require values specified via constants. <ul class="itemizedlist"> <li class="listitem"><p class="para"> <em>Memcached::OPT_HASH</em> requires <em>Memcached::HASH_*</em> values. </p></li> <li class="listitem"><p class="para"> <em>Memcached::OPT_DISTRIBUTION</em> requires <em>Memcached::DISTRIBUTION_*</em> values. </p></li> </ul> </p> </div> <div class="refsect1 returnvalues" id="refsect1-memcached.setoption-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-memcached.setoption-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-4455"> <p><strong>Example #1 Setting a Memcached option</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$m </span><span style="color: #007700">= new </span><span style="color: #0000BB">Memcached</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">getOption</span><span style="color: #007700">(</span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">OPT_HASH</span><span style="color: #007700">) == </span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">HASH_DEFAULT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">setOption</span><span style="color: #007700">(</span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">OPT_HASH</span><span style="color: #007700">, </span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">HASH_MURMUR</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">setOption</span><span style="color: #007700">(</span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">OPT_PREFIX_KEY</span><span style="color: #007700">, </span><span style="color: #DD0000">"widgets"</span><span style="color: #007700">);<br />echo </span><span style="color: #DD0000">"Prefix key is now: "</span><span style="color: #007700">, </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">getOption</span><span style="color: #007700">(</span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">OPT_PREFIX_KEY</span><span style="color: #007700">), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> bool(true) Prefix key is now: widgets </pre></div> </div> </div> </p> </div> <div class="refsect1 seealso" id="refsect1-memcached.setoption-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="methodname"><a href="memcached.getoption.html" class="methodname" rel="rdfs-seeAlso">Memcached::getOption()</a> - Retrieve a Memcached option value</span></li> <li class="member"> <span class="methodname"><a href="memcached.setoptions.html" class="methodname" rel="rdfs-seeAlso">Memcached::setOptions()</a> - Set Memcached options</span></li> <li class="member"><a href="memcached.constants.html" class="link">Memcached Constants</a></li> </ul> </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="memcached.setmultibykey.html">Memcached::setMultiByKey</a></div> <div class="next" style="text-align: right; float: right;"><a href="memcached.setoptions.html">Memcached::setOptions</a></div> <div class="up"><a href="class.memcached.html">Memcached</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>