VEUILLEZ NOTER QUE CETTE RÉPONSE date déjà de quelques années et n’a pas été mise à jour. N'hésitez pas à éditer / commenter si vous pensez que quelque chose n'est plus exact.
Abstrait
Il n’existe pratiquement pas de solution officielle à ce problème, cela dépend en grande partie de la complexité et de la mesure dans laquelle vous souhaitez vous appuyer sur le modèle MVC pour effectuer le travail.
Vous trouverez ci-dessous quelques solutions possibles à ce qui devrait fonctionner dans Joomla 2.5 et 3.x. Le code n'est pas présenté pour un travail copier-coller, mais plutôt comme une idée générale.
Avant Joomla! 3.2 la seule chose dont vous avez besoin pour utiliser les exemples ci-dessous est un component. Après Joomla 3.2 (pour les tâches moins complexes), vous pouvez gérer les requêtes des modules et des plugins.
Réponse HTML générique (suivant MVC hérité)
Votre URL pour la tâche doit ressembler à ceci:
index.php?option=com_similar&task=abc&format=raw
Vous créez ensuite le contrôleur qui utilisera la vue, par exemple Abc, qui contiendra le fichier view.raw.html (identique à un fichier de vue normale).
Vous trouverez ci-dessous le code permettant de générer une réponse HTML brute:
/controller.php
public function abc()
{
// Set view
// Joomla 2.5
JRequest::setVar('view', 'Abc');
// (use JInput in 3.x)
$this->input->set('view', 'Abc');
parent::display();
}
/views/abc/view.raw.php
<?php
defined('_JEXEC') or die;
jimport('joomla.application.component.view');
class SimilarViewAbc extends JViewLegacy
{
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 retourner du code HTML (il est plus propre et respecte la logique de Joomla). Pour renvoyer des données JSON simples, voir ci-dessous comment tout mettre dans le contrôleur.
Sous-contrôleurs
Si vous faites votre demande Ajax à un sous - contrôleur , par exemple:
index.php?option=com_similar&controller=abc&format=raw
Que le nom de votre sous-contrôleur (pour la vue brute) doit être abc.raw.php.
Cela signifie également que vous aurez / pourrez avoir 2 sous-contrôleurs nommés Abc.
Si vous retournez JSON, il peut être judicieux d'utiliser format=jsonet abc.json.php. Dans Joomla 2.5. J'ai eu quelques problèmes à faire fonctionner cette option (la sortie était corrompue), alors j'ai utilisé raw.
Réponse JSON valide (après le nouveau / ancien legacy MVC)
Si vous devez générer une réponse JSON valide , consultez la page de documentation Génération d'une 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 mettriez généralement ce code dans le contrôleur (vous appelerez un modèle qui renverra les données que vous encodez - un scénario très courant). Si vous avez besoin d'aller plus loin, vous pouvez également créer une vue JSON (view.json.php), similaire à l'exemple brut.
Sécurité
Maintenant que la requête Ajax fonctionne, ne fermez pas encore la page. Lire ci-dessous.
N'oubliez pas de vérifier les faux de demande. JSession::checkToken()être utile ici. Lisez la documentation sur Comment ajouter de l' anti-usurpation CSRF aux formulaires
Sites multilingues
Il peut arriver que si vous n'envoyez pas le nom de la langue dans la demande, Joomla ne traduira pas les chaînes de la langue souhaitée.
Pensez à ajouter en quelque sorte le paramètre lang à votre requête (du type &lang=de).
Joomla! Interface Ajax
Nouveau dans Joomla 3.2! - vous permet de faire des requêtes sans construire de composant
Joomla! Interface Ajax - Joomla fournit désormais un moyen léger de gérer les demandes Ajax dans un plugin ou un module. Vous voudrez peut-être utiliser le logiciel Joomla! Ajax Interface si vous ne possédez pas déjà de composant ou si vous devez faire des demandes à partir d'un module que vous avez déjà.