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

Collaboration diagram for ilPageComponentPluginGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	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
	$lng

	$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.

Constructor & Destructor Documentation

◆ __construct()

ilPageComponentPluginGUI::__construct ( )

Constructor.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
    }

References $DIC.

Member Function Documentation

◆ addCreationButton()

ilPageComponentPluginGUI::addCreationButton ( $a_form )

finalprotected

Add creation button.

Parameters

return

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

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

References $lng.

◆ create()

ilPageComponentPluginGUI::create ( )

abstract

◆ createElement()

ilPageComponentPluginGUI::createElement ( array $a_properties )

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

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

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 101 of file class.ilPageComponentPluginGUI.php.

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

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 90 of file class.ilPageComponentPluginGUI.php.

    {
        return $this->mode;
    }

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 50 of file class.ilPageComponentPluginGUI.php.

    {
        return $this->pc_gui;
    }

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 70 of file class.ilPageComponentPluginGUI.php.

    {
        return $this->plugin;
    }

References $plugin.

◆ getProperties()

ilPageComponentPluginGUI::getProperties ( )

Get properties.

Returns: array properties array

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

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

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 129 of file class.ilPageComponentPluginGUI.php.

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

References getPCGUI().

Here is the call graph for this function:

◆ setMode()

ilPageComponentPluginGUI::setMode ( $a_mode )

final

Set Mode.

Parameters

string $a_mode Mode

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

    {
        $this->mode = $a_mode;
    }

◆ setPCGUI()

ilPageComponentPluginGUI::setPCGUI ( $a_val )

Set pc gui object.

Parameters

object $a_val pc gui object

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

    {
        $this->pc_gui = $a_val;
    }

◆ setPlugin()

ilPageComponentPluginGUI::setPlugin ( $a_val )

Set plugin object.

Parameters

object $a_val plugin object

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

    {
        $this->plugin = $a_val;
    }

◆ setProperties()

ilPageComponentPluginGUI::setProperties ( array $a_val )

Set properties.

Parameters

array $a_val properties array

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

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

References getPCGUI().

Here is the call graph for this function:

◆ updateElement()

ilPageComponentPluginGUI::updateElement ( array $a_properties )

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

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

References getPCGUI().

Here is the call graph for this function:

Field Documentation

◆ $lng

ilPageComponentPluginGUI::$lng

protected

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

Referenced by addCreationButton().

◆ $pc

ilPageComponentPluginGUI::$pc

protected

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

◆ $pc_gui

ilPageComponentPluginGUI::$pc_gui

protected

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

Referenced by getPCGUI().

◆ $plugin

ilPageComponentPluginGUI::$plugin

protected

Definition at line 31 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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCreationButton()

◆ create()

◆ createElement()

◆ edit()

◆ executeCommand()

◆ getElementHTML()

◆ getHTML()

◆ getMode()

◆ getPCGUI()

◆ getPlugin()

◆ getProperties()

◆ insert()

◆ returnToParent()

◆ setMode()

◆ setPCGUI()

◆ setPlugin()

◆ setProperties()

◆ updateElement()

Field Documentation

◆ $lng

◆ $pc

◆ $pc_gui

◆ $plugin