Actions

Difference between revisions of "Using Joomla Ajax Interface"

From Joomla! Documentation

Line 1: Line 1:
 
<noinclude>{{version/tutor|3.2}}</noinclude>
 
<noinclude>{{version/tutor|3.2}}</noinclude>
 
<h1>What is The Joomla Ajax Interface (com_ajax)</h1>
 
<h1>What is The Joomla Ajax Interface (com_ajax)</h1>
<p>A slim, extensible component to act as an entry point for Ajax functionality in Joomla for stand alone modules and plugins. Examples of use cases include, but are not limited to:
+
<p>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.</p>
 +
<p><strong>NOTE</strong>: 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.</p>
 +
<p>Examples of use cases include, but are not limited to:
 
<ul>
 
<ul>
 
<li>A module that retrieves data from an external API</li>
 
<li>A module that retrieves data from an external API</li>
Line 8: Line 10:
 
</ul>
 
</ul>
 
</p>
 
</p>
<p><strong>NOTE</strong>: 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.</p>
+
 
 
<h1>Anatomy of an Ajax Request</h1>
 
<h1>Anatomy of an Ajax Request</h1>
  

Revision as of 09:16, 21 November 2013

What is The Joomla Ajax Interface (com_ajax)

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.

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.

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

Anatomy of an Ajax Request

Required

  • option=com_ajax
  • [module|plugin]=name

Optional

  • format=[json|debug] defaults to raw if omitted.
  • method=[custom fragment] defaults to get if omitted.

Overview

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 Support

Summary

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

Details

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 will call mySuperAwesomeMethodToTriggerAjax

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

Plugin Response

Summary

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

Details

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.

Response Format

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

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