Actions

API17

Difference between revisions of "JPlugin"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JPlugin==
 +
===Description===
 +
{{Description:JPlugin}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JPlugin|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JPlugin|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JPlugin}}
 
===Defined in===
 
libraries/joomla/plugin/plugin.php
 
* see source code in [[jplatform:plugin/plugin.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage Plugin/11.1|Plugin]]
 
===Extends===
 
[[JEvent/11.1|JEvent]]
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public
 
|[[JPlugin::__construct/11.1|__construct]]
 
|[[JPlugin::__construct/11.1|__construct]]
 
|Constructor.  
 
|Constructor.  
 
|-
 
|-
 +
|public
 
|[[JPlugin::loadLanguage/11.1|loadLanguage]]
 
|[[JPlugin::loadLanguage/11.1|loadLanguage]]
 
|Loads the plugin language file.  
 
|Loads the plugin language file.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/plugin/plugin.php
 +
* '''Extends''' [[JEvent/11.1|JEvent]]
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.plugin.plugin' );</source>
 
<source lang="php">jimport( 'joomla.plugin.plugin' );</source>
 
===See also===
 
===See also===
* JPlugin source code in [[jplatform:plugin/plugin.php|BitBucket]]
+
* {{JVer|11.1}} '''JPlugin source code''' on [[jplatform:plugin/plugin.php|BitBucket]]
* [[JPlugin|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage Plugin/11.1|Plugin]]
 +
* [[JPlugin|Other versions of JPlugin]]
 
{{SeeAlso:JPlugin}}
 
{{SeeAlso:JPlugin}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JPlugin|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JPlugin|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 42: Line 42:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JPlugin]]</noinclude>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JPlugin]]</noinclude>

Revision as of 17:07, 27 April 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.

Joomla 11.1 JPlugin

Description

Description:JPlugin [Edit Descripton]

Methods

Visibility Method name Description
public __construct Constructor.
public loadLanguage Loads the plugin language file.
  • Defined in libraries/joomla/plugin/plugin.php
  • Extends JEvent

Importing

jimport( 'joomla.plugin.plugin' );

See also


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 />