<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.yaf-request-abstract.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'yaf-request-abstract.isxmlhttprequest.php',
    1 => 'Yaf_Request_Abstract::isXmlHttpRequest',
    2 => '判断请求是否是 AJAX 请求',
  ),
  'up' => 
  array (
    0 => 'class.yaf-request-abstract.php',
    1 => 'Yaf_Request_Abstract',
  ),
  'prev' => 
  array (
    0 => 'yaf-request-abstract.isrouted.php',
    1 => 'Yaf_Request_Abstract::isRouted',
  ),
  'next' => 
  array (
    0 => 'yaf-request-abstract.setactionname.php',
    1 => 'Yaf_Request_Abstract::setActionName',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/yaf/yaf_request_abstract/isxmlhttprequest.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="yaf-request-abstract.isxmlhttprequest" class="refentry">
 <div class="refnamediv">
<h1 class="refname">Yaf_Request_Abstract::isXmlHttpRequest</h1>
<p class="verinfo">(Yaf &gt;=1.0.0)</p><p class="refpurpose"><span class="refname">Yaf_Request_Abstract::isXmlHttpRequest</span> &mdash; <span class="dc-title">判断请求是否是 AJAX 请求</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-yaf-request-abstract.isxmlhttprequest-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_Request_Abstract::isXmlHttpRequest</strong></span>(): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="simpara">通过检查 HTTP_X_REQUESTED_WITH 请求头来判断请求是否是 Ajax 请求。</p>
  <blockquote class="note"><p><strong class="note">注意</strong>: 
   <p class="simpara">
    <span class="classname"><a href="class.yaf-request-simple.php" class="classname">Yaf_Request_Simple</a></span> 重写了该方法并始终返回
    <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>，因为命令行请求不可能是 Ajax 请求。
   </p>
  </p></blockquote>
 </div>


 <div class="refsect1 parameters" id="refsect1-yaf-request-abstract.isxmlhttprequest-parameters">
  <h3 class="title">参数</h3>
  <p class="simpara">此函数没有参数。</p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-yaf-request-abstract.isxmlhttprequest-returnvalues">
  <h3 class="title">返回值</h3>
<p class="simpara">如果请求是 Ajax 请求（<code class="literal">X-Requested-With</code> 头等于 <code class="literal">XMLHttpRequest</code>）则返回 <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-request-abstract.isxmlhttprequest-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 <span class="methodname"><strong>Yaf_Request_Abstract::isXmlHttpRequest()</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">ProductController </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">viewAction</span><span style="color: #007700">()
    {
        </span><span style="color: #FF8000">// 假设请求携带了 "X-Requested-With: XMLHttpRequest"
        </span><span style="color: #007700">if (</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">isXmlHttpRequest</span><span style="color: #007700">()) {
            </span><span style="color: #0000BB">$this</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">getResponse</span><span style="color: #007700">()
                 -&gt;</span><span style="color: #0000BB">setHeader</span><span style="color: #007700">(</span><span style="color: #DD0000">"Content-Type"</span><span style="color: #007700">, </span><span style="color: #DD0000">"application/json"</span><span style="color: #007700">)
                 -&gt;</span><span style="color: #0000BB">setBody</span><span style="color: #007700">(</span><span style="color: #0000BB">json_encode</span><span style="color: #007700">([</span><span style="color: #DD0000">"id" </span><span style="color: #007700">=&gt; </span><span style="color: #0000BB">17</span><span style="color: #007700">, </span><span style="color: #DD0000">"name" </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">"Yaf in Action"</span><span style="color: #007700">]));
            return </span><span style="color: #0000BB">false</span><span style="color: #007700">;
        }
    }
}
</span><span style="color: #0000BB">?&gt;</span></code></pre></div>
   </div>

   <div class="example-contents"><p>以上示例的输出类似于：</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">{&quot;id&quot;:17,&quot;name&quot;:&quot;Yaf in Action&quot;}</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-yaf-request-abstract.isxmlhttprequest-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="methodname"><a href="yaf-request-abstract.isget.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isGet()</a> - 判断请求是否是 GET 请求</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.ispost.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isPost()</a> - 判断请求是否是 POST 请求</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.isput.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isPut()</a> - 判断请求是否是 PUT 请求</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.ishead.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isHead()</a> - 判断请求是否是 HEAD 请求</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.isoptions.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isOptions()</a> - 判断请求是否是 OPTIONS 请求</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.isdelete.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isDelete()</a> - 判断请求是否为 DELETE 请求</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.ispatch.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isPatch()</a> - 判断请求是否为 PATCH 请求</span></li>
   <li><span class="methodname"><a href="yaf-request-abstract.iscli.php" class="methodname" rel="rdfs-seeAlso">Yaf_Request_Abstract::isCli()</a> - 判断请求是否是 CLI 请求</span></li>
  </ul>
 </div>

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