blob: 03db5df17cdec94c8aa3107da94d1b7743b4261c (
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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
<?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
*/
namespace Piwik;
use Piwik\Common;
use Piwik\Plugin\MetadataLoader;
/**
* @see Piwik\Plugin\MetadataLoader
*/
require_once PIWIK_INCLUDE_PATH . '/core/Plugin/MetadataLoader.php';
/**
* Abstract class to define a Plugin.
* Any plugin has to at least implement the abstract methods of this class.
*
* @package Piwik
*/
class Plugin
{
/**
* Name of this plugin.
*
* @var string
*/
protected $pluginName;
/**
* Holds plugin metadata.
*
* @var array
*/
private $pluginInformation;
/**
* Constructor.
*
* @param string|bool $pluginName A plugin name to force. If not supplied, it is set
* to last part of the class name.
*/
public function __construct($pluginName = false)
{
if (empty($pluginName)) {
$pluginName = explode('\\', get_class($this));
$pluginName = end($pluginName);
}
$this->pluginName = $pluginName;
$metadataLoader = new MetadataLoader($pluginName);
$this->pluginInformation = $metadataLoader->load();
}
/**
* 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 Version::VERSION; 3rd party plugins must increment the version number with each plugin release
* - 'theme' => bool // Whether this plugin is a theme (a theme is a plugin, but a plugin is not necessarily a theme)
*
* @return array
*/
public function getInformation()
{
return $this->pluginInformation;
}
/**
* Returns the list of hooks registered with the methods names
*
* @return array eg, array(
* 'API.getReportMetadata' => 'myPluginFunction',
* 'Another.event' => array(
* 'function' => 'myOtherPluginFunction',
* 'after' => true // execute after callbacks w/o ordering
* )
* 'Yet.Another.event' => array(
* 'function' => 'myOtherPluginFunction',
* 'before' => true // execute before callbacks w/o ordering
* )
* )
*/
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
*/
final public function getVersion()
{
$info = $this->getInformation();
return $info['version'];
}
/**
* Whether this plugin is a theme
*
* @return bool
*/
final public function isTheme()
{
$info = $this->getInformation();
return !empty($info['theme']) && (bool)$info['theme'];
}
/**
* Returns the plugin's base class name without the "Piwik_" prefix,
* e.g., "UserCountry" when the plugin class is "UserCountry"
*
* @return string
*/
final public function getPluginName()
{
return $this->pluginName;
}
}
|
