ilPageComponentPluginGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilPageComponentPluginGUI:

Public Member Functions
	__construct ()
	setPCGUI (ilPCPluggedGUI $a_val)
	getPCGUI ()
	setPlugin (ilPageComponentPlugin $a_val)
	getPlugin ()
	setMode (string $a_mode)
	getMode ()
	getHTML ()
	Get HTML. More...
	executeCommand ()
	insert ()
	edit ()
	create ()
	getElementHTML (string $a_mode, array $a_properties, string $plugin_version)
	create_plug ()
	createElement (array $a_properties)
	updateElement (array $a_properties)
	returnToParent ()
	setProperties (array $a_val)
	Set properties. More...
	getProperties ()

Protected Member Functions
	addCreationButton (ilPropertyFormGUI $a_form)

Protected Attributes
string	$mode
ilLanguage	$lng
ilPageComponentPlugin	$plugin
ilPCPluggedGUI	$pc_gui

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Abstract parent class for all page component plugin gui classes.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilPageComponentPluginGUI::__construct

(

)

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

References $DIC, and ILIAS\Repository\lng().

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

addCreationButton()

ilPageComponentPluginGUI::addCreationButton ( ilPropertyFormGUI  $a_form )

finalprotected

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

References $lng, ilPropertyFormGUI\addCommandButton(), and ilLanguage\txt().

                                                                         : void
    {
        $lng = $this->lng;

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

Here is the call graph for this function:

create()

ilPageComponentPluginGUI::create ( )

abstract

Referenced by create_plug(), and getHTML().

Here is the caller graph for this function:

create_plug()

ilPageComponentPluginGUI::create_plug

(

)

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

References create().

                                  : void
    {
        $this->create();
    }

Here is the call graph for this function:

createElement()

ilPageComponentPluginGUI::createElement

(

array

$a_properties

)

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

References getPCGUI().

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

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

Referenced by getHTML().

Here is the caller graph for this function:

getElementHTML()

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

abstract

Referenced by getHTML().

Here is the caller graph for this function:

getHTML()

ilPageComponentPluginGUI::getHTML

(

)

Get HTML.

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

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

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

Here is the call graph for this function:

getMode()

ilPageComponentPluginGUI::getMode ( )

final

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

References $mode.

Referenced by getHTML().

                                   : string
    {
        return $this->mode;
    }

Here is the caller graph for this function:

getPCGUI()

ilPageComponentPluginGUI::getPCGUI

(

)

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

References $pc_gui.

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

                              : ilPCPluggedGUI
    {
        return $this->pc_gui;
    }

Here is the caller graph for this function:

getPlugin()

ilPageComponentPluginGUI::getPlugin

(

)

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

References $plugin.

                               : ilPageComponentPlugin
    {
        return $this->plugin;
    }

getProperties()

ilPageComponentPluginGUI::getProperties

(

)

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

References getPCGUI().

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

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

(

)

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

References getPCGUI().

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

Here is the call graph for this function:

setMode()

ilPageComponentPluginGUI::setMode ( string  $a_mode )

final

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

                                                 : void
    {
        $this->mode = $a_mode;
    }

setPCGUI()

ilPageComponentPluginGUI::setPCGUI

(

ilPCPluggedGUI

$a_val

)

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

                                                   : void
    {
        $this->pc_gui = $a_val;
    }

setPlugin()

ilPageComponentPluginGUI::setPlugin

(

ilPageComponentPlugin

$a_val

)

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

                                                           : void
    {
        $this->plugin = $a_val;
    }

setProperties()

ilPageComponentPluginGUI::setProperties

(

array

$a_val

)

Set properties.

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

References getPCGUI().

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

Here is the call graph for this function:

updateElement()

ilPageComponentPluginGUI::updateElement

(

array

$a_properties

)

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

References getPCGUI().

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

Here is the call graph for this function:

Field Documentation

$lng

ilLanguage ilPageComponentPluginGUI::$lng

protected

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

Referenced by addCreationButton().

$mode

string ilPageComponentPluginGUI::$mode

protected

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

Referenced by getMode().

$pc_gui

ilPCPluggedGUI ilPageComponentPluginGUI::$pc_gui

protected

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

Referenced by getPCGUI().

$plugin

ilPageComponentPlugin ilPageComponentPluginGUI::$plugin

protected

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

Referenced by getPlugin().

---

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

• components/ILIAS/COPage/classes/class.ilPageComponentPluginGUI.php