<!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>Retrieve a Memcached option value</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcached.getmultibykey.html">Memcached::getMultiByKey</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.getresultcode.html">Memcached::getResultCode</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.getoption" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcached::getOption</h1>
<p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::getOption</span> — <span class="dc-title">Retrieve a Memcached option value</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcached.getoption-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>Memcached::getOption</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$option</code></span>
)</div>
<p class="para rdfs-comment">
This method returns 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>
</div>
<div class="refsect1 parameters" id="refsect1-memcached.getoption-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">option</code></em></span>
<dd>
<p class="para">
One of the <em>Memcached::OPT_*</em> constants.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcached.getoption-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value of the requested option, or <strong><code>FALSE</code></strong> on
error.
</p>
</div>
<div class="refsect1 examples" id="refsect1-memcached.getoption-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4443">
<p><strong>Example #1 Retrieving Memcached options</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_COMPRESSION</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_POLL_TIMEOUT</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
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(true)
int(1000)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-memcached.getoption-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><strong>Memcached::getOption()</strong></span></li>
<li class="member"> <span class="methodname"><a href="memcached.setoption.html" class="methodname" rel="rdfs-seeAlso">Memcached::setOption()</a> - Set a Memcached option</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.getmultibykey.html">Memcached::getMultiByKey</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.getresultcode.html">Memcached::getResultCode</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>
