API17:JPlugin

Revision as of 13:59, 29 August 2012

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.

JPlugin

Description

Description:JPlugin [Edit Descripton]

Methods

• Defined in libraries/joomla/plugin/plugin.php
• Extends JEvent

Importing

jimport( 'joomla.plugin.plugin' );

See also

• JPlugin source code on BitBucket
• Subpackage Plugin
• Other versions of JPlugin

JPlugin is an abstract class. JPlugin Inherits JEvent.

Located in /libraries/joomla/plugin/plugin.php

It's mainly used for loading language file.

Public Member Functions: __construct (&$subject, $config=array())

	loadLanguage ($extension= , $basePath=JPATH_ADMINISTRATOR)

Data Fields: $params = null Protected Attributes

	$_name = null
	$_type = null

Constructor & Destructor Documentation:

__construct ( &$ subject, $ config = array() ) Constructor

Parameters: object $subject The object to observe array $config An optional associative array of configuration settings. Recognized key values include 'name', 'group', 'params', 'language' (this list is not meant to be comprehensive).

Member Function Documentation

loadLanguage ( $ extension = , $ basePath = JPATH_ADMINISTRATOR ) Loads the plugin language file

public

Parameters: string $extension The extension for which a language file should be loaded string $basePath The basepath to use Returns: boolean True, if the file has successfully loaded.

[Edit See Also]

User contributed notes

<CodeExamplesForm />