<!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 from a specific server</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="memcached.getmulti.html">Memcached::getMulti</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.getoption.html">Memcached::getOption</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.getmultibykey" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcached::getMultiByKey</h1>
<p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::getMultiByKey</span> — <span class="dc-title">Retrieve multiple items from a specific server</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcached.getmultibykey-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><strong>Memcached::getMultiByKey</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$server_key</code></span>
, <span class="methodparam"><span class="type">array</span> <code class="parameter">$keys</code></span>
[, <span class="methodparam"><span class="type">string</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::getMultiByKey()</strong></span> is functionally equivalent to
<span class="methodname"><a href="memcached.getmulti.html" class="methodname">Memcached::getMulti()</a></span>, except that the free-form
<em><code class="parameter">server_key</code></em> can be used to map the
<em><code class="parameter">keys</code></em> to a specific server.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-memcached.getmultibykey-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">server_key</code></em></span>
<dd>
<p class="para">
The key identifying the server to store the value on or retrieve it from. Instead of hashing on the actual key for the item, we hash on the server key when deciding which memcached server to talk to. This allows related items to be grouped together on a single server for efficiency with multi operations.
</p>
</dd>
</dt>
<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.getmultibykey-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 seealso" id="refsect1-memcached.getmultibykey-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="memcached.getmulti.html" class="methodname" rel="rdfs-seeAlso">Memcached::getMulti()</a> - Retrieve multiple items</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.getmulti.html">Memcached::getMulti</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.getoption.html">Memcached::getOption</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>
