YuCheng Hu
1ec191d88b
+YUCHENG HU+ git-svn-id: https://svn.code.sf.net/p/hawebs/svn@423 a2543c7e-f6e9-4f8a-8bff-1ffc34733512
93 lines
2.2 KiB
PHP
93 lines
2.2 KiB
PHP
<?php
|
|
/**
|
|
* Piwik - Open source web analytics
|
|
*
|
|
* @link http://piwik.org
|
|
* @license http://www.gnu.org/licenses/gpl-3.0.html Gpl v3 or later
|
|
* @version $Id: Plugin.php 2272 2010-06-04 21:56:12Z vipsoft $
|
|
*
|
|
* @category Piwik
|
|
* @package Piwik
|
|
*/
|
|
|
|
/**
|
|
* Abstract class to define a Piwik_Plugin.
|
|
* Any plugin has to at least implement the abstract methods of this class.
|
|
*
|
|
* @package Piwik
|
|
*/
|
|
abstract class Piwik_Plugin
|
|
{
|
|
/**
|
|
* Returns the plugin details
|
|
* 'description' => string // 1-2 sentence description of the plugin
|
|
* 'author' => string // plugin author
|
|
* 'author_homepage' => string // author homepage URL (or email "mailto:youremail@example.org")
|
|
* 'homepage' => string // plugin homepage URL
|
|
* 'version' => string // plugin version number; examples and 3rd party plugins must not use Piwik_Version::VERSION;
|
|
* // 3rd party plugins must increment the version number with each plugin release
|
|
* 'translationAvailable' => bool // is there a translation file in plugins/your-plugin/lang/* ?
|
|
* 'TrackerPlugin' => bool // should we load this plugin during the stats logging process?
|
|
*/
|
|
abstract function getInformation();
|
|
|
|
/**
|
|
* Returns the list of hooks registered with the methods names
|
|
* @var array
|
|
*/
|
|
function getListHooksRegistered()
|
|
{
|
|
return array();
|
|
}
|
|
|
|
/**
|
|
* Executed after loading plugin and registering translations
|
|
* Useful for code that uses translated strings from the plugin.
|
|
*/
|
|
public function postLoad()
|
|
{
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Install the plugin
|
|
* - create tables
|
|
* - update existing tables
|
|
* - etc.
|
|
*/
|
|
public function install()
|
|
{
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Remove the created resources during the install
|
|
*/
|
|
public function uninstall()
|
|
{
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Returns the plugin version number
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getVersion()
|
|
{
|
|
$info = $this->getInformation();
|
|
return $info['version'];
|
|
}
|
|
|
|
/**
|
|
* Returns the plugin's base name without the "Piwik_" prefix,
|
|
* e.g., "UserCountry" when the plugin class is "Piwik_UserCountry"
|
|
*
|
|
* @return string
|
|
*/
|
|
final public function getClassName()
|
|
{
|
|
return Piwik::unprefixClass(get_class($this));
|
|
}
|
|
}
|