Using Joomla Ajax Interface/fr

Qu'est-ce que l'interface Ajax de Joomla! (com_ajax) ?

C'est un composant léger et extensible qui agit comme un point d'entrée pour les requêtes HTTP pour les modules autonomes et les plug-ins, permettant ainsi de bénéficier du potentiel des fonctionnalités Ajax. Com_ajax est généralement utilisé lorsque vous n'êtes pas le développeur du composant en interaction avec le module ou plug-in utilisé.

NOTE : si vous êtes développeur de composants, il ne vous est pas nécessaire d'utiliser com_ajax afin d'y implémenter les fonctionnalités Ajax. Vous pouvez le faire directement dans votre composant.

Les exemples de cas d'utilisation incluent, (liste non exhaustive) :

• un module qui récupère des données à partir d'une API externe,
• un module qui interagit avec un composant que vous n'avez pas développé vous-même,
• un plugin qui implémentent l'API comme des fonctionnalités permettant l'utilisation de données à partir de votre site.

Anatomie d'une requête Ajax

Requis

• option=com_ajax
• [module|plugin]=name
• format=[json|debug|raw]

Optionnel

• method=[custom fragment] par défaut, get si omis.

Vue d'ensemble

All requests begin with ?option=com_ajax, which calls this extension, and must indicate the type of extension to call, and the data format to be returned.

Additional variables and values used by your extension may also be included in the URL.

For example, a request to ?option=com_ajax&module=session would call mod_session with results returned in the default format. In contrast,?option=com_ajax&plugin=session&format=json would trigger the onAjaxSession plugin group with results returned in JSON.

Module de support

Résumé

Module support is accomplished by calling a method in the module's helper.php file.

Détails

Module requests must include the module variable in the URL, paired with the name of the module (i.e. module=session for mod_session).

This value is also used for:

• The name of the directory to check for the helper file, e.g. /modules/mod_session/helper.php

• The class name to call, e.g. modSessionHelper

Optionally, the method variable may be included to override the default method prefix of get.

NOTE: All methods must end in Ajax. For example:

method=mySuperAwesomeMethodToTrigger appellera mySuperAwesomeMethodToTriggerAjax

The Ajax Session Module is an example module that demonstrates this functionality.

Plug-in de réponse

Résumé

Plugin support is accomplished by triggering the onAjax[Name] plugin event.

Détails

Plugin requests must include the plugin variable in the URL, paired with the name of the plugin event, e.g. plugin=session for onAjaxSession.

This value is also used for:

• The plugin class name following the plgAjax[Name] convention.
• The plugin function name following the onAjax[Name] convention.

The Ajax Latest Articles plugin is an example plugin that demonstrates this functionality.

Format de réponse

format=[json|debug] is an optional argument for the results format:

• json for JSON format
• debug for human-readable output of the results.