<!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 multiple items</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcached.getdelayedbykey.html">Memcached::getDelayedByKey</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.getmultibykey.html">Memcached::getMultiByKey</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.getmulti" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcached::getMulti</h1>
<p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::getMulti</span> — <span class="dc-title">Retrieve multiple items</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcached.getmulti-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::getMulti</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$keys</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$cas_tokens</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span>
]] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcached::getMulti()</strong></span> is similar to
<span class="methodname"><a href="memcached.get.html" class="methodname">Memcached::get()</a></span>, but instead of a single key
item, it retrieves multiple items the keys of which are specified in the
<em><code class="parameter">keys</code></em> array. If <em><code class="parameter">cas_tokens</code></em>
variable is provided, it is filled with the CAS token values for the found
items.
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Unlike <span class="methodname"><a href="memcached.get.html" class="methodname">Memcached::get()</a></span> it is not possible to
specify a read-through cache callback for
<span class="function"><strong>Memcached::getMulti()</strong></span>, because the memcache protocol
does not provide information on which keys were not found in the multi-key
request.
</p>
</p></blockquote>
</p>
<p class="para">
The <em><code class="parameter">flags</code></em> parameter can be used to specify
additional options for <span class="function"><strong>Memcached::getMulti()</strong></span>. Currently,
the only available option is
<strong><code>Memcached::GET_PRESERVE_ORDER</code></strong> that ensures that the
keys are returned in the same order as they were requested in.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-memcached.getmulti-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">keys</code></em></span>
<dd>
<p class="para">
Array of keys to retrieve.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">cas_tokens</code></em></span>
<dd>
<p class="para">
The variable to store the CAS tokens for the found items.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
The flags for the get operation.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcached.getmulti-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the array of found items or <strong><code>FALSE</code></strong> on failure.
Use <span class="methodname"><a href="memcached.getresultcode.html" class="methodname">Memcached::getResultCode()</a></span> if necessary.
</p>
</div>
<div class="refsect1 examples" id="refsect1-memcached.getmulti-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4441">
<p><strong>Example #1 <span class="function"><strong>Memcached::getMulti()</strong></span> example</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">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$items </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'key1' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'value1'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'key2' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'value2'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'key3' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'value3'<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">setMulti</span><span style="color: #007700">(</span><span style="color: #0000BB">$items</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">getMulti</span><span style="color: #007700">(array(</span><span style="color: #DD0000">'key1'</span><span style="color: #007700">, </span><span style="color: #DD0000">'key3'</span><span style="color: #007700">, </span><span style="color: #DD0000">'badkey'</span><span style="color: #007700">), </span><span style="color: #0000BB">$cas</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$result</span><span style="color: #007700">, </span><span style="color: #0000BB">$cas</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>
array(2) {
["key1"]=>
string(6) "value1"
["key3"]=>
string(6) "value3"
}
array(2) {
["key1"]=>
float(2360)
["key3"]=>
float(2362)
}
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-4442">
<p><strong>Example #2 <strong><code>Memcached::GET_PRESERVE_ORDER</code></strong> example</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">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">addServer</span><span style="color: #007700">(</span><span style="color: #DD0000">'localhost'</span><span style="color: #007700">, </span><span style="color: #0000BB">11211</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$data </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">'foo' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'foo-data'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'bar' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'bar-data'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'baz' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'baz-data'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'lol' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'lol-data'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'kek' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'kek-data'</span><span style="color: #007700">,<br />);<br /><br /></span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">setMulti</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">, </span><span style="color: #0000BB">3600</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$null </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$keys </span><span style="color: #007700">= </span><span style="color: #0000BB">array_keys</span><span style="color: #007700">(</span><span style="color: #0000BB">$data</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$keys</span><span style="color: #007700">[] = </span><span style="color: #DD0000">'zoo'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$got </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">getMulti</span><span style="color: #007700">(</span><span style="color: #0000BB">$keys</span><span style="color: #007700">, </span><span style="color: #0000BB">$null</span><span style="color: #007700">, </span><span style="color: #0000BB">Memcached</span><span style="color: #007700">::</span><span style="color: #0000BB">GET_PRESERVE_ORDER</span><span style="color: #007700">);<br /><br />foreach (</span><span style="color: #0000BB">$got </span><span style="color: #007700">as </span><span style="color: #0000BB">$k </span><span style="color: #007700">=> </span><span style="color: #0000BB">$v</span><span style="color: #007700">) {<br /> echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$k</span><span style="color: #DD0000"> </span><span style="color: #0000BB">$v</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />}<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>
foo foo-data
bar bar-data
baz baz-data
lol lol-data
kek kek-data
zoo
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-memcached.getmulti-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="memcached.getmultibykey.html" class="methodname" rel="rdfs-seeAlso">Memcached::getMultiByKey()</a> - Retrieve multiple items from a specific server</span></li>
<li class="member"> <span class="methodname"><a href="memcached.get.html" class="methodname" rel="rdfs-seeAlso">Memcached::get()</a> - Retrieve an item</span></li>
<li class="member"> <span class="methodname"><a href="memcached.getdelayed.html" class="methodname" rel="rdfs-seeAlso">Memcached::getDelayed()</a> - Request multiple items</span></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.getdelayedbykey.html">Memcached::getDelayedByKey</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.getmultibykey.html">Memcached::getMultiByKey</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>
