Parent class for all plugin config gui classes. More...

Inheritance diagram for ilPluginConfigGUI:

Collaboration diagram for ilPluginConfigGUI:

Public Member Functions
	setPluginObject ($a_val)
	Set plugin object. More...

	getPluginObject ()
	Get plugin object. More...

	executeCommand ()
	Execute command. More...

	performCommand ($cmd)

Protected Attributes
	$plugin_object = null

Detailed Description

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 20 of file class.ilPluginConfigGUI.php.

Member Function Documentation

◆ executeCommand()

ilPluginConfigGUI::executeCommand ( )

Execute command.

Parameters

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

References $_GET, $DIC, $ilCtrl, $lng, $tpl, and performCommand().

     {
         global $DIC;
         $ilCtrl = $DIC->ctrl();
         $ilTabs = $DIC->tabs();
         $lng = $DIC->language();
         $tpl = $DIC['tpl'];
 
         $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "ctype", $_GET["ctype"]);
         $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "cname", $_GET["cname"]);
         $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "slot_id", $_GET["slot_id"]);
         $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "plugin_id", $_GET["plugin_id"]);
         $ilCtrl->setParameterByClass("ilobjcomponentsettingsgui", "pname", $_GET["pname"]);
 
         $tpl->setTitle($lng->txt("cmps_plugin") . ": " . $_GET["pname"]);
         $tpl->setDescription("");
 
         $ilTabs->clearTargets();
         
         if ($_GET["plugin_id"]) {
             $ilTabs->setBackTarget(
                 $lng->txt("cmps_plugin"),
                 $ilCtrl->getLinkTargetByClass("ilobjcomponentsettingsgui", "showPlugin")
             );
         } else {
             $ilTabs->setBackTarget(
                 $lng->txt("cmps_plugins"),
                 $ilCtrl->getLinkTargetByClass("ilobjcomponentsettingsgui", "listPlugins")
             );
         }
 
         $this->performCommand($ilCtrl->getCmd("configure"));
     }

Here is the call graph for this function:

◆ getPluginObject()

ilPluginConfigGUI::getPluginObject ( )

final

Get plugin object.

Returns: ilPlugin object

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

References $plugin_object.

Referenced by ilCloudPluginConfigGUI\getTableName().

     {
         return $this->plugin_object;
     }

Here is the caller graph for this function:

◆ performCommand()

ilPluginConfigGUI::performCommand ( $cmd )

abstract

Referenced by executeCommand().

Here is the caller graph for this function:

◆ setPluginObject()

ilPluginConfigGUI::setPluginObject ( $a_val )

final

Set plugin object.

Parameters

object plugin object

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

     {
         $this->plugin_object = $a_val;
     }

Field Documentation

◆ $plugin_object

ilPluginConfigGUI::$plugin_object = null

protected

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

Referenced by getPluginObject().

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

Services/Component/classes/class.ilPluginConfigGUI.php

Public Member Functions

Protected Attributes