ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilPageComponentPluginGUI Class Reference

Abstract parent class for all page component plugin gui classes. More...

+ Collaboration diagram for ilPageComponentPluginGUI:

Public Member Functions

 setPCGUI ($a_val)
 Set pc gui object. More...
 
 getPCGUI ()
 Get pc gui object. More...
 
 setPlugin ($a_val)
 Set plugin object. More...
 
 getPlugin ()
 Get plugin object. More...
 
 setMode ($a_mode)
 Set Mode. More...
 
 getMode ()
 Get Mode. More...
 
 getHTML ()
 Get HTML. More...
 
 executeCommand ()
 
 insert ()
 
 edit ()
 
 create ()
 
 getElementHTML ($a_mode, array $a_properties, $plugin_version)
 
 createElement (array $a_properties)
 
 updateElement (array $a_properties)
 
 returnToParent ()
 Return to parent. More...
 
 setProperties (array $a_val)
 Set properties. More...
 
 getProperties ()
 Get properties. More...
 

Protected Member Functions

 addCreationButton ($a_form)
 Add creation button. More...
 

Protected Attributes

 $plugin
 
 $pc_gui
 
 $pc
 

Detailed Description

Abstract parent class for all page component plugin gui classes.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 13 of file class.ilPageComponentPluginGUI.php.

Member Function Documentation

◆ addCreationButton()

ilPageComponentPluginGUI::addCreationButton (   $a_form)
finalprotected

Add creation button.

Parameters

return

Definition at line 157 of file class.ilPageComponentPluginGUI.php.

158 {
159 global $lng;
160
161 $a_form->addCommandButton("create_plug", $lng->txt("save"));
162 }
global $lng
Definition: privfeed.php:40

References $lng.

◆ create()

ilPageComponentPluginGUI::create ( )
abstract

◆ createElement()

ilPageComponentPluginGUI::createElement ( array  $a_properties)

Definition at line 104 of file class.ilPageComponentPluginGUI.php.

105 {
106 return $this->getPCGUI()->createElement($a_properties);
107 }

References getPCGUI().

+ Here is the call graph for this function:

◆ edit()

ilPageComponentPluginGUI::edit ( )
abstract

Referenced by getHTML().

+ Here is the caller graph for this function:

◆ executeCommand()

ilPageComponentPluginGUI::executeCommand ( )
abstract

◆ getElementHTML()

ilPageComponentPluginGUI::getElementHTML (   $a_mode,
array  $a_properties,
  $plugin_version 
)
abstract

◆ getHTML()

ilPageComponentPluginGUI::getHTML ( )

Get HTML.

Parameters

return

Definition at line 85 of file class.ilPageComponentPluginGUI.php.

References ilPageComponentPlugin\CMD_EDIT, ilPageComponentPlugin\CMD_INSERT, edit(), getMode(), and insert().

+ Here is the call graph for this function:

◆ getMode()

ilPageComponentPluginGUI::getMode ( )
final

Get Mode.

Returns
string Mode

Definition at line 74 of file class.ilPageComponentPluginGUI.php.

75 {
76 return $this->mode;
77 }

Referenced by getHTML().

+ Here is the caller graph for this function:

◆ getPCGUI()

ilPageComponentPluginGUI::getPCGUI ( )

Get pc gui object.

Returns
object pc gui object

Definition at line 34 of file class.ilPageComponentPluginGUI.php.

References $pc_gui.

Referenced by createElement(), getProperties(), returnToParent(), setProperties(), and updateElement().

+ Here is the caller graph for this function:

◆ getPlugin()

ilPageComponentPluginGUI::getPlugin ( )

Get plugin object.

Returns
object plugin object

Definition at line 54 of file class.ilPageComponentPluginGUI.php.

References $plugin.

◆ getProperties()

ilPageComponentPluginGUI::getProperties ( )

Get properties.

Returns
array properties array

Definition at line 141 of file class.ilPageComponentPluginGUI.php.

142 {
143 $co = $this->getPCGUI()->getContentObject();
144 if (is_object($co))
145 {
146 return $co->getProperties($a_val);
147 }
148 return array();
149 }

References getPCGUI().

+ Here is the call graph for this function:

◆ insert()

ilPageComponentPluginGUI::insert ( )
abstract

Referenced by getHTML().

+ Here is the caller graph for this function:

◆ returnToParent()

ilPageComponentPluginGUI::returnToParent ( )

Return to parent.

Definition at line 117 of file class.ilPageComponentPluginGUI.php.

118 {
119 $this->getPCGUI()->returnToParent();
120 }

References getPCGUI().

+ Here is the call graph for this function:

◆ setMode()

ilPageComponentPluginGUI::setMode (   $a_mode)
final

Set Mode.

Parameters
string$a_modeMode

Definition at line 64 of file class.ilPageComponentPluginGUI.php.

65 {
66 $this->mode = $a_mode;
67 }

◆ setPCGUI()

ilPageComponentPluginGUI::setPCGUI (   $a_val)

Set pc gui object.

Parameters
object$a_valpc gui object

Definition at line 24 of file class.ilPageComponentPluginGUI.php.

25 {
26 $this->pc_gui = $a_val;
27 }

◆ setPlugin()

ilPageComponentPluginGUI::setPlugin (   $a_val)

Set plugin object.

Parameters
object$a_valplugin object

Definition at line 44 of file class.ilPageComponentPluginGUI.php.

45 {
46 $this->plugin = $a_val;
47 }

◆ setProperties()

ilPageComponentPluginGUI::setProperties ( array  $a_val)

Set properties.

Parameters
array$a_valproperties array

Definition at line 127 of file class.ilPageComponentPluginGUI.php.

128 {
129 $co = $this->getPCGUI()->getContentObject();
130 if (is_object($co))
131 {
132 $co->setProperties($a_val);
133 }
134 }

References getPCGUI().

+ Here is the call graph for this function:

◆ updateElement()

ilPageComponentPluginGUI::updateElement ( array  $a_properties)

Definition at line 109 of file class.ilPageComponentPluginGUI.php.

110 {
111 return $this->getPCGUI()->updateElement($a_properties);
112 }

References getPCGUI().

+ Here is the call graph for this function:

Field Documentation

◆ $pc

ilPageComponentPluginGUI::$pc
protected

Definition at line 17 of file class.ilPageComponentPluginGUI.php.

◆ $pc_gui

ilPageComponentPluginGUI::$pc_gui
protected

Definition at line 16 of file class.ilPageComponentPluginGUI.php.

Referenced by getPCGUI().

◆ $plugin

ilPageComponentPluginGUI::$plugin
protected

Definition at line 15 of file class.ilPageComponentPluginGUI.php.

Referenced by getPlugin().


The documentation for this class was generated from the following file: