mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
4b23ef594a
# Translators please wait 24 hours before updating... I'm doing most of them too git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@260761 c90b9560-bf6c-de11-be94-00142212c4b1
131 lines
3.6 KiB
XML
131 lines
3.6 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.9 $ -->
|
|
<refentry xml:id="function.memcache-get" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>Memcache::get</refname>
|
|
<refpurpose>Retrieve item from the server</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>Memcache::get</methodname>
|
|
<methodparam><type>string</type><parameter>key</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter role="reference">flags</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>Memcache::get</methodname>
|
|
<methodparam><type>array</type><parameter>keys</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter role="reference">flags</parameter></methodparam>
|
|
</methodsynopsis>
|
|
|
|
<para>
|
|
<function>Memcache::get</function> returns previously stored data if
|
|
an item with such <parameter>key</parameter> exists on the server at this
|
|
moment.
|
|
</para>
|
|
|
|
<para>
|
|
You can pass array of keys to <function>Memcache::get</function> to get
|
|
array of values. The result array will contain only found key-value pairs.
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>key</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The key or array of keys to fetch.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>flags</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If present, flags fetched along with the values will be written to this parameter. These
|
|
flags are the same as the ones given to for example <function>Memcache::set</function>.
|
|
The lowest byte of the int is reserved for pecl/memcache internal usage (e.g. to indicate
|
|
compression and serialization status).
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns the string associated with the <parameter>key</parameter> or
|
|
&false; on failure or if such <parameter>key</parameter> was not found.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>Memcache::get</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
/* procedural API */
|
|
$memcache_obj = memcache_connect('memcache_host', 11211);
|
|
$var = memcache_get($memcache_obj, 'some_key');
|
|
|
|
/* OO API */
|
|
$memcache_obj = new Memcache;
|
|
$memcache_obj->connect('memcache_host', 11211);
|
|
$var = $memcache_obj->get('some_key');
|
|
|
|
/*
|
|
You also can use array of keys as a parameter.
|
|
If such item wasn't found at the server, the result
|
|
array simply will not include such key.
|
|
*/
|
|
|
|
/* procedural API */
|
|
$memcache_obj = memcache_connect('memcache_host', 11211);
|
|
$var = memcache_get($memcache_obj, Array('some_key', 'another_key'));
|
|
|
|
/* OO API */
|
|
$memcache_obj = new Memcache;
|
|
$memcache_obj->connect('memcache_host', 11211);
|
|
$var = $memcache_obj->get(Array('some_key', 'second_key'));
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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:"../../../../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
|
|
-->
|