<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-session.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'yaf-session.del.php',
    1 => 'Yaf_Session::del',
    2 => '删除会话键',
  ),
  'up' => 
  array (
    0 => 'class.yaf-session.php',
    1 => 'Yaf_Session',
  ),
  'prev' => 
  array (
    0 => 'yaf-session.current.php',
    1 => 'Yaf_Session::current',
  ),
  'next' => 
  array (
    0 => 'yaf-session.get.php',
    1 => 'Yaf_Session::get',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yaf/yaf_session/del.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-session.del" class="refentry">
 <div class="refnamediv">
<h1 class="refname">Yaf_Session::del</h1>
<p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Session::del</span> &mdash; <span class="dc-title">删除会话键</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-session.del-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">function</span> <span class="methodname"><strong>Yaf_Session::del</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">删除会话键及其对应的值。</p>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-session.del-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">name</code></dt>
    <dd>
<p class="simpara">要删除的会话键。</p>
    </dd>
   
  </dl>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-yaf-session.del-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>。</p>
 </div>


 <div class="refsect1 examples" id="refsect1-yaf-session.del-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="methodname"><strong>Yaf_Session::del()</strong></span> 示例</strong></p>
   <div class="example-contents">
<div class="phpcode"><pre><code style="color: #000000"><span style="color: #0000BB">&lt;?php
</span><span style="color: #007700">class </span><span style="color: #0000BB">VerifyController </span><span style="color: #007700">extends </span><span style="color: #0000BB">Yaf_Controller_Abstract
</span><span style="color: #007700">{
    public function </span><span style="color: #0000BB">captchaAction</span><span style="color: #007700">()
    {
        </span><span style="color: #0000BB">$session </span><span style="color: #007700">= </span><span style="color: #0000BB">Yaf_Session</span><span style="color: #007700">::</span><span style="color: #0000BB">getInstance</span><span style="color: #007700">();
        </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">start</span><span style="color: #007700">();

        </span><span style="color: #0000BB">$expected </span><span style="color: #007700">= </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">get</span><span style="color: #007700">(</span><span style="color: #DD0000">"captcha_code"</span><span style="color: #007700">);

        </span><span style="color: #FF8000">// 一次性验证码：使用后立即删除
        </span><span style="color: #0000BB">$session</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">del</span><span style="color: #007700">(</span><span style="color: #DD0000">"captcha_code"</span><span style="color: #007700">);

        if (</span><span style="color: #0000BB">$expected </span><span style="color: #007700">=== </span><span style="color: #0000BB">null
            </span><span style="color: #007700">|| </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getRequest</span><span style="color: #007700">()-&gt;</span><span style="color: #0000BB">getPost</span><span style="color: #007700">(</span><span style="color: #DD0000">"code"</span><span style="color: #007700">) !== </span><span style="color: #0000BB">$expected</span><span style="color: #007700">) {
            echo </span><span style="color: #DD0000">"invalid captcha"</span><span style="color: #007700">;
        }
    }
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-session.del-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yaf-session.get.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::get()</a> - 获取会话值</span></li>
   <li><span class="methodname"><a href="yaf-session.set.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::set()</a> - 设置会话值</span></li>
   <li><span class="methodname"><a href="yaf-session.has.php" class="methodname" rel="rdfs-seeAlso">Yaf_Session::has()</a> - 检查会话键是否存在</span></li>
  </ul>
 </div>

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