<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yac.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'yac.add.php',
    1 => 'Yac::add',
    2 => '存储一个值，但不覆盖已有条目',
  ),
  'up' => 
  array (
    0 => 'class.yac.php',
    1 => 'Yac',
  ),
  'prev' => 
  array (
    0 => 'class.yac.php',
    1 => 'Yac',
  ),
  'next' => 
  array (
    0 => 'yac.construct.php',
    1 => 'Yac::__construct',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yac/yac/add.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yac.add" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yac::add</h1>
  <p class="verinfo">(PECL yac &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">Yac::add</span> &mdash; <span class="dc-title">存储一个值，但不覆盖已有条目</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yac.add-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yac::add</strong></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.array.php" class="type array">array</a></span></span> <code class="parameter">$key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$value</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$ttl</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yac::add</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$values</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$ttl</code><span class="initializer"> = 0</span></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">
   向缓存中存储一个值。与 <span class="methodname"><a href="yac.set.php" class="methodname">Yac::set()</a></span> 不同，它不会覆盖仍然有效的已有条目；遇到这种情况时存储会被拒绝。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yac.add-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">key</code></dt>
    <dd>
     <p class="simpara">
      <span class="type"><a href="language.types.string.php" class="type string">string</a></span> 类型的键，或者一个由
      <code class="literal">key =&gt; value</code> 键值对组成的
      <span class="type"><a href="language.types.array.php" class="type array">array</a></span>，一次调用存储多个条目。
     </p>
    </dd>
   
   
    <dt><code class="parameter">value</code></dt>
    <dd>
     <p class="simpara">
      要存储的值。除 <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> 外的所有 PHP 类型都可以存储。仅在单键形式下使用；当 <code class="parameter">key</code> 是数组时，该参数位置实际上是可选的 <code class="parameter">ttl</code>。
     </p>
    </dd>
   
   
    <dt><code class="parameter">ttl</code></dt>
    <dd>
     <p class="simpara">
      生存时间，单位为秒。<code class="literal">0</code> 表示条目永不因时间过期。
     </p>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yac.add-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   成功时返回 <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong>，失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。当键已存在且未过期时，存储同样会被拒绝（返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>）。
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-yac.add-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="methodname"><strong>Yac::add()</strong></span> 示例</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$yac </span><span style="color: #007700">= new </span><span style="color: #0000BB">Yac</span><span style="color: #007700">();

</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">"foo"</span><span style="color: #007700">, </span><span style="color: #DD0000">"bar"</span><span style="color: #007700">));          </span><span style="color: #FF8000">// bool(true)
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">"foo"</span><span style="color: #007700">, </span><span style="color: #DD0000">"baz"</span><span style="color: #007700">));          </span><span style="color: #FF8000">// bool(false)："foo" 已存在
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
  <div class="example" id="example-2">
   <p><strong>示例 #2 添加带 TTL 的条目</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$yac </span><span style="color: #007700">= new </span><span style="color: #0000BB">Yac</span><span style="color: #007700">();

</span><span style="color: #FF8000">// ttl 以秒为单位；0（默认值）表示条目永不过期
</span><span style="color: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(</span><span style="color: #DD0000">"short-lived"</span><span style="color: #007700">, </span><span style="color: #DD0000">"value"</span><span style="color: #007700">, </span><span style="color: #0000BB">5</span><span style="color: #007700">);
</span><span style="color: #0000BB">sleep</span><span style="color: #007700">(</span><span style="color: #0000BB">6</span><span style="color: #007700">);
</span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"short-lived"</span><span style="color: #007700">));        </span><span style="color: #FF8000">// bool(false)：已过期
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
  <div class="example" id="example-3">
   <p><strong>示例 #3 一次添加多个条目</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
$yac </span><span style="color: #007700">= new </span><span style="color: #0000BB">Yac</span><span style="color: #007700">();

</span><span style="color: #FF8000">// 一次调用存储多个键值对，并指定 ttl
</span><span style="color: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">add</span><span style="color: #007700">(array(</span><span style="color: #DD0000">"a" </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">"b" </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">2</span><span style="color: #007700">), </span><span style="color: #0000BB">60</span><span style="color: #007700">);
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yac.add-seealso">
  <h3 class="title">参见</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="methodname"><a href="yac.set.php" class="methodname" rel="rdfs-seeAlso">Yac::set()</a> - 向缓存中存储一个值</span></li>
    <li><span class="methodname"><a href="yac.get.php" class="methodname" rel="rdfs-seeAlso">Yac::get()</a> - 从缓存中取值</span></li>
    <li><span class="methodname"><a href="yac.delete.php" class="methodname" rel="rdfs-seeAlso">Yac::delete()</a> - 从缓存中删除条目</span></li>
   </ul>
  </p>
 </div>


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