blob: 2d6579459810da6f3ec7d4d9b9667a56e7c19c10 (
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
|
<?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$
*
* @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
{
function __construct()
{
}
public function registerTranslation( $langCode )
{
$infos = $this->getInformation();
if(!isset($infos['translationAvailable']))
{
$infos['translationAvailable'] = false;
}
$translationAvailable = $infos['translationAvailable'];
if(!$translationAvailable)
{
return;
}
$name = $infos['name'];
$path = PIWIK_INCLUDE_PATH . "/plugins/" . $name ."/lang/%s.php";
$defaultLangPath = sprintf($path, $langCode);
$defaultEnglishLangPath = sprintf($path, 'en');
$translations = array();
if(is_readable($defaultLangPath))
{
require $defaultLangPath;
}
elseif(is_readable($defaultEnglishLangPath))
{
require $defaultEnglishLangPath;
}
else
{
throw new Exception("The language file couldn't be find for this plugin '$name'.");
}
Piwik_Translate::getInstance()->addTranslationArray($translations);
}
/**
* Returns the plugin details
*/
abstract function getInformation();
/**
* Returns the plugin name
*/
public function getName()
{
$info = $this->getInformation();
return $info['name'];
}
/**
* Returns the list of hooks registered with the methods names
*/
function getListHooksRegistered()
{
return array();
}
/**
* Returns the names of the required plugins
*/
public function getListRequiredPlugins()
{
return array();
}
/**
* Install the plugin
* - create tables
* - update existing tables
* - etc.
*/
public function install()
{
return;
}
/**
* Remove the created resources during the install
*/
public function uninstall()
{
return;
}
}
|
