Yaf_Request_Abstract::isXmlHttpRequest

(Yaf >=1.0.0)

Yaf_Request_Abstract::isXmlHttpRequest — Détermine si la requête est une requête Ajax

Description

public function Yaf_Request_Abstract::isXmlHttpRequest(): bool

Vérifie si la requête est une requête Ajax en inspectant l'en-tête de requête HTTP_X_REQUESTED_WITH.

Note:
Yaf_Request_Simple redéfinit cette méthode et retourne toujours false, car les requêtes en ligne de commande ne sont jamais des requêtes Ajax.

Liste de paramètres

Cette fonction ne contient aucun paramètre.

Valeurs de retour

Retourne true si la requête est une requête Ajax (l'en-tête X-Requested-With vaut XMLHttpRequest), false sinon.

Exemples

Exemple #1 Exemple avec Yaf_Request_Abstract::isXmlHttpRequest()

<?php
class ProductController extends Yaf_Controller_Abstract
{
    public function viewAction()
    {
        // En supposant que la requête porte "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;
        }
    }
}
?>

Résultat de l'exemple ci-dessus est similaire à :

{"id":17,"name":"Yaf in Action"}

Voir aussi

Yaf_Request_Abstract::isGet() - Détermine si la requête est une requête GET
Yaf_Request_Abstract::isPost() - Détermine si la requête est une requête POST
Yaf_Request_Abstract::isPut() - Détermine si la requête est une requête PUT
Yaf_Request_Abstract::isHead() - Détermine si la requête est une requête HEAD
Yaf_Request_Abstract::isOptions() - Détermine si la requête est une requête OPTIONS
Yaf_Request_Abstract::isDelete() - Détermine si la requête est une requête DELETE
Yaf_Request_Abstract::isPatch() - Détermine si la requête est une requête PATCH
Yaf_Request_Abstract::isCli() - Détermine si la requête est une requête CLI