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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
|
<?php
/**
* Parses Elgg manifest.xml files.
*
* This requires an ElggPluginManifestParser class implementation
* as $this->parser.
*
* @package Elgg.Core
* @subpackage Plugins
*/
class ElggPluginManifest {
/**
* The parser object
*/
protected $parser;
/**
* The API version of the manifest.
*
* @var int
*/
protected $apiVersion;
/**
* The optional plugin id this manifest belongs to.
*
* @var string
*/
protected $pluginID;
/**
* Load a manifest file, XmlElement or path to manifest.xml file
*
* @param mixed $manifest A string, XmlElement, or path of a manifest file.
* @param string $plugin_id Optional ID of the owning plugin. Used to
* fill in some values automatically.
*/
public function __construct($manifest, $plugin_id = null) {
if ($plugin_id) {
$this->pluginID = $plugin_id;
}
// see if we need to construct the xml object.
if ($manifest instanceof XmlElement) {
$manifest_obj = $manifest;
} else {
if (substr(trim($manifest), 0, 1) == '<') {
// this is a string
$raw_xml = $manifest;
} elseif (is_readable($manifest)) {
// this is a file
$raw_xml = file_get_contents($manifest);
}
$manifest_obj = xml_to_object($raw_xml);
}
if (!$manifest_obj) {
throw new PluginException(elgg_echo('PluginException:InvalidManifest', array($this->getPluginID())));
}
// set manifest api version
if (isset($manifest_obj->attributes['version'])) {
$this->apiVersion = (float)$manifest_obj->attributes['version'];
} else {
$this->apiVersion = 1.7;
}
switch ($this->apiVersion) {
case 1.8:
$this->parser = new ElggPluginManifestParser18($manifest_obj, $this);
break;
case 1.7:
$this->parser = new ElggPluginManifestParser17($manifest_obj, $this);
break;
default:
throw new PluginException(elgg_echo('PluginException:NoAvailableParser',
array($this->apiVersion, $this->getPluginID())));
break;
}
if (!$this->parser->parse()) {
throw new PluginException(elgg_echo('PluginException:ParserError',
array($this->apiVersion, $this->getPluginID())));
}
return true;
}
/**
* Returns the API version in use.
*
* @return int
*/
public function getApiVersion() {
return $this->apiVersion;
}
/**
* Returns the plugin ID.
*
* @return string
*/
public function getPluginID() {
if ($this->pluginID) {
return $this->pluginID;
} else {
return elgg_echo('unknown');
}
}
/**
* Returns the manifest array.
*
* Used for backward compatibility. Specific
* methods should be called instead.
*
* @return array
*/
public function getManifest() {
return $this->parser->getManifest();
}
/**
* Returns the dependencies listed.
*
* @return array
*/
public function getDepends() {
$deps = $this->parser->getAttribute('depends');
if (!is_array($deps)) {
$deps = array();
}
return $deps;
}
/**
* Returns the conflicts listed
*
* @return array
*/
public function getConflicts() {
$conflicts = $this->parser->getAttribute('conflicts');
if (!is_array($conflicts)) {
$conflicts = array();
}
return $conflicts;
}
/**
* Returns the plugin name
*
* @return string
*/
public function getName() {
$name = $this->parser->getAttribute('name');
if (!$name && $this->pluginID) {
$name = ucwords(str_replace('_', ' ', $pluginID));
}
return $name;
}
/**
* Return the description
*
* @return string
*/
public function getDescription() {
return $this->parser->getAttribute('description');
}
/**
* Return the short description
*
* @return string
*/
public function getBlurb() {
$blurb = $this->parser->getAttribute('blurb');
if (!$blurb) {
$blurb = elgg_get_excerpt($this->getDescription());
}
return $blurb;
}
/**
* Returns the license
*
* @return sting
*/
public function getLicense() {
return $this->parser->getAttribute('license');
}
/**
* Returns the version of the plugin.
*
* @return float
*/
public function getVersion() {
return $this->parser->getAttribute('version');
}
/**
* Returns the plugin author.
*
* @return string
*/
public function getAuthor() {
return $this->parser->getAttribute('author');
}
/**
* Return the copyright
*
* @return string
*/
public function getCopyright() {
return $this->parser->getAttribute('copyright');
}
/**
* Return the website
*
* @return string
*/
public function getWebsite() {
return $this->parser->getAttribute('website');
}
/**
* Return the categories listed for this plugin
*
* @return array
*/
public function getCategories() {
$cats = $this->parser->getAttribute('categories');
if (!is_array($cats)) {
$cats = array();
}
return $cats;
}
/**
* Return the screenshots listed.
*
* @return array
*/
public function getScreenshots() {
$ss = $this->parser->getAttribute('screenshots');
if (!is_array($ss)) {
$ss = array();
}
return $ss;
}
/**
* Return the list of provides by this plugin.
*
* @return array
*/
public function getProvides() {
$provides = $this->parser->getAttribute('provides');
// always provide ourself if we can
if ($this->pluginID) {
$provides[] = array('name' => $this->getPluginID(), 'version' => $this->getVersion);
}
return $provides;
}
}
|
