blob: 793423f26e13aef0461c7075f815db5bccd52e75 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @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
* - 'license' => string // plugin license
* - 'license_homepage' => string // license 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?
*
* @return array
*/
abstract public function getInformation();
/**
* Returns the list of hooks registered with the methods names
*
* @return array
*/
public 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;
}
/**
* Executed every time the plugin is enabled
*/
public function activate()
{
return;
}
/**
* Executed every time the plugin is disabled
*/
public function deactivate()
{
return;
}
/**
* Returns the plugin version number
*
* @return string
*/
public function getVersion()
{
$info = $this->getInformation();
return $info['version'];
}
/**
* Returns the plugin's base class name without the "Piwik_" prefix,
* e.g., "UserCountry" when the plugin class is "Piwik_UserCountry"
*
* @return string
*/
final public function getPluginName()
{
return Piwik::unprefixClass(get_class($this));
}
/**
* Returns the plugin's base class name without the "Piwik_" prefix,
* e.g., "UserCountry" when the plugin class is "Piwik_UserCountry"
*
* @deprecated since 1.2 - for backward compatibility
*
* @return string
*/
final public function getClassName()
{
return $this->getPluginName();
}
}
|
