Vues JSON et XML¶

Activation des vues de données dans votre application¶

Avant que vous puissiez utiliser les classes de vue de données, vous aurez besoin de faire un peu de configuration:

1. Activez les extensions json et/ou xml avec Router::parseExtensions(). Cela permettra au Router de gérer les multiples extensions.

2. Ajoutez le RequestHandlerComponent à la liste de components de votre controller. Cela activera automatiquement le changement de la classe de vue pour les types de contenu.

Après avoir ajouté Router::parseExtensions('json'); à votre fichier de routes, CakePHP changera automatiquement les classes de vue quand une requête sera faite avec l’extension .json, ou quand l’en-tête Accept sera application/json.

Utilisation des vues de données avec la clé _serialize¶

La clé _serialize est une variable de vue spéciale qui indique quel autre(s) variable(s) de vue devraient être sérialisée(s) quand on utilise la vue de données. Cela vous permet de sauter la définition des fichiers de vue pour vos actions de controller si vous n’avez pas besoin de faire un formatage avant que vos données ne soient converties en json/xml.

Si vous avez besoin de faire tout type de formatage ou de manipulation de vos variables de vue avant la génération de la réponse, vous devrez utiliser les fichiers de vue. La valeur de _serialize peut être soit une chaîne de caractère, soit un tableau de variables de vue à sérialiser:

class PostsController extends AppController {
    public $components = array('RequestHandler');

    public function index() {
        $this->set('posts', $this->Paginator->paginate());
        $this->set('_serialize', array('posts'));
    }
}

Vous pouvez aussi définir _serialize en tableau de variables de vue à combiner:

class PostsController extends AppController {
    public $components = array('RequestHandler');

    public function index() {
        // some code that created $posts and $comments
        $this->set(compact('posts', 'comments'));
        $this->set('_serialize', array('posts', 'comments'));
    }
}

Définir _serialize en tableau a le bénéfice supplémentaire d’ajouter automatiquement un elément de top-niveau <response> en utilisant XmlView. Si vous utilisez une valeur de chaîne de caractère pour _serialize et XmlView, assurez-vous que vos variables de vue aient un elément unique de top-niveau. Sans un elément de top-niveau, le Xml ne pourra être généré.

Utilisation d’une vue de données avec les fichiers de vue¶

Vous devriez utiliser les fichiers de vue si vous avez besoin de faire des manipulations du contenu de votre vue avant de créer la sortie finale. Par exemple, si vous avez des posts, qui ont un champ contenant du HTML généré, vous aurez probablement envie d’omettre ceci à partir d’une réponse JSON. C’est une situation où un fichier de vue est utile:

// Code du controller
class PostsController extends AppController {
    public function index() {
        $this->set(compact('posts', 'comments'));
    }
}

// Code de la vue - app/View/Posts/json/index.ctp
foreach ($posts as &$post) {
    unset($post['Post']['generated_html']);
}
echo json_encode(compact('posts', 'comments'));

Vous pouvez faire des manipulations encore beaucoup plus complexes, comme utiliser les helpers pour formater.

class XmlView¶

Une classe de vue pour la génération de vue de données Xml. Voir au-dessus pour savoir comment vous pouvez utiliser XmlView dans votre application

Par défaut quand on utilise _serialize, XmlView va enrouler vos variables de vue sérialisées avec un noeud <response>. Vous pouvez définir un nom personnalisé pour ce noeud en utilisant la variable de vue _rootNode.

Nouveau dans la version 2.3: La fonctionnalité _rootNode a été ajoutée.

class JsonView¶

Une classe de vue pour la génération de vue de données Json. Voir au-dessus pour savoir comment vous pouvez utiliser XmlView dans votre application.

JSONP response¶

Quand vous utilisez JsonView, vous pouvez utiliser la variable de vue spéciale _jsonp pour permettre de retourner une réponse JSONP. La définir à true fait que la classe de vue vérifie si le paramètre de chaine de la requête nommée « callback » est définie et si c’est la cas, permet d’enrouler la réponse json dans le nom de la fonction fournie. Si vous voulez utiliser un nom personnalisé de paramètre de requête à la place de « callback », définissez _jsonp avec le nom requis à la place de true.