Joomla! Documentation - User contributions [en]

Using Joomla Ajax Interface

2015-05-26T13:27:37Z

Fede91it:

<noinclude><languages /></noinclude>
<noinclude>{{version/tutor|3.2}}</noinclude>
<translate>==What is The Joomla Ajax Interface (com_ajax)== </translate>
<translate>
A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. Com_ajax is generally used when you are not the developer of the component that the module or plugin is interacting with.</translate>

<translate>
'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.</translate>

<translate>
Examples of use cases include, but are not limited to:
*A module that retrieves data from an external API
*A module that interacts with a component that you did not develop
*A plugin that implement API like functionality to allow consumption of data from your site</translate>

<translate>==Anatomy of an Ajax Request== </translate>

<translate>===Required=== </translate>

*<code>option=com_ajax</code>
*<code>[module|plugin]=name</code>
*<code>format=[json|debug|raw]</code>

<translate>===Optional=== </translate>
*<code>method=[custom fragment]</code> <translate>
defaults to <code>get</code> if omitted.</translate>

<translate>===Overview=== </translate>
<translate>
All requests begin with <code>?option=com_ajax</code>, 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.</translate>

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

<translate>==Module Support== </translate>

<translate>===Summary=== </translate>

<translate>
Module support is accomplished by calling a method in the module's <code>helper.php</code> file.</translate>

<translate>===Details=== </translate>

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

<translate>
This value is also used for:


*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>


*The class name to call, e.g. <code>modSessionHelper</code></translate>

<translate>
Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.</translate>

:<translate>
'''NOTE''': All methods must end in <code>Ajax</code>. For example:</translate>
:<code>method=mySuperAwesomeMethodToTrigger</code> <translate>
will call</translate> <code>mySuperAwesomeMethodToTriggerAjax</code>

<translate>
The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.</translate>

<translate>==Plugin Response== </translate>

<translate>===Summary=== 


Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.</translate>

<translate>===Details=== 


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

<translate>
This value is also used for:


*The plugin class name following the <code>plgAjax[Name]</code> convention.
*The plugin function name following the <code>onAjax[Name]</code> convention.
*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter. (From Joomla 3.4)


The [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] is an example plugin that demonstrates this functionality.</translate>

<translate>==Response Format== </translate>

<translate>
<code>format=[json|debug]</code> is an optional argument for the results format:


*<code>json</code> for JSON format
*<code>debug</code> for human-readable output of the results.</translate>

<translate>
[[Category:AJAX]]
[[Category:JavaScript]]
[[Category:Development]]</translate>

Using Joomla Ajax Interface

2015-05-26T13:27:11Z

Fede91it:

<noinclude><languages /></noinclude>
<noinclude>{{version/tutor|3.2}}</noinclude>
<translate>==What is The Joomla Ajax Interface (com_ajax)== </translate>
<translate>
A slim, extensible component to act as an entry point for HTTP requests for stand alone modules and plugins, thus allowing for the potential of Ajax functionality in them. Com_ajax is generally used when you are not the developer of the component that the module or plugin is interacting with.</translate>

<translate>
'''NOTE''': If you are a component developer, you do not need to use com_ajax to implement Ajax functionality in it. You can do so directly in your component.</translate>

<translate>
Examples of use cases include, but are not limited to:
*A module that retrieves data from an external API
*A module that interacts with a component that you did not develop
*A plugin that implement API like functionality to allow consumption of data from your site</translate>

<translate>==Anatomy of an Ajax Request== </translate>

<translate>===Required=== </translate>

*<code>option=com_ajax</code>
*<code>[module|plugin]=name</code>
*<code>format=[json|debug|raw]</code>

<translate>===Optional=== </translate>
*<code>method=[custom fragment]</code> <translate>
defaults to <code>get</code> if omitted.</translate>

<translate>===Overview=== </translate>
<translate>
All requests begin with <code>?option=com_ajax</code>, 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.</translate>

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

<translate>==Module Support== </translate>

<translate>===Summary=== </translate>

<translate>
Module support is accomplished by calling a method in the module's <code>helper.php</code> file.</translate>

<translate>===Details=== </translate>

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

<translate>
This value is also used for:


*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>


*The class name to call, e.g. <code>modSessionHelper</code></translate>

<translate>
Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.</translate>

:<translate>
'''NOTE''': All methods must end in <code>Ajax</code>. For example:</translate>
:<code>method=mySuperAwesomeMethodToTrigger</code> <translate>
will call</translate> <code>mySuperAwesomeMethodToTriggerAjax</code>

<translate>
The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.</translate>

<translate>==Plugin Response== </translate>

<translate>===Summary=== 


Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.</translate>

<translate>===Details=== 


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

<translate>
This value is also used for:


*The plugin class name following the <code>plgAjax[Name]</code> convention.
*The plugin function name following the <code>onAjax[Name]</code> convention.
*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter.


The [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Latest Articles plugin] is an example plugin that demonstrates this functionality.</translate>

<translate>==Response Format== </translate>

<translate>
<code>format=[json|debug]</code> is an optional argument for the results format:


*<code>json</code> for JSON format
*<code>debug</code> for human-readable output of the results.</translate>

<translate>
[[Category:AJAX]]
[[Category:JavaScript]]
[[Category:Development]]</translate>