AjaxHandler

N'écrivez plus ce switch .

Êtes-vous fatigué d'écrire encore et encore le même code de gestionnaire Ajax sur chacun de vos projets ? Il y a toujours les mêmes étapes et les mêmes problèmes, est-ce que la gestion des en-têtes est correcte ? Est-ce que ça fonctionnera avec jQuery ? Codes de statut ? JSONP ?

Eh bien, j'ai rassemblé tous les morceaux de code et créé l'AjaxHandler. C'est une classe PHP très simple dont vous pouvez hériter et créer facilement vos propres gestionnaires Ajax.

Caractéristiques

Voici une liste des fonctionnalités fournies par Ajax Handler

• Sortie unifiée Chaque requête Ajax produira une sortie JSON standard, de sorte que votre code client sera plus simple et compréhensible. Les sorties ne sont gérées que par les méthodes ::error et ::success. Vous n'aurez jamais à utiliser json_encode lors de la sortie.
• Gestion des erreurs AjaxHandler détectera automatiquement les exceptions et les erreurs PHP et les gérera pour vous. Vous pouvez personnaliser les messages d'erreur et modifier les codes d'état
• Prise en charge JSONP Le gestionnaire Ajax traitera automatiquement les demandes avec des paramètres de rappel, vous pouvez personnaliser le nom et le type de rappel
• La conception orientée objet Clean Code vous permettra de diviser facilement votre code en fichiers séparés. Ceci est particulièrement adapté aux projets Backbone tels que MVC.
• Le gestionnaire de statistiques Ajax conservera la durée de chaque requête et vous la renverra, afin que vous puissiez facilement mesurer les performances de vos codes.
• Code très simple Le code d'Ajax Handler est très simple et vous pouvez facilement le personnaliser en fonction de vos besoins.
• It's All Free Ajax Handler est un morceau de code sous licence MIT afin que vous puissiez l'utiliser pour vos propres projets

Voici un exemple très basique d'AjaxHandler utilisé, disons que c'est person.php

 <?php
include " AjaxHandler.php " ;
class Person extends AjaxHandler{
    
    /**
     * Private function will not be accessed from outside
     * @return Mongo Collection
     */
    private function getMongo (){
        $ m = new Mongo ();
        $ db = $ m -> selectDB ( ' main ' );
        $ cl = $ db -> selectCollection ( ' people ' );
        return $ cl ;
    }

    /**
     * All I write here is the code
     * I didn't write anything to handle output
     * If the code gives an exception, ajax 
     * handler will return error, If Everything is successfull
     * Standart success message will be returned
     * @return [type] [description]
     */
    public function createPerson (){
        
        $ db = $ this -> getMongo ();
        
        $ result = $ cl -> save ( array (
            " name " => $ this -> get ( ' name ' ),
            " age "  => $ this -> get ( ' age ' )
        ));
    }
    
    /**
     * Here is the code for handling your own messages
     * @return [type] [description]
     */
    public function getPersonDetails (){
        $ db = $ this -> getMongo ();

        $ cursor = $ db -> fetch ( array ( ' name ' => $ this -> get ( ' name ' )));

        if ( $ cursor -> count () === 0 ){
            // Will produce an error
            // {"success": false, "error": "Person cannot be found"}
            $ this -> error ( ' Person cannot be found ' );
        } else {
            // Will giveout a JSON success message
            // {
            //   "success": true, 
            //   "details":{"name":"john", "age":"29"}, 
            //   "message":"Operation successful"
            // }
            $ this -> success ( array (
                " details " => $ cursor -> first ()
            ));
        }
    }
}
?>

Vous pouvez facilement faire des requêtes avec jQuery

 $ . ajax ( {
    url : 'person.php' ,
    data : {
      action : 'createPerson' ,
      name : 'john' ,
      age : 29
    } ,
    dataType : 'json' ,
    complete : function ( res ) {
        if ( res . success ) {
            alert ( 'User Saved' ) ;
        } else {
            alert ( 'Error: ' + res . error ) ;
        }
    }
} ) ;

J'écrirai bientôt une documentation plus détaillée.