php-doc-en/reference/memcached/memcached/getoption.xml
Sherif Ramadan 7916455ba0 Updated memcached docs to reflect new memcached 2.X behavior.
- Added new Runtime Configuration directives.
- Updated libmemcached version requirements and new configuration options.
- Added new memcached 2.0 methods to Memcached class:
    * deletemulti
    * deletemultibykey
    * getallkeys
    * touchbykey
    * touch
    * incrementbykey
    * decrementbykey
    * ispersistent
    * ispristine
    * setsaslauthdata
    * setoptions
    * resetserverlist
    * quit

Modified fixes and modifications to reflect ChangeLog.

Path provided by David Terei (davidterei@gmail.com).


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@329008 c90b9560-bf6c-de11-be94-00142212c4b1
2013-01-08 05:17:16 +00:00

105 lines
2.6 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="memcached.getoption" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::getOption</refname>
<refpurpose>Retrieve a Memcached option value</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Memcached::getOption</methodname>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
This method returns the value of a Memcached <parameter>option</parameter>. Some options
correspond to the ones defined by libmemcached, and some are specific to
the extension. See <link linkend="memcached.constants">Memcached
Constants</link> for more information.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
One of the <literal>Memcached::OPT_*</literal> constants.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns the value of the requested option, or &false; on
error.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Retrieving Memcached options</title>
<programlisting role="php">
<![CDATA[
<?php
$m = new Memcached();
var_dump($m->getOption(Memcached::OPT_COMPRESSION));
var_dump($m->getOption(Memcached::OPT_POLL_TIMEOUT));
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
bool(true)
int(1000)
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>Memcached::getOption</methodname></member>
<member><methodname>Memcached::setOption</methodname></member>
<member><link linkend="memcached.constants">Memcached Constants</link></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->