Actions

J1.5

Difference between revisions of "Plugin/Events/System"

From Joomla! Documentation

< J1.5:Plugin/Events
m (moved Reference:System Events for Plugin System to Plugin events/System: Moved page for consistency)
(Adjusted layout)
Line 1: Line 1:
[[Category:Development]]
 
[[Category:Plugins]]
 
===Overview===
 
 
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins.  For more information on plugins, check [[Plugin]], [[Creating a Plugin for Joomla 1.5]], [[How to create a content plugin]] etc.
 
In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins.  For more information on plugins, check [[Plugin]], [[Creating a Plugin for Joomla 1.5]], [[How to create a content plugin]] etc.
  
 
This topic is aimed at "global" system events, including those triggered on every page load (onAfterInitialise, onAfterRoute, onAfterDispatch, onAfterRender), those supporting search within multiple plugins (onSearch, onSearchArea) and those supporting the presentation of web services (onGetWebServices). Visit [[Plugin]] for a complete list over available core events.
 
This topic is aimed at "global" system events, including those triggered on every page load (onAfterInitialise, onAfterRoute, onAfterDispatch, onAfterRender), those supporting search within multiple plugins (onSearch, onSearchArea) and those supporting the presentation of web services (onGetWebServices). Visit [[Plugin]] for a complete list over available core events.
  
=== onAfterInitialise ===
+
== onAfterInitialise ==
 
'''Description'''
 
'''Description'''
  
Line 21: Line 18:
 
'''Called in files'''
 
'''Called in files'''
  
*index.php
+
*<tt>index.php</tt>
*administrator/index.php
+
*<tt>administrator/index.php</tt>
  
===onAfterRoute===
+
==onAfterRoute==
 
'''Description'''
 
'''Description'''
  
Line 43: Line 40:
 
'''Used in files'''
 
'''Used in files'''
  
* index.php
+
* <tt>index.php</tt>
* administrator/index.php
+
* <tt>administrator/index.php</tt>
  
===onAfterDispatch===
+
==onAfterDispatch==
 
'''Description'''
 
'''Description'''
 
This event is triggered after the framework has dispatched the application.
 
This event is triggered after the framework has dispatched the application.
Line 64: Line 61:
 
'''Used in files'''
 
'''Used in files'''
  
* index.php
+
* <tt>index.php</tt>
* administrator/index.php
+
* <tt>administrator/index.php</tt>
  
===onBeforeRender===
+
==onBeforeRender==
 
'''Description'''
 
'''Description'''
 
This event is triggered immediately before the framework has rendered the application.
 
This event is triggered immediately before the framework has rendered the application.
Line 83: Line 80:
 
'''Used in files'''
 
'''Used in files'''
  
* include/application.php
+
* <tt>include/application.php</tt>
* administrator/include/application.php
+
* <tt>administrator/include/application.php</tt>
  
===onAfterRender===
+
==onAfterRender==
 
'''Description'''
 
'''Description'''
 
This event is triggered after the framework has rendered the application.
 
This event is triggered after the framework has rendered the application.
Line 104: Line 101:
 
'''Used in files'''
 
'''Used in files'''
  
* include/application.php
+
* <tt>include/application.php</tt>
* administrator/include/application.php
+
* <tt>administrator/include/application.php</tt>
  
===onBeforeCompileHead===
+
==onBeforeCompileHead==
 
'''Description'''
 
'''Description'''
 
This event is triggered before the framework creates the Head section of the Document.
 
This event is triggered before the framework creates the Head section of the Document.
Line 121: Line 118:
 
'''Used in files'''
 
'''Used in files'''
  
* libraries/joomla/document/html/renderer/head.php
+
* <tt>libraries/joomla/document/html/renderer/head.php</tt>
  
===onSearch===
+
==onSearch==
 
'''Description'''
 
'''Description'''
  
Line 149: Line 146:
 
'''Used in files'''
 
'''Used in files'''
  
