Yaf_Request_Abstract::isXmlHttpRequest
PHP function
Edit on GitHub ✎
(Yaf >=1.0.0)
Determine if the request is an Ajax request
Description
Yaf_Request_Abstract::isXmlHttpRequest(): bool
Checks whether the request is an Ajax request by inspecting the HTTP_X_REQUESTED_WITH request header.
Note
Yaf_Request_Simple overrides this method and always returns false, since command-line requests are never Ajax requests.
Parameters Parameters
Return Values
Returns true if the request is an Ajax request (the X-Requested-With header equals XMLHttpRequest), false otherwise.
Examples
Yaf_Request_Abstract::isXmlHttpRequest example
php
<?php
class ProductController extends Yaf_Controller_Abstract
{
public function viewAction()
{
// Assuming the request carries "X-Requested-With: XMLHttpRequest"
if ($this->getRequest()->isXmlHttpRequest()) {
$this->getResponse()
->setHeader("Content-Type", "application/json")
->setBody(json_encode(["id" => 17, "name" => "Yaf in Action"]));
return false;
}
}
}
?>The above example will output something similar to:
output
{"id":17,"name":"Yaf in Action"}See Also
Yaf_Request_Abstract::isGetYaf_Request_Abstract::isPostYaf_Request_Abstract::isPutYaf_Request_Abstract::isHeadYaf_Request_Abstract::isOptionsYaf_Request_Abstract::isDeleteYaf_Request_Abstract::isPatchYaf_Request_Abstract::isCli