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.
	getPCGUI ()
	Get pc gui object.
	setPlugin ($a_val)
	Set plugin object.
	getPlugin ()
	Get plugin object.
	setMode ($a_mode)
	Set Mode.
	getMode ()
	Get Mode.
	getHTML ()
	Get HTML.
	executeCommand ()
	insert ()
	edit ()
	create ()
	getElementHTML ($a_mode, array $a_properties, $plugin_version)
	createElement (array $a_properties)
	updateElement (array $a_properties)
	returnToParent ()
	Return to parent.
	setProperties (array $a_val)
	Set properties.
	getProperties ()
	Get properties.

Protected Member Functions
	addCreationButton ($a_form)
	Add creation button.

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

ilPageComponentPluginGUI::addCreationButton (   $a_form )

finalprotected

Add creation button.

Parameters

@return

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

References $lng.

        {
                global $lng;
                
                $a_form->addCommandButton("create_plug", $lng->txt("save"));
        }

ilPageComponentPluginGUI::create ( )

abstract

ilPageComponentPluginGUI::createElement

(

array

$a_properties

)

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

References getPCGUI().

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

Here is the call graph for this function:

ilPageComponentPluginGUI::edit ( )

abstract

Referenced by getHTML().

Here is the caller graph for this function:

ilPageComponentPluginGUI::executeCommand ( )

abstract

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

abstract

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().

        {
                if ($this->getMode() == ilPageComponentPlugin::CMD_INSERT)
                {
                        $this->insert();
                }
                else if ($this->getMode() == ilPageComponentPlugin::CMD_EDIT)
                {
                        $this->edit();
                }
                
        }

Here is the call graph for this function:

ilPageComponentPluginGUI::getMode ( )

final

Get Mode.

Returns

string Mode

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

Referenced by getHTML().

        {
                return $this->mode;
        }

Here is the caller graph for this function:

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().

        {
                return $this->pc_gui;
        }

Here is the caller graph for this function:

ilPageComponentPluginGUI::getPlugin

(

)

Get plugin object.

Returns

object plugin object

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

References $plugin.

        {
                return $this->plugin;
        }

ilPageComponentPluginGUI::getProperties

(

)

Get properties.

Returns

array properties array

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

References getPCGUI().

        {
                $co = $this->getPCGUI()->getContentObject();
                if (is_object($co))
                {
                        return $co->getProperties($a_val);
                }
                return array();
        }

Here is the call graph for this function:

ilPageComponentPluginGUI::insert ( )

abstract

Referenced by getHTML().

Here is the caller graph for this function:

ilPageComponentPluginGUI::returnToParent

(

)

Return to parent.

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

References getPCGUI().

        {
                $this->getPCGUI()->returnToParent();
        }

Here is the call graph for this function:

ilPageComponentPluginGUI::setMode (   $a_mode )

final

Set Mode.

Parameters

string

$a_mode

Mode

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

        {
                $this->mode = $a_mode;
        }

ilPageComponentPluginGUI::setPCGUI

(

$a_val

)

Set pc gui object.

Parameters

object

$a_val

pc gui object

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

        {
                $this->pc_gui = $a_val;
        }

ilPageComponentPluginGUI::setPlugin

(

$a_val

)

Set plugin object.

Parameters

object

$a_val

plugin object

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

        {
                $this->plugin = $a_val;
        }

ilPageComponentPluginGUI::setProperties

(

array

$a_val

)

Set properties.

Parameters

array

$a_val

properties array

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

References getPCGUI().

        {
                $co = $this->getPCGUI()->getContentObject();
                if (is_object($co))
                {
                        $co->setProperties($a_val);
                }
        }

Here is the call graph for this function:

ilPageComponentPluginGUI::updateElement

(

array

$a_properties

)

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

References getPCGUI().

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

Here is the call graph for this function:

Field Documentation

ilPageComponentPluginGUI::$pc

protected

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

ilPageComponentPluginGUI::$pc_gui

protected

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

Referenced by getPCGUI().

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:

• Services/COPage/classes/class.ilPageComponentPluginGUI.php