* administrator/components/com_statistics/admin.statistics.php
+
* <tt>administrator/components/com_statistics/admin.statistics.php</tt>
* components/com_search/search.php
+
* <tt>components/com_search/search.php</tt>
* plugins/search/categories.php
+
* <tt>plugins/search/categories.php</tt>
* plugins/search/contacts.php
+
* <tt>plugins/search/contacts.php</tt>
* plugins/search/content.php
+
* <tt>plugins/search/content.php</tt>
* plugins/search/newsfeeds.php
+
* <tt>plugins/search/newsfeeds.php</tt>
* plugins/search/sections.php
+
* <tt>plugins/search/sections.php</tt>
* plugins/search/weblinks.php
+
* <tt>plugins/search/weblinks.php</tt>
* plugins/xmlrpc/joomla.php
+
* <tt>plugins/xmlrpc/joomla.php</tt>
  
===onSearchAreas===
+
==onSearchAreas==
 
'''Description'''
 
'''Description'''
  
Line 175: Line 172:
 
'''Used in files'''
 
'''Used in files'''
  
* components/com_search/search.php
+
* <tt>components/com_search/search.php</tt>
* plugins/search/categories.php
+
* <tt>plugins/search/categories.php</tt>
* plugins/search/contacts.php
+
* <tt>plugins/search/contacts.php</tt>
* plugins/search/content.php
+
* <tt>plugins/search/content.php</tt>
* plugins/search/newsfeeds.php
+
* <tt>plugins/search/newsfeeds.php</tt>
* plugins/search/sections.php
+
* <tt>plugins/search/sections.php</tt>
* plugins/search/weblinks.php
+
* <tt>plugins/search/weblinks.php</tt>
  
===onGetWebServices===
+
==onGetWebServices==
  
 
'''Description'''
 
'''Description'''
Line 204: Line 201:
 
'''Used in files'''
 
'''Used in files'''
  
* plugins/xmlrpc/blogger.php
+
* <tt>plugins/xmlrpc/blogger.php</tt>
* plugins/xmlrpc/joomla.php
+
* <tt>plugins/xmlrpc/joomla.php</tt>
* xmlrpc/index.php
+
* <tt>xmlrpc/index.php</tt>
  
===Example===
+
==Example==
  
 
This is an example system plugin.  Please note that because system plugins are loaded before any other event group, they may also contain any other event.
 
This is an example system plugin.  Please note that because system plugins are loaded before any other event group, they may also contain any other event.
  
The following class would be located in the file <code>/plugins/system/example.php</code>.
+
The following class would be located in the file <tt>/plugins/system/example.php</tt>.
  
 
<source lang="php"><?php
 
<source lang="php"><?php
Line 225: Line 222:
 
class plgSystemExample extends JPlugin
 
class plgSystemExample extends JPlugin
 
{
 
{
/**
+
/**
* Constructor.
+
* Constructor.
*
+
*
* @access protected
+
* @access protected
* @param object $subject The object to observe
+
* @param object $subject The object to observe
* @param array  $config  An array that holds the plugin configuration
+
* @param array  $config  An array that holds the plugin configuration
* @since 1.0
+
* @since 1.0
*/
+
*/
public function __construct( &$subject, $config )
+
public function __construct( &$subject, $config )
{
+
{
parent::__construct( $subject, $config );
+
parent::__construct( $subject, $config );
  
// Do some extra initialisation in this constructor if required
+
// Do some extra initialisation in this constructor if required
}
+
}
  
/**
+
/**
* Do something onAfterInitialise  
+
* Do something onAfterInitialise
*/
+
*/
function onAfterInitialise()
+
function onAfterInitialise()
{
+
{
}
+
}
  
/**
+
/**
* Do something onAfterRoute  
+
* Do something onAfterRoute
*/
+
*/
function onAfterRoute()
+
function onAfterRoute()
{
+
{
}
+
}
  
/**
+
/**
* Do something onAfterDispatch  
+
* Do something onAfterDispatch
*/
+
*/
function onAfterDispatch()
+
function onAfterDispatch()
{
+
{
}
+
}
  
/**
+
/**
* Do something onAfterRender  
+
* Do something onAfterRender
*/
+
*/
function onAfterRender()
+
function onAfterRender()
{
+
{
}
+
}
 
}</source>
 
}</source>
  
