Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 9154

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!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>Delete an item 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.delete.html">Memcached::delete</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="memcached.deletemulti.html">Memcached::deleteMulti</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.deletebykey" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Memcached::deleteByKey</h1>
  <p class="verinfo">(PECL memcached &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::deleteByKey</span> &mdash; <span class="dc-title">Delete an item from a specific server</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-memcached.deletebykey-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::deleteByKey</strong></span>
    ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$server_key</code></span>
   , <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
   [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$time</code><span class="initializer"> = 0</span></span>
  ] )</div>

  <p class="para rdfs-comment">
    <span class="function"><strong>Memcached::deleteByKey()</strong></span> is functionally equivalent to
    <span class="methodname"><a href="memcached.delete.html" class="methodname">Memcached::delete()</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">key</code></em> to a specific server.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-memcached.deletebykey-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">key</code></em></span>
     <dd>

      <p class="para">
       The key to be deleted.
      </p>
     </dd>

    </dt>

    <dt>

     <span class="term"><em><code class="parameter">time</code></em></span>
     <dd>

      <p class="para">
       The amount of time the server will wait to delete the item.
      </p>
     </dd>

    </dt>

   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-memcached.deletebykey-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.
   The  <span class="methodname"><a href="memcached.getresultcode.html" class="methodname">Memcached::getResultCode()</a></span> will return
   <strong><code>Memcached::RES_NOTFOUND</code></strong> if the key does not exist.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-memcached.deletebykey-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li class="member"> <span class="methodname"><a href="memcached.delete.html" class="methodname" rel="rdfs-seeAlso">Memcached::delete()</a> - Delete an item</span></li>
    <li class="member"> <span class="methodname"><a href="memcached.deletemulti.html" class="methodname" rel="rdfs-seeAlso">Memcached::deleteMulti()</a> - Delete multiple items</span></li>
    <li class="member"> <span class="methodname"><a href="memcached.deletemultibykey.html" class="methodname" rel="rdfs-seeAlso">Memcached::deleteMultiByKey()</a> - Delete multiple items from a specific server</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.delete.html">Memcached::delete</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="memcached.deletemulti.html">Memcached::deleteMulti</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>