mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 23:08:55 +00:00
5faa7a6747
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@324122 c90b9560-bf6c-de11-be94-00142212c4b1
108 lines
3 KiB
XML
108 lines
3 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="memcached.getbykey" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Memcached::getByKey</refname>
|
|
<refpurpose>Retrieve an item from a specific server</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>mixed</type><methodname>Memcached::getByKey</methodname>
|
|
<methodparam><type>string</type><parameter>server_key</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice="opt"><type>callable</type><parameter>cache_cb</parameter></methodparam>
|
|
<methodparam choice="opt"><type>float</type><parameter role="reference">cas_token</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>Memcached::getByKey</function> is functionally equivalent to
|
|
<methodname>Memcached::get</methodname>, except that the free-form
|
|
<parameter>server_key</parameter> can be used to map the
|
|
<parameter>key</parameter> to a specific server.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>server_key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
&memcached.parameter.server_key;
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The key of the item to fetch.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>cache_cb</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Read-through caching callback or &null;
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>cas_token</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The variable to store the CAS token in.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the value stored in the cache or &false; otherwise.
|
|
The <methodname>Memcached::getResultCode</methodname> will return
|
|
<constant>Memcached::RES_NOTFOUND</constant> if the key does not exist.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><methodname>Memcached::get</methodname></member>
|
|
<member><methodname>Memcached::getMulti</methodname></member>
|
|
<member><methodname>Memcached::getDelayed</methodname></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
|
|
-->
|