The following XML document would be located in the file <code>/plugins/system/example.xml</code>.
+
The following XML document would be located in the file <tt>/plugins/system/example.xml</tt>.
  
 
<source lang="xml"><?xml version="1.0" encoding="utf-8"?>
 
<source lang="xml"><?xml version="1.0" encoding="utf-8"?>
 
<install version="1.5" type="plugin" group="system">
 
<install version="1.5" type="plugin" group="system">
<name>System - Example</name>
+
<name>System - Example</name>
<author>Author</author>
+
<author>Author</author>
<creationDate>Month 2008</creationDate>
+
<creationDate>Month 2008</creationDate>
<copyright>Copyright (C) 2008 Holder. All rights reserved.</copyright>
+
<copyright>Copyright (C) 2008 Holder. All rights reserved.</copyright>
<license>GNU General Public License</license>
+
<license>GNU General Public License</license>
<authorEmail>email</authorEmail>
+
<authorEmail>email</authorEmail>
<authorUrl>url</authorUrl>
+
<authorUrl>url</authorUrl>
<version>1.0.1</version>
+
<version>1.0.1</version>
<description>An example system plugin</description>
+
<description>An example system plugin</description>
<files>
+
<files>
<filename plugin="example">example.php</filename>
+
<filename plugin="example">example.php</filename>
</files>
+
</files>
<params>
+
<params>
  <param name="example"
+
  <param name="example"
  type="text"
+
  type="text"
  default=""
+
  default=""
  label="Example"
+
  label="Example"
  description="An example text parameter" />
+
  description="An example text parameter" />
</params>
+
</params>
 
</install></source>
 
</install></source>
 +
<noinclude>[[Category:Plugin Development]][[Category:Specifications]]</noinclude>

Revision as of 08:22, 14 July 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

In a standard installation of Joomla! 1.5 we have several predefined events which, when triggered, call functions in the associated plugins. For more information on plugins, check Plugin, Creating a Plugin for Joomla 1.5, How to create a content plugin etc.

This topic is aimed at "global" system events, including those triggered on every page load (onAfterInitialise, onAfterRoute, onAfterDispatch, onAfterRender), those supporting search within multiple plugins (onSearch, onSearchArea) and those supporting the presentation of web services (onGetWebServices). Visit Plugin for a complete list over available core events.

Contents

onAfterInitialise

Description

This event is triggered after the framework has loaded and the application initialise method has been called.

Parameters

None.

Return Value

None.

Called in files

  • index.php
  • administrator/index.php

onAfterRoute

Description

This event is triggered after the framework has loaded and initialised and the router has route the client request.

Routing is the process of examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object to be processed when the application is being dispatched.

When this event triggers the router has parsed the route and pushed the request parameters into JRequest for retrieval by the application.

Parameters

None.

Return Value

None.

Used in files

  • index.php
  • administrator/index.php

onAfterDispatch

Description This event is triggered after the framework has dispatched the application.

Dispatching is the process of pulling the option from the request object and mapping them to a component. If the component do not exist, it handles determining a default component to dispatch.

When this event is triggered the output of the component is available in the document buffer.

Parameters

None.

Return Value

None.

Used in files

  • index.php
  • administrator/index.php

onBeforeRender

Description This event is triggered immediately before the framework has rendered the application.

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the into the JResponse buffer.

Parameters

None.

Return Value

None.

Used in files

  • include/application.php
  • administrator/include/application.php

onAfterRender

Description This event is triggered after the framework has rendered the application.

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the into the JResponse buffer.

