Plugin Events

onJCarCategoriesRetrieve

Description

Gets a list of categories from the archive source.

Parameters

None

Return Value

An array of category objects.

The variable names of each object in the array are determined by the source archive but it is recommended that at a minimum each object must have the following fields specified:

  • id
  • name
  • description

In addition to these fields, the following are not mandatory but are recommended:

  • introduction
  • copyright

onJCarCategoryRetrieve

Description

Gets a single category and its items.

It is recommended that items are paged using JPagination and returned as part of the return value.

Parameters

  • id The id of the category to retrieve. The id must be prefixed with the name of the plugin. For example, if the plugin is called PlgJCarMyArchive, and the category id is 123, the id passed to this event must be myarchive:123.

Return Value

onJCarItemRetrieve

Description

Gets a single item.

Parameters

Return Value

onJCarAssetRetrieve

Description

Gets a single asset.

Parameters

Return Value

results matching ""

    No results matching ""