Using Joomla Ajax Interface/nl: Difference between revisions

From Joomla! Documentation

Created page with "De Joomla Ajax interface gebruiken"
 
Created page with "AJAX JavaScript Ontwikkeling"
 
(38 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude><languages /></noinclude>
<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=3.2|time=and after|comment=series}}</noinclude>
<noinclude>{{Joomla version|version=3.2|time=and after|comment=serie}}</noinclude>
{{-}}
{{-}}
==What is The Joomla Ajax Interface (com_ajax)==
==Wat is de 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.
Een slanke, uitbreidbaar component dat gebruikt wordt als startpunt voor HTTP requests voor op zich zelf staande modules en plugins om zo de potentie van de Ajax-functionaliteit daarin te gebruiken. Com_ajax wordt normaal gebruikt wanneer je niet de ontwikkelaar van het component bent waar de module of plugin mee samenwerkt.


'''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.
'''OPMERKING''': Als u een component ontwikkelaar bent hoeft u niet com_ajax te gebruiken implementeren om van de Ajax-functionaliteit gebruikt te maken. U kunt direct in uw component doen.


Examples of use cases include, but are not limited to:
Voorbeelden van gebruik maar niet gelimiteerd tot:
*A module that retrieves data from an external API
*Een module die data ophaalt van een externe API
*A module that interacts with a component that you did not develop
*Een module interactie heeft met een component die u zelf niet ontwikkeld hebt
*A plugin that implement API like functionality to allow consumption of data from your site
*Een plugin die API-functionaliteit implementeert om datagebruik van uw website toe te staan


==Anatomy of an Ajax Request==
==De anatomie van een Ajax request==


===Required===
===Verplicht===


*<code>option=com_ajax</code>
*<code>option=com_ajax</code>
Line 20: Line 20:
*<code>format=[json|debug|raw]</code>
*<code>format=[json|debug|raw]</code>


===Optional===
===Optioneel===
*<code>method=[custom fragment]</code> defaults to <code>get</code> if omitted.
*<code>method=[custom fragment]</code> wordt standaard <code>get</code> bij gebruik.


===Overview===
===Overzicht===
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.
Alle verzoeken beginnen met <code>?option=com_ajax</code> die deze extensie aanroept en moet de type extensie benoemen en de gegevensindeling die geretourneerd moet worden.


Additional variables and values used by your extension may also be included in the URL.
Extra variabelen en waarden die door uw extensie gebruikt worden mogen ook in de URL opgenomen worden.


For example, a request to <code>?option=com_ajax&amp;module=session</code> would call <code>mod_session</code> with results returned in the default format. In contrast,<code>?option=com_ajax&amp;plugin=session&amp;format=json</code> would trigger the <code>onAjaxSession</code> plugin group with results returned in JSON.
Bijvoorbeeld, een verzoek om <code>?option=com_ajax&amp;module=session</code> zal <code>mod_session</code> aanroepen met de resultaten in de standaardopmaak geretourneerd. In contrast, <code>?option=com_ajax&amp;plugin=session&amp;format=json</code> zal <code>onAjaxSession</code> aanroepen waarin de resultaten in JSON geretourneerd worden.


==Module Support==
==Module ondersteuning==


===Summary===
===Samenvatting===


Module support is accomplished by calling a method in the module's <code>helper.php</code> file.
Module-ondersteuning wordt volbracht door een methode aan te roepen in het  <code>helper.php</code> modulebestand


===Details===
===Details===


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>).
Verzoeken vanuit een module moeten de <code>module</code>variabele in de URL bevatten, gecombineerd met de naam van de module. (b.v. <code>module=session</code> voor <code>mod_session</code>).


This value is also used for:
De waarde wordt ook gebruikt voor:


*The name of the directory to check for the helper file, e.g. <code>/modules/mod_session/helper.php</code>
*De naam van de map om het helper-bestand te vinden, b.v. <code>/modules/mod_session/helper.php</code>


*The class name to call, e.g. <code>modSessionHelper</code>
*De naam van de class om aan te roepen, b.v. <code>modSessionHelper</code>


Optionally, the <code>method</code> variable may be included to override the default method prefix of <code>get</code>.
Eventueel kan de <code>method</code> variabele worden opgenomen om een override te maken voor de standaard voorvoegsel van <code>get</code>


:'''NOTE''': All methods must end in <code>Ajax</code>. For example:
:'''OPMERKING''': Alle methodes moeten eindigen met <code>Ajax</code>. Bijvoorbeeld:
:<code>method=mySuperAwesomeMethodToTrigger</code> will call <code>mySuperAwesomeMethodToTriggerAjax</code>
:<code>method=mySuperAwesomeMethodToTrigger</code> zal aanroepen <code>mySuperAwesomeMethodToTriggerAjax</code>


The [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax Session Module] is an example module that demonstrates this functionality.
De [https://github.com/Joomla-Ajax-Interface/Ajax-Session-Module Ajax sessie module] is een voorbeeldmodule die deze functionaliteit laat zien.


==Plugin Response==
==Plugin reactie==


===Summary===
===Samenvatting===


Plugin support is accomplished by triggering the <code>onAjax[Name]</code> plugin event.
Plugin-ondersteuning wordt bereikt door de <code>onAjax[Name]</code> aan te roepen in de plugin event.


===Details===
===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>.
Plugin-verzoeken moeten <code>plugin</code> variabele in de URL bevatten, gecombineerd met de naam van de plugin-event, b.v. <code>plugin=session</code> voor <code>onAjaxSession</code>.


This value is also used for:
Deze waarde wordt ook gebruik voor:


*The plugin class name following the <code>plgAjax[Name]</code> convention.
*De plugin-class naam zoals in de <code>plgAjax[Name]</code> is bepaald.
*The plugin function name following the <code>onAjax[Name]</code> convention.
*De plugin-function naam zoals in de <code>plgAjax[Name]</code> is bepaald.
*The default plugin group is <code>ajax</code>. You can change it specifying the <code>group</code> request parameter. (From Joomla! 3.4)
*De standaard plugin-groep is <code>ajax</code>. U kan deze wijzigen door de <code>group</code> parameter te specificeren. (Vanaf 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.
De [https://github.com/Joomla-Ajax-Interface/Ajax-Latest-Articles Ajax Recente artikelen plugin] is een voorbeeld-plugin die deze functionaliteit demonstreert.


==Response Format==
==Opmaak reactie==


<code>format=[json|debug]</code> is an optional argument for the results format:
<code>format=[json|debug]</code> is een optioneel argument voor de opmaak van het resultaat.


*<code>json</code> for JSON format
*<code>json</code> voor JSON opmaak
*<code>debug</code> for human-readable output of the results.
*<code>debug</code> voor leesbare output van de resultaten.


[[Category:AJAX]]
[[Category:AJAX/nl|AJAX]]
[[Category:JavaScript]]
[[Category:JavaScript/nl|JavaScript]]
[[Category:Development]]
[[Category:Development/nl|Ontwikkeling]]

Latest revision as of 11:07, 23 January 2016

Joomla! 
≥ 3.2
serie

Wat is de Joomla Ajax interface (com_ajax)

Een slanke, uitbreidbaar component dat gebruikt wordt als startpunt voor HTTP requests voor op zich zelf staande modules en plugins om zo de potentie van de Ajax-functionaliteit daarin te gebruiken. Com_ajax wordt normaal gebruikt wanneer je niet de ontwikkelaar van het component bent waar de module of plugin mee samenwerkt.

OPMERKING: Als u een component ontwikkelaar bent hoeft u niet com_ajax te gebruiken implementeren om van de Ajax-functionaliteit gebruikt te maken. U kunt direct in uw component doen.

Voorbeelden van gebruik maar niet gelimiteerd tot:

  • Een module die data ophaalt van een externe API
  • Een module interactie heeft met een component die u zelf niet ontwikkeld hebt
  • Een plugin die API-functionaliteit implementeert om datagebruik van uw website toe te staan

De anatomie van een Ajax request

Verplicht

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

Optioneel

  • method=[custom fragment] wordt standaard get bij gebruik.

Overzicht

Alle verzoeken beginnen met ?option=com_ajax die deze extensie aanroept en moet de type extensie benoemen en de gegevensindeling die geretourneerd moet worden.

Extra variabelen en waarden die door uw extensie gebruikt worden mogen ook in de URL opgenomen worden.

Bijvoorbeeld, een verzoek om ?option=com_ajax&module=session zal mod_session aanroepen met de resultaten in de standaardopmaak geretourneerd. In contrast, ?option=com_ajax&plugin=session&format=json zal onAjaxSession aanroepen waarin de resultaten in JSON geretourneerd worden.

Module ondersteuning

Samenvatting

Module-ondersteuning wordt volbracht door een methode aan te roepen in het helper.php modulebestand

Details

Verzoeken vanuit een module moeten de modulevariabele in de URL bevatten, gecombineerd met de naam van de module. (b.v. module=session voor mod_session).

De waarde wordt ook gebruikt voor:

  • De naam van de map om het helper-bestand te vinden, b.v. /modules/mod_session/helper.php
  • De naam van de class om aan te roepen, b.v. modSessionHelper

Eventueel kan de method variabele worden opgenomen om een override te maken voor de standaard voorvoegsel van get

OPMERKING: Alle methodes moeten eindigen met Ajax. Bijvoorbeeld:
method=mySuperAwesomeMethodToTrigger zal aanroepen mySuperAwesomeMethodToTriggerAjax

De Ajax sessie module is een voorbeeldmodule die deze functionaliteit laat zien.

Plugin reactie

Samenvatting

Plugin-ondersteuning wordt bereikt door de onAjax[Name] aan te roepen in de plugin event.

Details

Plugin-verzoeken moeten plugin variabele in de URL bevatten, gecombineerd met de naam van de plugin-event, b.v. plugin=session voor onAjaxSession.

Deze waarde wordt ook gebruik voor:

  • De plugin-class naam zoals in de plgAjax[Name] is bepaald.
  • De plugin-function naam zoals in de plgAjax[Name] is bepaald.
  • De standaard plugin-groep is ajax. U kan deze wijzigen door de group parameter te specificeren. (Vanaf Joomla! 3.4)

De Ajax Recente artikelen plugin is een voorbeeld-plugin die deze functionaliteit demonstreert.

Opmaak reactie

format=[json|debug] is een optioneel argument voor de opmaak van het resultaat.

  • json voor JSON opmaak
  • debug voor leesbare output van de resultaten.