When this event is triggered the output of the application is available in the response buffer.

Parameters

None.

Return Value

None.

Used in files

  • include/application.php
  • administrator/include/application.php

onBeforeCompileHead

Description This event is triggered before the framework creates the Head section of the Document.

Parameters

None.

Return Value

None.

Used in files

  • libraries/joomla/document/html/renderer/head.php

onSearch

Description

This event is triggered by a variety of search related operations. It is a request for a plugin to return the result of a search request. The rows must return the following fields, which are used in a common display routine:

  • href
  • title
  • section
  • created
  • text
  • browsernav

Parameters

  • The target search string.
  • A string matching option (exact|any|all).
  • A string ordering option (newest|oldest|popular|alpha|category)
  • An array if restricted to areas, null if search all.

Return Value

Array of stdClass objects with members as described above.

Used in files

  • administrator/components/com_statistics/admin.statistics.php
  • components/com_search/search.php
  • plugins/search/categories.php
  • plugins/search/contacts.php
  • plugins/search/content.php
  • plugins/search/newsfeeds.php
  • plugins/search/sections.php
  • plugins/search/weblinks.php
  • plugins/xmlrpc/joomla.php

onSearchAreas

Description

This appears to be a request for plugins to identify which "areas" they provide search facilities for.

Parameters

None.

Return Value

An associative array of area names, indexed by the area identifier. For example, array( 'categories' => 'Categories' ).

Used in files

  • components/com_search/search.php
  • plugins/search/categories.php
  • plugins/search/contacts.php
  • plugins/search/content.php
  • plugins/search/newsfeeds.php
  • plugins/search/sections.php
  • plugins/search/weblinks.php

onGetWebServices

Description

This is an introspection request for plugins that provide web services.

Parameters

None.

Return Value

An array of associative arrays. The outer array is indexed by the service method name and contains an array with the following elements:

  • ['function'] The method to be invoked, typically a string like 'ClassName::staticMethod'
  • ['docstring'] A human-readable definition of the method's purpose.
  • ['signature'] An array identifying the types of the method's parameters. See the global variables $xmlrpc* for more information.

Used in files

  • plugins/xmlrpc/blogger.php
  • plugins/xmlrpc/joomla.php
  • xmlrpc/index.php

Example

This is an example system plugin. Please note that because system plugins are loaded before any other event group, they may also contain any other event.

The following class would be located in the file /plugins/system/example.php.

<?php
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );
 
jimport( 'joomla.plugin.plugin' );
 
/**
 * Example system plugin
 */
class plgSystemExample extends JPlugin
{
/**
* Constructor.
*
* @access protected
* @param object $subject The object to observe
* @param array   $config  An array that holds the plugin configuration
* @since 1.0
*/
public function __construct( &$subject, $config )
{
parent::__construct( $subject, $config );
 
// Do some extra initialisation in this constructor if required
}
 
/**
* Do something onAfterInitialise
*/
function onAfterInitialise()
{
}
 
/**
* Do something onAfterRoute
*/
function onAfterRoute()
{
}
 
/**
* Do something onAfterDispatch
*/
function onAfterDispatch()
{
}
 
/**
* Do something onAfterRender
*/
function onAfterRender()
{
}
}

The following XML document would be located in the file /plugins/system/example.xml.

<?xml version="1.0" encoding="utf-8"?>
<install version="1.5" type="plugin" group="system">
<name>System - Example</name>
<author>Author</author>
<creationDate>Month 2008</creationDate>
<copyright>Copyright (C) 2008 Holder. All rights reserved.</copyright>
<license>GNU General Public License</license>
<authorEmail>email</authorEmail>
<authorUrl>url</authorUrl>
<version>1.0.1</version>
<description>An example system plugin</description>
<files>
<filename plugin="example">example.php</filename>
</files>
<params>
  <param name="example"
  type="text"
  default=""
  label="Example"
  description="An example text parameter" />
</params>
</install>