<?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.get.php',
    1 => 'Yac::get',
    2 => '从缓存中取值',
  ),
  'up' => 
  array (
    0 => 'class.yac.php',
    1 => 'Yac',
  ),
  'prev' => 
  array (
    0 => 'yac.flush.php',
    1 => 'Yac::flush',
  ),
  'next' => 
  array (
    0 => 'yac.getter.php',
    1 => 'Yac::__get',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yac/yac/get.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yac.get" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">Yac::get</h1>
  <p class="verinfo">(PECL yac &gt;= 1.0.0)</p><p class="refpurpose"><span class="refname">Yac::get</span> &mdash; <span class="dc-title">从缓存中取值</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yac.get-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::get</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">$default</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="simpara">
   从缓存中取值。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yac.get-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> 类型的键，或者由键组成的 <span class="type"><a href="language.types.array.php" class="type array">array</a></span>。
     </p>
    </dd>
   
   
    <dt><code class="parameter">default</code></dt>
    <dd>
     <p class="simpara">
      当请求的键（或多个键）不在缓存中时返回的值，自 yac 2.4.0 起可用。省略时，未命中返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
     </p>
     <blockquote class="note"><p><strong class="note">注意</strong>: 
      <p class="simpara">
       在 yac 2.4.0 之前，该参数位置是一个引用形式的
       <code class="literal">$cas</code> 令牌，而不是默认值。传递过或依赖该令牌的代码在升级到 2.4.0 时必须更新。
      </p>
     </p></blockquote>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-yac.get-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   对于 <span class="type"><a href="language.types.string.php" class="type string">string</a></span> 类型的键，命中时返回缓存的值，否则返回 <code class="parameter">default</code>（未指定默认值时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>）。
  </p>
  <p class="simpara">
   对于由键组成的 <span class="type"><a href="language.types.array.php" class="type array">array</a></span>，返回一个数组，其中包含所有命中的值，以各自的键为索引。自 yac 2.4.0 起，不在缓存中的键会被直接忽略（若指定了 <code class="parameter">default</code>，则用默认值填充）；在 2.4.0 之前，每个缺失的键都会插入一个 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> 占位值。
  </p>
 </div>



 <div class="refsect1 examples" id="refsect1-yac.get-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="methodname"><strong>Yac::get()</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">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</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: #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">"foo"</span><span style="color: #007700">));                 </span><span style="color: #FF8000">// string(3) "bar"
</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">"missing"</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-2">
   <p><strong>示例 #2 区分存进去的 false 和未命中</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">// 没有默认值时，未命中和存了 false 无法区分；
// 哨兵默认值（自 yac 2.4.0 起可用）可以区分二者
</span><span style="color: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">"flag"</span><span style="color: #007700">, </span><span style="color: #0000BB">false</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">"flag"</span><span style="color: #007700">));                </span><span style="color: #FF8000">// bool(false)：存的就是这个值
</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">"missing"</span><span style="color: #007700">, </span><span style="color: #0000BB">false</span><span style="color: #007700">));      </span><span style="color: #FF8000">// bool(false)：未命中，形态相同
</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">"flag"</span><span style="color: #007700">, </span><span style="color: #DD0000">"__NONE__"</span><span style="color: #007700">));    </span><span style="color: #FF8000">// bool(false)：存的就是这个值
</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">"missing"</span><span style="color: #007700">, </span><span style="color: #DD0000">"__NONE__"</span><span style="color: #007700">)); </span><span style="color: #FF8000">// string(8) "__NONE__"：未命中
</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: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</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: #0000BB">$yac</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">set</span><span style="color: #007700">(</span><span style="color: #DD0000">"foo2"</span><span style="color: #007700">, </span><span style="color: #DD0000">"bar2"</span><span style="color: #007700">);

</span><span style="color: #FF8000">// 传入键数组时，结果中只包含命中的键
</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">(array(</span><span style="color: #DD0000">"foo"</span><span style="color: #007700">, </span><span style="color: #DD0000">"foo2"</span><span style="color: #007700">, </span><span style="color: #DD0000">"missing"</span><span style="color: #007700">)));
</span><span style="color: #FF8000">// array(2) { ["foo"]=&gt; string(3) "bar" ["foo2"]=&gt; string(4) "bar2" }
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yac.get-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.getter.php" class="methodname" rel="rdfs-seeAlso">Yac::__get()</a> - 以属性语法取值</span></li>
   </ul>
  </p>
 </div>


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