<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.memcached.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'memcached.deletemultibykey.php',
    1 => 'Memcached::deleteMultiByKey',
    2 => 'Delete multiple items from a specific server',
  ),
  'up' => 
  array (
    0 => 'class.memcached.php',
    1 => 'Memcached',
  ),
  'prev' => 
  array (
    0 => 'memcached.deletemulti.php',
    1 => 'Memcached::deleteMulti',
  ),
  'next' => 
  array (
    0 => 'memcached.fetch.php',
    1 => 'Memcached::fetch',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/memcached/memcached/deletemultibykey.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="memcached.deletemultibykey" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Memcached::deleteMultiByKey</h1>
  <p class="verinfo">(PECL memcached &gt;= 2.0.0)</p><p class="refpurpose"><span class="refname">Memcached::deleteMultiByKey</span> &mdash; <span class="dc-title">Delete multiple items from a specific server</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-memcached.deletemultibykey-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Memcached::deleteMultiByKey</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$server_key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$keys</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$time</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.array.php" class="type array">array</a></span></div>

  <p class="para rdfs-comment">
   <span class="function"><strong>Memcached::deleteMultiByKey()</strong></span> is functionally equivalent to
   <span class="methodname"><a href="memcached.deletemulti.php" class="methodname">Memcached::deleteMulti()</a></span>, except that the free-form
   <code class="parameter">server_key</code> can be used to map the
   <code class="parameter">keys</code> to a specific server.
  </p>

 </div>


 <div class="refsect1 parameters" id="refsect1-memcached.deletemultibykey-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">server_key</code></dt>
     <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><code class="parameter">keys</code></dt>
     <dd>
      <p class="para">
       The keys to be deleted.
      </p>
     </dd>
    
    
     <dt><code class="parameter">time</code></dt>
     <dd>
      <p class="para">
       The amount of time the server will wait to delete the items.
      </p>
      <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">
       As of memcached 1.3.0 (released 2009) this feature is no longer
       supported. Passing a non-zero <code class="parameter">time</code> will cause
       the deletion to fail. <span class="methodname"><a href="memcached.getresultcode.php" class="methodname">Memcached::getResultCode()</a></span>
       will return <strong><code>MEMCACHED_INVALID_ARGUMENTS</code></strong>.
      </span></p></blockquote>

     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-memcached.deletemultibykey-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns an array indexed by <code class="parameter">keys</code>. Each element
   is <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> if the corresponding key was deleted, or one of the
   <strong><code><a href="memcached.constants.php#memcached.constants.res-success">Memcached::RES_<span class="replaceable">*</span></a></code></strong> constants if the corresponding deletion
   failed.
   </p>
  <p class="para">
   The <span class="methodname"><a href="memcached.getresultcode.php" class="methodname">Memcached::getResultCode()</a></span> will return
   the result code for the last executed delete operation, that is, the delete
   operation for the last element of <code class="parameter">keys</code>.
  </p>

 </div>


 <div class="refsect1 seealso" id="refsect1-memcached.deletemultibykey-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="memcached.delete.php" class="methodname" rel="rdfs-seeAlso">Memcached::delete()</a> - Delete an item</span></li>
    <li><span class="methodname"><a href="memcached.deletebykey.php" class="methodname" rel="rdfs-seeAlso">Memcached::deleteByKey()</a> - Delete an item from a specific server</span></li>
    <li><span class="methodname"><a href="memcached.deletemulti.php" class="methodname" rel="rdfs-seeAlso">Memcached::deleteMulti()</a> - Delete multiple items</span></li>
   </ul>
  </p>
 </div>


</div><?php manual_footer($setup); ?>