Déceler une requête Ajax en Php

Dorénavant les requêtes Ajax pleuvent de toute part. Il est très fréquent d'avoir à identifier une requête Ajax au niveau serveur pour adapter le contenu selon les cas. En effet, une portion de code pourra inclure un header et un footer lors de l'appel standard par un navigateur ou seulement être rafraichit telle quel lors de l'appel en Ajax.

Il n'existe pas de moyen automatique d'identifier ces requêtes. Les principales librairies javascript comme Prototype ou jQuery s'accordent pour envoyer un paramètre dans l'en-tête HTTP de la requête afin qu'elle puisse être reconnue. Ce paramètre est X-Requested-With : XMLHttpRequest. Tirons partie de cette information pour faire la fonction Php adéquate.

Lire l'en-tête HTTP renvoyée

La fonction qui suit est des plus simples. Les informations envoyées dans l'en-tête HTTP se récupèrent par la variable d'environnement PHP $_SERVER. Attention, en plus d'être en majuscule, toutes les informations de l'en-tête HTTP sont préfixés de HTTP_. Notre X-Requested-With se lira donc par $_SERVER['HTTP_X_REQUESTED_WITH']. Le reste coule de source.

Fonction Php de reconnaissance de la requête Ajax

<?php
/**  
 * Déceler une requête Ajax en Php
 * par Jay Salvat - http://blog.jaysalvat.com/  
 */  
function isAjax() {
    if (isset($_SERVER['HTTP_X_REQUESTED_WITH']) 
        && $_SERVER['HTTP_X_REQUESTED_WITH'] == "XMLHttpRequest") {
        return true;
    }
    return false;
}
?>

Et si je n'utilise pas de librairie Ajax ?

Il n'est pas toujours utile d'inclure une libraire de 20 à 50ko sur un petit projet ne nécessitant que quelques requêtes Ajax. La bonne vieille méthode fait encore ses preuves. Votre bout de javascript devrait ressembler à quelque chose comme suit. Il suffit d'y inclure le nouveau paramètre à passer dans l'en-tête pour que notre requête puisse également être identifiée au niveau serveur.

Ajouter un paramètre au header en javascript

<script type="text/javascript">
    var xhr;
    if(window.XMLHttpRequest)	{ 
        xhr = new XMLHttpRequest();
    } else if(window.ActiveXObject) { 
        xhr = new ActiveXObject("Microsoft.XMLHTTP");
    }
    xhr.open('post', 'ajax.php', true);

    // Ajouter une valeur au header
    xhr.setRequestHeader("X-Requested-With", "XMLHttpRequest");

    xhr.send(null);
</script>

Conclusion

ed la même maniètre, il est facile d'améliorer d'autres librairies ne renvoyant pas encore cette information. Par exemple, IUI ou WebApp.net dédiée aux applications iPhone ne semblent malheureusement pas encore s'être accordées de ce côté là.