ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
class.ilPCPlugged.php
Go to the documentation of this file.
1<?php
2
3/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
4
5require_once("./Services/COPage/classes/class.ilPageContent.php");
6
17{
21 protected $lng;
22
26 protected $plugin_admin;
27
28 public $dom;
29 public $plug_node;
30
34 public function init()
35 {
36 global $DIC;
37
38 $this->lng = $DIC->language();
39 $this->plugin_admin = $DIC["ilPluginAdmin"];
40 $this->setType("plug");
41 }
42
46 public function setNode($a_node)
47 {
48 parent::setNode($a_node); // this is the PageContent node
49 $this->plug_node = $a_node->first_child(); // this is the Plugged node
50 }
51
58 public function create(
59 $a_pg_obj,
60 $a_hier_id,
61 $a_pc_id,
62 $a_plugin_name,
63 $a_plugin_version
64 ) {
65 $this->node = $this->createPageContentNode();
66 $a_pg_obj->insertContent($this, $a_hier_id, IL_INSERT_AFTER, $a_pc_id);
67 $this->plug_node = $this->dom->create_element("Plugged");
68 $this->plug_node = $this->node->append_child($this->plug_node);
69 $this->plug_node->set_attribute("PluginName", $a_plugin_name);
70 $this->plug_node->set_attribute("PluginVersion", $a_plugin_version);
71 }
72
78 public function setProperties($a_properties)
79 {
80 if (!is_object($this->plug_node)) {
81 return;
82 }
83
84 // delete properties
85 $children = $this->plug_node->child_nodes();
86 for ($i = 0; $i < count($children); $i++) {
87 $this->plug_node->remove_child($children[$i]);
88 }
89 // set properties
90 foreach ($a_properties as $key => $value) {
91 $prop_node = $this->dom->create_element("PluggedProperty");
92 $prop_node = $this->plug_node->append_child($prop_node);
93 $prop_node->set_attribute("Name", $key);
94 if ($value != "") {
95 $prop_node->set_content($value);
96 }
97 }
98 }
99
105 public function getProperties()
106 {
107 $properties = array();
108
109 if (is_object($this->plug_node)) {
110 // delete properties
111 $children = $this->plug_node->child_nodes();
112 for ($i = 0; $i < count($children); $i++) {
113 if ($children[$i]->node_name() == "PluggedProperty") {
114 $properties[$children[$i]->get_attribute("Name")] =
115 $children[$i]->get_content();
116 }
117 }
118 }
119
120 return $properties;
121 }
122
128 public function setPluginVersion($a_version)
129 {
130 if (!empty($a_version)) {
131 $this->plug_node->set_attribute("PluginVersion", $a_version);
132 } else {
133 if ($this->plug_node->has_attribute("PluginVersion")) {
134 $this->plug_node->remove_attribute("PluginVersion");
135 }
136 }
137 }
138
144 public function getPluginVersion()
145 {
146 if (is_object($this->plug_node)) {
147 return $this->plug_node->get_attribute("PluginVersion");
148 }
149 }
150
156 public function setPluginName($a_name)
157 {
158 if (!empty($a_name)) {
159 $this->plug_node->set_attribute("PluginName", $a_name);
160 } else {
161 if ($this->plug_node->has_attribute("PluginName")) {
162 $this->plug_node->remove_attribute("PluginName");
163 }
164 }
165 }
166
172 public function getPluginName()
173 {
174 if (is_object($this->plug_node)) {
175 return $this->plug_node->get_attribute("PluginName");
176 }
177 }
178
186 public static function handleCopiedPluggedContent(ilPageObject $a_page, DOMDocument $a_domdoc)
187 {
188 global $DIC;
189 $ilPluginAdmin = $DIC['ilPluginAdmin'];
190
191 $xpath = new DOMXPath($a_domdoc);
192 $nodes = $xpath->query("//Plugged");
193
195 foreach ($nodes as $node) {
196 $plugin_name = $node->getAttribute('PluginName');
197 $plugin_version = $node->getAttribute('PluginVersion');
198
199 if ($ilPluginAdmin->isActive(IL_COMP_SERVICE, "COPage", "pgcp", $plugin_name)) {
201 $plugin_obj = $ilPluginAdmin->getPluginObject(IL_COMP_SERVICE, "COPage", "pgcp", $plugin_name);
202 $plugin_obj->setPageObj($a_page);
203
204 $properties = array();
206 foreach ($node->childNodes as $child) {
207 $properties[$child->getAttribute('Name')] = $child->nodeValue;
208 }
209
210 // let the plugin copy additional content
211 // and allow it to modify the saved parameters
212 $plugin_obj->onClone($properties, $plugin_version);
213
214 foreach ($node->childNodes as $child) {
215 $node->removeChild($child);
216 }
217 foreach ($properties as $name => $value) {
218 $child = new DOMElement('PluggedProperty', $value);
219 $node->appendChild($child);
220 $child->setAttribute('Name', $name);
221 }
222 }
223 }
224 }
225
233 public static function handleDeletedPluggedNode(ilPageObject $a_page, DOMNode $a_node)
234 {
235 global $DIC;
236 $ilPluginAdmin = $DIC['ilPluginAdmin'];
237
238 $plugin_name = $a_node->getAttribute('PluginName');
239 $plugin_version = $a_node->getAttribute('PluginVersion');
240
241 if ($ilPluginAdmin->isActive(IL_COMP_SERVICE, "COPage", "pgcp", $plugin_name)) {
243 $plugin_obj = $ilPluginAdmin->getPluginObject(IL_COMP_SERVICE, "COPage", "pgcp", $plugin_name);
244 $plugin_obj->setPageObj($a_page);
245
246 $properties = array();
248 foreach ($a_node->childNodes as $child) {
249 $properties[$child->getAttribute('Name')] = $child->nodeValue;
250 }
251
252 // let the plugin delete additional content
253 $plugin_obj->onDelete($properties, $plugin_version);
254 }
255 }
256
257
264 public function modifyPageContentPostXsl($a_html, $a_mode)
265 {
267 $ilPluginAdmin = $this->plugin_admin;
268
269 $c_pos = 0;
270 $start = strpos($a_html, "{{{{{Plugged<pl");
271 //echo htmlentities($a_html)."-";
272 if (is_int($start)) {
273 $end = strpos($a_html, "}}}}}", $start);
274 }
275 $i = 1;
276
277 while ($end > 0) {
278 $param = substr($a_html, $start + 5, $end - $start - 5);
279 $param = str_replace(' xmlns:xhtml="http://www.w3.org/1999/xhtml"', "", $param);
280 $param = explode("<pl/>", $param);
281 //var_dump($param); exit;
282 $plugin_name = $param[1];
283 $plugin_version = $param[2];
284 $properties = array();
285
286 for ($i = 3; $i < count($param); $i += 2) {
287 $properties[$param[$i]] = $param[$i + 1];
288 }
289
290 // get html from plugin
291 if ($a_mode == "edit") {
292 $plugin_html = '<div class="ilBox">' . $lng->txt("content_plugin_not_activated") . " (" . $plugin_name . ")</div>";
293 }
294 if ($ilPluginAdmin->isActive(IL_COMP_SERVICE, "COPage", "pgcp", $plugin_name)) {
295 $plugin_obj = $ilPluginAdmin->getPluginObject(
297 "COPage",
298 "pgcp",
299 $plugin_name
300 );
301 $plugin_obj->setPageObj($this->getPage());
302 $gui_obj = $plugin_obj->getUIClassInstance();
303 $plugin_html = $gui_obj->getElementHTML($a_mode, $properties, $plugin_version);
304 }
305
306 $a_html = substr($a_html, 0, $start) .
307 $plugin_html .
308 substr($a_html, $end + 5);
309
310 if (strlen($a_html) > $start + 5) {
311 $start = strpos($a_html, "{{{{{Plugged<pl", $start + 5);
312 } else {
313 $start = false;
314 }
315 $end = 0;
316 if (is_int($start)) {
317 $end = strpos($a_html, "}}}}}", $start);
318 }
319 }
320
321 return $a_html;
322 }
323
327 public function getJavascriptFiles($a_mode)
328 {
329 $ilPluginAdmin = $this->plugin_admin;
330
331 $js_files = array();
332
333 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(
335 "COPage",
336 "pgcp"
337 );
338 foreach ($pl_names as $pl_name) {
339 $plugin = $ilPluginAdmin->getPluginObject(
341 "COPage",
342 "pgcp",
343 $pl_name
344 );
345 $plugin->setPageObj($this->getPage());
346 $pl_dir = $plugin->getDirectory();
347
348 $pl_js_files = $plugin->getJavascriptFiles($a_mode);
349 foreach ($pl_js_files as $pl_js_file) {
350 if (!is_int(strpos($pl_js_file, "//"))) {
351 $pl_js_file = $pl_dir . "/" . $pl_js_file;
352 }
353 if (!in_array($pl_js_file, $js_files)) {
354 $js_files[] = $pl_js_file;
355 }
356 }
357 }
358 //var_dump($js_files);
359 return $js_files;
360 }
361
365 public function getCssFiles($a_mode)
366 {
367 $ilPluginAdmin = $this->plugin_admin;
368
369 $css_files = array();
370
371 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(
373 "COPage",
374 "pgcp"
375 );
376 foreach ($pl_names as $pl_name) {
377 $plugin = $ilPluginAdmin->getPluginObject(
379 "COPage",
380 "pgcp",
381 $pl_name
382 );
383 $plugin->setPageObj($this->getPage());
384 $pl_dir = $plugin->getDirectory();
385
386 $pl_css_files = $plugin->getCssFiles($a_mode);
387 foreach ($pl_css_files as $pl_css_file) {
388 if (!is_int(strpos($pl_css_file, "//"))) {
389 $pl_css_file = $pl_dir . "/" . $pl_css_file;
390 }
391 if (!in_array($pl_css_file, $css_files)) {
392 $css_files[] = $pl_css_file;
393 }
394 }
395 }
396
397 return $css_files;
398 }
399}
An exception for terminatinating execution or to throw for unit testing.
const IL_COMP_SERVICE
const IL_INSERT_AFTER
Class ilPCPlugged Plugged content object (see ILIAS DTD)
create( $a_pg_obj, $a_hier_id, $a_pc_id, $a_plugin_name, $a_plugin_version)
Create plugged node in xml.
setNode($a_node)
Set node.
modifyPageContentPostXsl($a_html, $a_mode)
Modify page content after xsl.
getPluginName()
Get name of plugged component.
getJavascriptFiles($a_mode)
Get javascript files.
init()
Init page content component.
setPluginName($a_name)
Set name of plugged component.
setProperties($a_properties)
Set properties of plugged component.
getCssFiles($a_mode)
Get css files.
getProperties()
Get properties of plugged component.
setPluginVersion($a_version)
Set version of plugged component.
getPluginVersion()
Get version of plugged component.
Class ilPageContent.
createPageContentNode($a_set_this_node=true)
Create page content node (always use this method first when adding a new element)
setType($a_type)
Set Type.
Class ilPageObject.
$key
Definition: croninfo.php:18
$i
Definition: disco.tpl.php:19
global $DIC
Definition: saml.php:7
$start
Definition: bench.php:8