ilPluginConfigGUI 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 ilPluginConfigGUI:

Public Member Functions
	setPluginObject (ilPlugin $a_val)
	getPluginObject ()
	executeCommand ()
	Execute command. More...
	performCommand (string $cmd)

Protected Member Functions
	performNextClass (string $next_class)
	addTabs (ilTabsGUI $tabs)

Protected Attributes
ilPlugin	$plugin_object = null

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 Parent class for all plugin config gui classes

You can provide a configuration screen in the ILIAS administration if you implement the class class.il<plugin_name>ConfigGUI.php which should extend ilPluginConfigGUI.

The access the configuration class open the ILIAS Administration > Plugins > Actions (of your Plugin) > Configure

IMPORTANT: Note, that for the configure action to be displayed in your plugins actions dropdown, you need to reload the plugins control structure. You can force your plugin to do so, by updating the plugins version in plugin.php and select Update in the plugins actions in the table in the plugin administration.

Author

Alex Killing <alex.killing>

Version

$Id$

Definition at line 35 of file class.ilPluginConfigGUI.php.

Member Function Documentation

addTabs()

ilPluginConfigGUI::addTabs ( ilTabsGUI  $tabs )

protected

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

Referenced by executeCommand().

                                               : void
    {
    }

Here is the caller graph for this function:

executeCommand()

ilPluginConfigGUI::executeCommand

(

)

Execute command.

Parameters

Definition at line 55 of file class.ilPluginConfigGUI.php.

References $DIC, $lng, ILIAS\UI\examples\Layout\Page\Standard\$request_wrapper, addTabs(), performCommand(), and performNextClass().

                                    : void
    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $ilTabs = $DIC->tabs();
        $lng = $DIC->language();
        $tpl = $DIC['tpl'];
        $request_wrapper = $DIC->http()->wrapper()->query();
        $string_trafo = $DIC["refinery"]->kindlyTo()->string();

        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "ctype", $request_wrapper->retrieve("ctype", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "cname", $request_wrapper->retrieve("cname", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "slot_id", $request_wrapper->retrieve("slot_id", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "plugin_id", $request_wrapper->retrieve("plugin_id", $string_trafo));
        $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "pname", $request_wrapper->retrieve("pname", $string_trafo));

        $tpl->setTitle($lng->txt("cmps_plugin") . ": " . $request_wrapper->retrieve("pname", $string_trafo));
        $tpl->setDescription("");

        $ilTabs->clearTargets();

        if ($request_wrapper->retrieve("plugin_id", $string_trafo)) {
            $ilTabs->setBackTarget(
                $lng->txt("cmps_plugin"),
                $ilCtrl->getLinkTargetByClass("ilobjcomponentsettingsgui", "showPlugin")
            );
        } else {
            $ilTabs->setBackTarget(
                $lng->txt("cmps_plugins"),
                $ilCtrl->getLinkTargetByClass("ilobjcomponentsettingsgui", "listPlugins")
            );
        }

        $this->addTabs($ilTabs);

        $next_class = $ilCtrl->getNextClass();
        if ($next_class && $this->performNextClass($next_class)) {
            return;
        }
        $this->performCommand($ilCtrl->getCmd("configure"));
    }

Here is the call graph for this function:

getPluginObject()

ilPluginConfigGUI::getPluginObject ( )

final

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

References $plugin_object.

                                           : ?ilPlugin
    {
        return $this->plugin_object;
    }

performCommand()

ilPluginConfigGUI::performCommand ( string  $cmd )

abstract

Referenced by executeCommand().

Here is the caller graph for this function:

performNextClass()

ilPluginConfigGUI::performNextClass ( string  $next_class )

protected

Definition at line 99 of file class.ilPluginConfigGUI.php.

Referenced by executeCommand().

                                                           : bool
    {
        return false;
    }

Here is the caller graph for this function:

setPluginObject()

ilPluginConfigGUI::setPluginObject ( ilPlugin  $a_val )

final

Definition at line 39 of file class.ilPluginConfigGUI.php.

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

Field Documentation

$plugin_object

ilPlugin ilPluginConfigGUI::$plugin_object = null

protected

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

Referenced by getPluginObject().

---

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

• components/ILIAS/Component/classes/class.ilPluginConfigGUI.php