ilPCPluggedGUI Class Reference
Class ilPCPluggedGUI. More...
Inheritance diagram for ilPCPluggedGUI:
Collaboration diagram for ilPCPluggedGUI:
Public Member Functions | |
| ilPCPluggedGUI (&$a_pg_obj, &$a_content_obj, $a_hier_id, $a_plugin_name="", $a_pc_id="") | |
| Constructor @access public. More... | |
| setPluginName ($a_pluginname) | |
| Set PluginName. More... | |
| getPluginName () | |
| Get PluginName. More... | |
| & | executeCommand () |
| execute command More... | |
| insert () | |
| Insert new section form. More... | |
| edit ($a_insert=false) | |
| Edit section form. More... | |
| createElement (array $a_properties) | |
| Create new element. More... | |
| updateElement (array $a_properties) | |
| Update element. More... | |
| returnToParent () | |
| Return to parent. More... | |
| Public Member Functions inherited from ilPageContentGUI | |
| ilPageContentGUI ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="") | |
| Constructor @access public. More... | |
| setContentObject ($a_val) | |
| Set content object. More... | |
| getContentObject () | |
| Get content object. More... | |
| setPage ($a_val) | |
| Set page. More... | |
| getPage () | |
| Get page. More... | |
| setPageConfig ($a_val) | |
| Set Page Config. More... | |
| getPageConfig () | |
| Get Page Config. More... | |
| setStyleId ($a_styleid) | |
| Set Style Id. More... | |
| getStyleId () | |
| Get Style Id. More... | |
| getStyle () | |
| Get style object. More... | |
| setCharacteristics ($a_chars) | |
| Set Characteristics. More... | |
| getCharacteristics () | |
| Get characteristics. More... | |
| getHierId () | |
| get hierarchical id in dom object More... | |
| setHierId ($a_hier_id) | |
| get hierarchical id in dom object More... | |
| getBBMenu ($a_ta_name="par_content") | |
| Get the bb menu incl. More... | |
| delete () | |
| delete content element More... | |
| moveAfter () | |
| move content element after another element More... | |
| moveBefore () | |
| move content element before another element More... | |
| splitPage () | |
| split page to new page at specified position More... | |
| splitPageNext () | |
| split page to next page at specified position More... | |
| displayValidationError () | |
| display validation errors More... | |
| cancelCreate () | |
| cancel creating page content More... | |
| cancelUpdate () | |
| cancel update More... | |
| cancel () | |
| Cancel. More... | |
| deactivate () | |
| gui function set enabled if is not enabled and vice versa More... | |
| cut () | |
| Cut single element. More... | |
| copy () | |
| Copy single element. More... | |
| getTemplateOptions ($a_type) | |
| Get table templates. More... | |
Protected Attributes | |
| $current_plugin = null | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilPageContentGUI | |
| static | _getCommonBBButtons () |
| Get common bb buttons. More... | |
| Data Fields inherited from ilPageContentGUI | |
| $content_obj | |
| $ilias | |
| $tpl | |
| $lng | |
| $ctrl | |
| $pg_obj | |
| $hier_id | |
| $dom | |
| $updated | |
| $target_script | |
| $return_location | |
| $page_config = null | |
| Static Public Attributes inherited from ilPageContentGUI | |
| static | $style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;" |
| Protected Member Functions inherited from ilPageContentGUI | |
| getCharacteristicsOfCurrentStyle ($a_type) | |
| Get characteristics of current style. More... | |
| Static Protected Attributes inherited from ilPageContentGUI | |
| static | $common_bb_buttons |
Detailed Description
Class ilPCPluggedGUI.
User Interface for plugged page component
- Version
- $Id$
Definition at line 19 of file class.ilPCPluggedGUI.php.
Member Function Documentation
◆ createElement()
| ilPCPluggedGUI::createElement | ( | array | $a_properties | ) |
Create new element.
Definition at line 146 of file class.ilPCPluggedGUI.php.
147 {
149 $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id,
150 $this->current_plugin->getPluginName(), $this->current_plugin->getVersion());
151 $this->content_obj->setProperties($a_properties);
152 $this->updated = $this->pg_obj->update();
153 if ($this->updated === true)
154 {
155 return true;
156 }
157 return false;
158 }
Class ilPCPlugged Plugged content object (see ILIAS DTD)
Definition: class.ilPCPlugged.php:17
References ilPageContentGUI\getPage().
Here is the call graph for this function:
◆ edit()
| ilPCPluggedGUI::edit | ( | $a_insert = false | ) |
Edit section form.
Definition at line 107 of file class.ilPCPluggedGUI.php.
108 {
110
111 $this->displayValidationError();
112
113 // edit form
114 if ($a_insert)
115 {
116 $plugin_name = $this->getPluginName();
117 }
118 else
119 {
120 $plugin_name = $this->content_obj->getPluginName();
121 }
123 {
125 "pgcp", $plugin_name);
126 $gui_obj = $plugin_obj->getUIClassInstance();
127 $gui_obj->setPCGUI($this);
128 if ($a_insert)
129 {
130 $gui_obj->setMode(ilPageComponentPlugin::CMD_INSERT);
131 }
132 else
133 {
134 $gui_obj->setMode(ilPageComponentPlugin::CMD_EDIT);
135 }
136 $html = $ilCtrl->getHTML($gui_obj);
137 }
138
139 $tpl->setContent($html);
140 }
References $ilCtrl, ilPageContentGUI\$lng, ilPageContentGUI\$tpl, ilPageComponentPlugin\CMD_EDIT, ilPageComponentPlugin\CMD_INSERT, ilPageContentGUI\displayValidationError(), getPluginName(), and IL_COMP_SERVICE.
Referenced by insert().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ executeCommand()
| & ilPCPluggedGUI::executeCommand | ( | ) |
execute command
Definition at line 58 of file class.ilPCPluggedGUI.php.
59 {
61
63
64 // get next class that processes or forwards current command
65 $next_class = $this->ctrl->getNextClass($this);
66
67 // get all plugins and check, whether next class belongs to one
68 // of them, then forward
69 $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE,
70 "COPage", "pgcp");
71 foreach ($pl_names as $pl_name)
72 {
73 if ($next_class == strtolower("il".$pl_name."plugingui"))
74 {
75 $plugin = $ilPluginAdmin->getPluginObject(IL_COMP_SERVICE,
76 "COPage", "pgcp", $pl_name);
77 $this->current_plugin = $plugin;
78 $this->setPluginName($pl_name);
79 $gui_obj = $plugin->getUIClassInstance();
80 $gui_obj->setPCGUI($this);
81 $ret = $this->ctrl->forwardCommand($gui_obj);
82 }
83 }
84
85 // get current command
86 $cmd = $this->ctrl->getCmd();
87
88 if ($next_class == "" || $next_class == "ilpcpluggedgui")
89 {
91 }
92
94 }
References $cmd, $ilCtrl, ilPageContentGUI\$lng, $ret, IL_COMP_SERVICE, and setPluginName().
Here is the call graph for this function:
◆ getPluginName()
| ilPCPluggedGUI::getPluginName | ( | ) |
Get PluginName.
- Returns
- string PluginName
Definition at line 50 of file class.ilPCPluggedGUI.php.
51 {
52 return $this->pluginname;
53 }
Referenced by edit().
Here is the caller graph for this function:
◆ ilPCPluggedGUI()
| ilPCPluggedGUI::ilPCPluggedGUI | ( | & | $a_pg_obj, |
| & | $a_content_obj, | ||
| $a_hier_id, | |||
$a_plugin_name = "", |
|||
$a_pc_id = "" |
|||
| ) |
Constructor @access public.
Definition at line 27 of file class.ilPCPluggedGUI.php.
29 {
30 global $ilCtrl;
31 $this->setPluginName($a_plugin_name);
32 parent::ilPageContentGUI($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
33 }
References $ilCtrl, and setPluginName().
Here is the call graph for this function:
◆ insert()
| ilPCPluggedGUI::insert | ( | ) |
Insert new section form.
Definition at line 99 of file class.ilPCPluggedGUI.php.
100 {
102 }
References edit().
Here is the call graph for this function:
◆ returnToParent()
| ilPCPluggedGUI::returnToParent | ( | ) |
Return to parent.
Definition at line 178 of file class.ilPCPluggedGUI.php.
179 {
180 $this->ctrl->returnToParent($this, "jump".$this->hier_id);
181 }
◆ setPluginName()
| ilPCPluggedGUI::setPluginName | ( | $a_pluginname | ) |
Set PluginName.
- Parameters
-
string $a_pluginname PluginName
Definition at line 40 of file class.ilPCPluggedGUI.php.
41 {
42 $this->pluginname = $a_pluginname;
43 }
Referenced by executeCommand(), and ilPCPluggedGUI().
Here is the caller graph for this function:
◆ updateElement()
| ilPCPluggedGUI::updateElement | ( | array | $a_properties | ) |
Update element.
Definition at line 163 of file class.ilPCPluggedGUI.php.
164 {
165 $this->content_obj->setProperties($a_properties);
166 $this->content_obj->setPluginVersion($this->current_plugin->getVersion());
167 $this->updated = $this->pg_obj->update();
168 if ($this->updated === true)
169 {
170 return true;
171 }
172 return false;
173 }
Field Documentation
◆ $current_plugin
|
protected |
Definition at line 21 of file class.ilPCPluggedGUI.php.
The documentation for this class was generated from the following file:
- Services/COPage/classes/class.ilPCPluggedGUI.php
