ilPCPluggedGUI Class Reference

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

Inheritance diagram for ilPCPluggedGUI:

Collaboration diagram for ilPCPluggedGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_plugin_name="", string $a_pc_id="")
	setPluginName (string $a_pluginname)
	getPluginName ()
	executeCommand ()
	insert ()
	edit (bool $a_insert=false)
	createElement (array $a_properties)
	updateElement (array $a_properties)
	returnToParent ()
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	displayValidationError ()
	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 (string $a_type="")
	Get table templates. More...

Protected Attributes
string	$pluginname = ""
ilTabsGUI	$tabs
ilPageComponentPlugin	$current_plugin = null
ilComponentRepository	$component_repository
ilComponentFactory	$component_factory
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

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 User Interface for plugged page component

Author

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

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

Constructor & Destructor Documentation

__construct()

ilPCPluggedGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_plugin_name = "",
		string	$a_pc_id = ""
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), setPluginName(), and ILIAS\Repository\tabs().

      {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->component_repository = $DIC["component.repository"];
        $this->component_factory = $DIC["component.factory"];
        $this->tabs = $DIC->tabs();
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];

        $this->setPluginName($a_plugin_name);
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

Here is the call graph for this function:

Member Function Documentation

createElement()

ilPCPluggedGUI::createElement

(

array

$a_properties

)

Definition at line 142 of file class.ilPCPluggedGUI.php.

References ilPageContentGUI\getPage().

                                                      : bool
    {
        $this->content_obj = new ilPCPlugged($this->getPage());
        $this->content_obj->create(
            $this->pg_obj,
            $this->hier_id,
            $this->pc_id,
            $this->current_plugin->getPluginName(),
            $this->current_plugin->getVersion()
        );
        $this->content_obj->setProperties($a_properties);
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

edit()

ilPCPluggedGUI::edit

(

bool

$a_insert = false

)

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

References ilPageContentGUI\$ctrl, XapiProxy\$plugin, ilPageContentGUI\$tpl, ilPageComponentPlugin\CMD_EDIT, ilPageComponentPlugin\CMD_INSERT, ilPageContentGUI\displayValidationError(), ilPageContentGUI\getPage(), getPluginName(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by insert().

                                                : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $html = "";

        $this->displayValidationError();

        // edit form
        if ($a_insert) {
            $plugin_name = $this->getPluginName();
        } else {
            $plugin_name = $this->content_obj->getPluginName();
        }
        $plugin = $this->component_repository->getPluginByName($plugin_name);
        if ($plugin->isActive()) {
            $plugin_obj = $this->component_factory->getPlugin($plugin->getId());
            $plugin_obj->setPageObj($this->getPage());
            $gui_obj = $plugin_obj->getUIClassInstance();
            $gui_obj->setPCGUI($this);
            if ($a_insert) {
                $gui_obj->setMode(ilPageComponentPlugin::CMD_INSERT);
            } else {
                $gui_obj->setMode(ilPageComponentPlugin::CMD_EDIT);
            }
            $html = $ilCtrl->getHTML($gui_obj);
        }

        if ($html != "") {
            $tpl->setContent($html);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCPluggedGUI::executeCommand

(

)

Returns

mixed

Exceptions

ilCtrlException

Definition at line 66 of file class.ilPCPluggedGUI.php.

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, XapiProxy\$plugin, $tabs, ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), setPluginName(), and ilLanguage\txt().

    {
        $ilTabs = $this->tabs;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ret = "";

        $ilTabs->setBackTarget($lng->txt("pg"), $ilCtrl->getLinkTarget($this, "returnToParent"));

        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get all plugins and check, whether next class belongs to one
        // of them, then forward
        $plugins = $this->component_repository->getPluginSlotById("pgcp")->getActivePlugins();
        foreach ($plugins as $pl) {
            $pl_name = $pl->getName();
            if ($next_class == strtolower("il" . $pl_name . "plugingui")) {
                $plugin = $this->component_factory->getPlugin($pl->getId());
                $plugin->setPageObj($this->getPage());
                $this->current_plugin = $plugin;
                $this->setPluginName($pl_name);
                $gui_obj = $plugin->getUIClassInstance();
                $gui_obj->setPCGUI($this);
                $ret = $this->ctrl->forwardCommand($gui_obj);
            }
        }

        // get current command
        $cmd = $this->ctrl->getCmd();

        if ($next_class == "" || $next_class == "ilpcpluggedgui") {
            $ret = $this->$cmd();
        }

        return $ret;
    }

Here is the call graph for this function:

getPluginName()

ilPCPluggedGUI::getPluginName

(

)

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

References $pluginname.

Referenced by edit().

                                   : string
    {
        return $this->pluginname;
    }

Here is the caller graph for this function:

insert()

ilPCPluggedGUI::insert

(

)

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

References edit().

                            : void
    {
        $this->edit(true);
    }

Here is the call graph for this function:

returnToParent()

ilPCPluggedGUI::returnToParent

(

)

Definition at line 171 of file class.ilPCPluggedGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
    }

Here is the call graph for this function:

setPluginName()

ilPCPluggedGUI::setPluginName

(

string

$a_pluginname

)

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

Referenced by __construct(), and executeCommand().

                                                       : void
    {
        $this->pluginname = $a_pluginname;
    }

Here is the caller graph for this function:

updateElement()

ilPCPluggedGUI::updateElement

(

array

$a_properties

)

Definition at line 160 of file class.ilPCPluggedGUI.php.

                                                      : bool
    {
        $this->content_obj->setProperties($a_properties);
        $this->content_obj->setPluginVersion($this->current_plugin->getVersion());
        $this->updated = $this->pg_obj->update();
        if ($this->updated === true) {
            return true;
        }
        return false;
    }

Field Documentation

$component_factory

ilComponentFactory ilPCPluggedGUI::$component_factory

protected

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

$component_repository

ilComponentRepository ilPCPluggedGUI::$component_repository

protected

Definition at line 29 of file class.ilPCPluggedGUI.php.

$current_plugin

ilPageComponentPlugin ilPCPluggedGUI::$current_plugin = null

protected

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

$pluginname

string ilPCPluggedGUI::$pluginname = ""

protected

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

Referenced by getPluginName().

$tabs

ilTabsGUI ilPCPluggedGUI::$tabs

protected

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

Referenced by executeCommand().

---

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

• components/ILIAS/COPage/PC/Plugged/class.ilPCPluggedGUI.php