119 lines
2.8 KiB
PHP
119 lines
2.8 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* @version $Id: plugin.php 14401 2010-01-26 14:10:00Z louis $
|
||
|
|
* @package Joomla.Framework
|
||
|
|
* @subpackage Plugin
|
||
|
|
* @copyright Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
|
||
|
|
* @license GNU/GPL, see LICENSE.php
|
||
|
|
* Joomla! is free software. This version may have been modified pursuant
|
||
|
|
* to the GNU General Public License, and as distributed it includes or
|
||
|
|
* is derivative of works licensed under the GNU General Public License or
|
||
|
|
* other free or open source software licenses.
|
||
|
|
* See COPYRIGHT.php for copyright notices and details.
|
||
|
|
*/
|
||
|
|
|
||
|
|
// Check to ensure this file is within the rest of the framework
|
||
|
|
defined('JPATH_BASE') or die();
|
||
|
|
|
||
|
|
jimport( 'joomla.event.event' );
|
||
|
|
|
||
|
|
/**
|
||
|
|
* JPlugin Class
|
||
|
|
*
|
||
|
|
* @abstract
|
||
|
|
* @package Joomla.Framework
|
||
|
|
* @subpackage Plugin
|
||
|
|
* @since 1.5
|
||
|
|
*/
|
||
|
|
class JPlugin extends JEvent
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* A JParameter object holding the parameters for the plugin
|
||
|
|
*
|
||
|
|
* @var A JParameter object
|
||
|
|
* @access public
|
||
|
|
* @since 1.5
|
||
|
|
*/
|
||
|
|
var $params = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The name of the plugin
|
||
|
|
*
|
||
|
|
* @var sring
|
||
|
|
* @access protected
|
||
|
|
*/
|
||
|
|
var $_name = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The plugin type
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
* @access protected
|
||
|
|
*/
|
||
|
|
var $_type = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructor
|
||
|
|
*
|
||
|
|
* For php4 compatability we must not use the __constructor as a constructor for plugins
|
||
|
|
* because func_get_args ( void ) returns a copy of all passed arguments NOT references.
|
||
|
|
* This causes problems with cross-referencing necessary for the observer design pattern.
|
||
|
|
*
|
||
|
|
* @param object $subject The object to observe
|
||
|
|
* @param array $config An optional associative array of configuration settings.
|
||
|
|
* Recognized key values include 'name', 'group', 'params'
|
||
|
|
* (this list is not meant to be comprehensive).
|
||
|
|
* @since 1.5
|
||
|
|
*/
|
||
|
|
function JPlugin(& $subject, $config = array()) {
|
||
|
|
parent::__construct($subject);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Constructor
|
||
|
|
*/
|
||
|
|
function __construct(& $subject, $config = array())
|
||
|
|
{
|
||
|
|
//Set the parameters
|
||
|
|
if ( isset( $config['params'] ) ) {
|
||
|
|
|
||
|
|
if(is_a($config['params'], 'JParameter')) {
|
||
|
|
$this->params = $config['params'];
|
||
|
|
} else {
|
||
|
|
$this->params = new JParameter($config['params']);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( isset( $config['name'] ) ) {
|
||
|
|
$this->_name = $config['name'];
|
||
|
|
}
|
||
|
|
|
||
|
|
if ( isset( $config['type'] ) ) {
|
||
|
|
$this->_type = $config['type'];
|
||
|
|
}
|
||
|
|
|
||
|
|
parent::__construct($subject);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Loads the plugin language file
|
||
|
|
*
|
||
|
|
* @access public
|
||
|
|
* @param string $extension The extension for which a language file should be loaded
|
||
|
|
* @param string $basePath The basepath to use
|
||
|
|
* @return boolean True, if the file has successfully loaded.
|
||
|
|
* @since 1.5
|
||
|
|
*/
|
||
|
|
function loadLanguage($extension = '', $basePath = JPATH_BASE)
|
||
|
|
{
|
||
|
|
if(empty($extension)) {
|
||
|
|
$extension = 'plg_'.$this->_type.'_'.$this->_name;
|
||
|
|
}
|
||
|
|
|
||
|
|
$lang =& JFactory::getLanguage();
|
||
|
|
return $lang->load( strtolower($extension), $basePath);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
}
|