Comment faire une requête Ajax en Composant Joomla

Ne vont pas à l'abandon ou à mourir, Joomla! a c'est une très belle façon de traiter avec ce genre de choses.

Les réponses ci-dessous sont testés dans Joomla! 2.5 & 3 (pour 1.5. peut travailler aussi bien).

---

Général

Votre URL pour la tâche doit ressembler à ceci:

index.php?option=com_similar&task=abc&format=raw

Vous de créer le contrôleur qui va utiliser la vue, disons Abc, qui contiendra le fichier view.raw.html (identique à l'affichage normal de fichier).

Vous trouverez ci-dessous le code pour générer un code HTML brut réponse:

/controller.php

public function abc() 
{
    //Set view
    JRequest::setVar('view', 'Abc');
    parent::display();
}

/views/abc/view.raw.php

<?php
defined('_JEXEC') or die;

jimport('joomla.application.component.view');

class SimilarViewAbc extends JView
{
    function display($tpl = null)
    {
        parent::display($tpl);
    }
}

/views/abc/tmpl/default.php

<?php

echo "Hello World from /views/abc/tmpl/default.php";

Remarque: C'est la solution que j'utiliserais si je devais renvoyer le code HTML (c'est plus propre et suit Joomla logique). Pour le retour de simples données JSON, voir ci-dessous comment tout mettre dans le contrôleur.

---

Si vous faites votre requête Ajax à un subcontroller, comme:

index.php?option=com_similar&controller=abc&format=raw

Que votre subcontroller nom (pour la vue brute) doit être abc.raw.php.

Cela signifie également que vous /peut avoir 2 subcontrollers nommée Abc.

Si vous le retour JSON, il peut être judicieux d'utiliser format=json et abc.json.php. Dans Joomla 2.5. J'ai eu quelques problèmes à obtenir que cette option fonctionne (en quelque sorte la sortie a été corrompu), j'ai donc utilisé des matières premières.

---

Si vous avez besoin de générer une réponse JSON valide, découvrez les docs page Générer la sortie JSON

//We assume that the whatver you do was a success.
$response = array("success" => true);
//You can also return something like:
$response = array("success" => false, "error"=> "Could not find ...");

//Get the document object.
$document = JFactory::getDocument();

//Set the MIME type for JSON output.
$document->setMimeEncoding('application/json');

//Change the suggested filename.
JResponse::setHeader('Content-Disposition','attachment;filename="result.json"');

echo json_encode($response);

Vous aurait généralement mis ce code dans le contrôleur (que vous appelez un modèle qui permettra de renvoyer les données de l'encodage - un scénario très commun). Si vous avez besoin d'aller plus loin, vous pouvez également créer un JSON (vue de view.json.php), similaire à cru exemple.

---

De sécurité

Maintenant que la requête Ajax est au travail, ne fermez pas la page encore. Lire ci-dessous.

N'oubliez pas de vérifier la demande de faux. JSession::checkToken() venir dans maniable ici. Lire la documentation sur la Façon d'ajouter CSRF contre l'usurpation d'identité à des formes

---

Sites multilingues

Il peut arriver que si vous n'envoyez pas le nom de la langue dans la demande, Joomla ne pas traduire les chaînes de langue que vous voulez.

Envisager d'inclure quelque sorte, de la lang param votre demande (comme &lang=de).

---

Nouveau dans Joomla 3.2! - Joomla! Interface Ajax

Joomla offre désormais une légère façon de traiter une requête Ajax dans un plugin ou un module. Vous souhaiterez peut-être utiliser le Joomla! Interface Ajax si vous n'avez pas déjà un composant ou si vous avez besoin de faire des demandes à partir d'un module de votre ont déjà.

OriginalL'auteur