<!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>Store multiple items on 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.setmulti.html">Memcached::setMulti</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.setoption.html">Memcached::setOption</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.setmultibykey" class="refentry">
<div class="refnamediv">
<h1 class="refname">Memcached::setMultiByKey</h1>
<p class="verinfo">(PECL memcached >= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::setMultiByKey</span> — <span class="dc-title">Store multiple items on a specific server</span></p>
</div>
<div class="refsect1 description" id="refsect1-memcached.setmultibykey-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>Memcached::setMultiByKey</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">$items</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$expiration</code></span>
] )</div>
<p class="para rdfs-comment">
<span class="function"><strong>Memcached::setMultiByKey()</strong></span> is functionally equivalent to
<span class="methodname"><a href="memcached.setmulti.html" class="methodname">Memcached::setMulti()</a></span>, except that the free-form
<em><code class="parameter">server_key</code></em> can be used to map the keys from
<em><code class="parameter">items</code></em> to a specific server. This is useful if you
need to keep a bunch of related keys on a certain server.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-memcached.setmultibykey-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">items</code></em></span>
<dd>
<p class="para">
An array of key/value pairs to store on the server.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">expiration</code></em></span>
<dd>
<p class="para">
The expiration time, defaults to 0. See <a href="memcached.expiration.html" class="link">Expiration Times</a> for more info.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-memcached.setmultibykey-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success 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.setmultibykey-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="memcached.setmulti.html" class="methodname" rel="rdfs-seeAlso">Memcached::setMulti()</a> - Store multiple items</span></li>
<li class="member"> <span class="methodname"><a href="memcached.set.html" class="methodname" rel="rdfs-seeAlso">Memcached::set()</a> - Store an item</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.setmulti.html">Memcached::setMulti</a></div>
<div class="next" style="text-align: right; float: right;"><a href="memcached.setoption.html">Memcached::setOption</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>
