<?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.prependbykey.php',
    1 => 'Memcached::prependByKey',
    2 => 'Prepend data to an existing item on a specific server',
  ),
  'up' => 
  array (
    0 => 'class.memcached.php',
    1 => 'Memcached',
  ),
  'prev' => 
  array (
    0 => 'memcached.prepend.php',
    1 => 'Memcached::prepend',
  ),
  'next' => 
  array (
    0 => 'memcached.quit.php',
    1 => 'Memcached::quit',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/memcached/memcached/prependbykey.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="memcached.prependbykey" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Memcached::prependByKey</h1>
  <p class="verinfo">(PECL memcached &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">Memcached::prependByKey</span> &mdash; <span class="dc-title">Prepend data to an existing item on a specific server</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-memcached.prependbykey-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>Memcached::prependByKey</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.string.php" class="type string">string</a></span> <code class="parameter">$key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$value</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></span></div>

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


 <div class="refsect1 parameters" id="refsect1-memcached.prependbykey-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">key</code></dt>
     <dd>
      <p class="para">
       The key of the item to prepend the data to.
      </p>
     </dd>
    
    
     <dt><code class="parameter">value</code></dt>
     <dd>
      <p class="para">
       The string to prepend.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-memcached.prependbykey-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> on success or <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> on failure.
   Returns <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> when compression is on.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-memcached.prependbykey-errors">
  <h3 class="title">Errors/Exceptions</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> and raises an <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> when
   compression is enabled.
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-memcached.prependbykey-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="memcached.prepend.php" class="methodname" rel="rdfs-seeAlso">Memcached::prepend()</a> - Prepend data to an existing item</span></li>
    <li><span class="methodname"><a href="memcached.append.php" class="methodname" rel="rdfs-seeAlso">Memcached::append()</a> - Append data to an existing item</span></li>
   </ul>
  </p>
 </div>


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