@ilCtrl_Calls ilObjComponentSettingsGUI: ilPermissionGUI More...

Inheritance diagram for ilObjComponentSettingsGUI:

Collaboration diagram for ilObjComponentSettingsGUI:

Public Member Functions
	__construct ($data, int $id, bool $call_by_reference=true, bool $prepare_output=true)

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	executeCommand ()

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	getAdminTabs ()
	administration tabs show only permissions and trash folder More...

	getHTML ()

	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled More...

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Data Fields
const	CMD_DEFAULT = "listPlugins"

const	CMD_INSTALL_PLUGIN = "installPlugin"

const	CMD_CONFIGURE = "configure"

const	CMD_REFRESH_LANGUAGES = "refreshLanguages"

const	CMD_ACTIVATE_PLUGIN = "activatePlugin"

const	CMD_DEACTIVATE_PLUGIN = "deactivatePlugin"

const	CMD_UPDATE_PLUGIN = "updatePlugin"

const	CMD_JUMP_TO_PLUGIN_SLOT = "jumpToPluginSlot"

const	CMD_UNINSTALL_PLUGIN = "uninstallPlugin"

const	CMD_CONFIRM_UNINSTALL_PLUGIN = "confirmUninstallPlugin"

const	P_REF_ID = 'ref_id'

const	P_CTYPE = "ctype"

const	P_CNAME = "cname"

const	P_SLOT_ID = "slot_id"

const	P_PLUGIN_NAME = "pname"

const	P_PLUGIN_ID = "plugin_id"

const	P_ADMIN_MODE = 'admin_mode'

Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Member Functions
	forwardConfigGUI (string $name)

	installPlugin ()

	update (ilPlugin $plugin)

	refreshLanguages ()

	activatePlugin ()

	deactivatePlugin ()

	updatePlugin ()

	confirmUninstallPlugin ()

	uninstallPlugin ()

	getPlugin ()

	listPlugins ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

	addLocatorItems ()
	should be overwritten to add object specific items (repository items are preloaded) More...

	omitLocator (bool $omit=true)

	addAdminLocatorItems (bool $do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded) More...

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	@abstract overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $cmd="")
	redirects to (repository) view per ref id usually to a container and usually used at the end of a save/import method where the object gui type (of the new object) doesn't match with the type of the current ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Protected Attributes
ilTabsGUI	$tabs

ilRbacSystem	$rbac_system

ilDBInterface	$db

ilComponentRepository	$component_repository

ilComponentFactory	$component_factory

ilErrorHandling	$error

ILIAS Refinery Factory	$refinery

ILIAS HTTP Wrapper RequestWrapper	$request_wrapper

Factory	$ui

Renderer	$renderer

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

GlobalHttpState	$http

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

CustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Private Attributes
const	TYPE = 'cmps'

const	TAB_PLUGINS = "plugins"

const	TAB_PERMISSION = "perm_settings"

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Detailed Description

@ilCtrl_Calls ilObjComponentSettingsGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjComponentSettingsGUI::__construct	(		$data,
		int	$id,
		bool	$call_by_reference = `true`,
		bool	$prepare_output = `true`
	)

Definition at line 64 of file class.ilObjComponentSettingsGUI.php.

    {
        parent::__construct($data, $id, $call_by_reference, $prepare_output);
 
        global $DIC;
 
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->rbac_system = $DIC->rbac()->system();
        $this->db = $DIC->database();
        $this->type = self::TYPE;
        $this->component_repository = $DIC["component.repository"];
        $this->component_factory = $DIC["component.factory"];
        $this->error = $DIC["ilErr"];
        $this->refinery = $DIC->refinery();
        $this->request_wrapper = $DIC->http()->wrapper()->query();
        $this->ui = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
 
        $this->lng->loadLanguageModule(self::TYPE);
    }

References ilObjectGUI\$call_by_reference, ilObjectGUI\$data, $DIC, ilObjectGUI\$id, ilObjectGUI\$prepare_output, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), error(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), renderer(), ILIAS\Repository\tabs(), TYPE, and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

◆ activatePlugin()

ilObjComponentSettingsGUI::activatePlugin ( )

protected

Definition at line 199 of file class.ilObjComponentSettingsGUI.php.

                                       : void
    {
        $pl = $this->getPlugin();
 
        try {
            $pl->activate();
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("cmps_plugin_activated"), true);
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage("failure", $e->getMessage(), true);
        }
 
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References Vendor\Package\$e, ILIAS\Repository\ctrl(), getPlugin(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmUninstallPlugin()

ilObjComponentSettingsGUI::confirmUninstallPlugin ( )

protected

Definition at line 233 of file class.ilObjComponentSettingsGUI.php.

                                               : void
    {
        $pl = $this->getPlugin();
 
        $plugin_name = $this->request_wrapper->retrieve(self::P_PLUGIN_NAME, $this->refinery->kindlyTo()->string());
 
        $pl_info = $this->component_repository->getPluginByName($plugin_name);
 
        if ($pl_info->isActivated() || $pl_info->isActivationPossible()) {
            $question = sprintf(
                $this->lng->txt("cmps_uninstall_confirm"),
                $pl->getPluginName()
            );
        } else {
            $question = sprintf(
                $this->lng->txt("cmps_uninstall_inactive_confirm"),
                $pl->getPluginName(),
                $pl_info->getReasonForInactivity()
            );
        }
 
        $this->ctrl->setParameter($this, self::P_PLUGIN_NAME, $pl_info->getName());
        $buttons = array(
            $this->ui->button()->standard(
                $this->lng->txt('confirm'),
                $this->ctrl->getLinkTarget($this, self::CMD_UNINSTALL_PLUGIN)
            ),
            $this->ui->button()->standard(
                $this->lng->txt('cancel'),
                $this->ctrl->getLinkTarget($this, 'showQuestionList')
            )
        );
 
        $this->tpl->setContent($this->renderer->render($this->ui->messageBox()->confirmation($question)->withButtons($buttons)));
    }

References ILIAS\Repository\ctrl(), getPlugin(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), renderer(), and ILIAS\Repository\ui().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deactivatePlugin()

ilObjComponentSettingsGUI::deactivatePlugin ( )

protected

Definition at line 213 of file class.ilObjComponentSettingsGUI.php.

                                         : void
    {
        $pl = $this->getPlugin();
 
        try {
            $pl->deactivate();
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("cmps_plugin_deactivated"), true);
        } catch (InvalidArgumentException $e) {
            $this->tpl->setOnScreenMessage("failure", $e->getMessage(), true);
        }
 
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References Vendor\Package\$e, ILIAS\Repository\ctrl(), getPlugin(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjComponentSettingsGUI::executeCommand ( )

Reimplemented from ilObjectGUI.

Definition at line 101 of file class.ilObjComponentSettingsGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
 
        $this->prepareOutput();
 
        if (!$this->rbac_system->checkAccess('read', $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('no_permission'), $this->error->WARNING);
        }
 
        switch (true) {
            case $next_class === 'ilpermissiongui':
                $this->tabs->activateTab(self::TAB_PERMISSION);
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case preg_match("/configgui$/i", $next_class):
                $this->forwardConfigGUI($next_class);
                break;
            default:
                switch ($cmd) {
                    case self::CMD_INSTALL_PLUGIN:
                        $this->installPlugin();
                        break;
                    case self::CMD_REFRESH_LANGUAGES:
                        $this->refreshLanguages();
                        break;
                    case self::CMD_ACTIVATE_PLUGIN:
                        $this->activatePlugin();
                        break;
                    case self::CMD_DEACTIVATE_PLUGIN:
                        $this->deactivatePlugin();
                        break;
                    case self::CMD_UPDATE_PLUGIN:
                        $this->updatePlugin();
                        break;
                    case self::CMD_CONFIRM_UNINSTALL_PLUGIN:
                        $this->confirmUninstallPlugin();
                        break;
                    case self::CMD_UNINSTALL_PLUGIN:
                        $this->uninstallPlugin();
                        break;
                    default:
                        $this->listPlugins();
                }
        }
    }

References activatePlugin(), CMD_ACTIVATE_PLUGIN, CMD_CONFIRM_UNINSTALL_PLUGIN, CMD_DEACTIVATE_PLUGIN, CMD_INSTALL_PLUGIN, CMD_REFRESH_LANGUAGES, CMD_UNINSTALL_PLUGIN, CMD_UPDATE_PLUGIN, confirmUninstallPlugin(), ILIAS\Repository\ctrl(), deactivatePlugin(), error(), forwardConfigGUI(), installPlugin(), listPlugins(), ILIAS\Repository\lng(), ilObjectGUI\prepareOutput(), refreshLanguages(), ILIAS\Repository\tabs(), uninstallPlugin(), and updatePlugin().

Here is the call graph for this function:

◆ forwardConfigGUI()

ilObjComponentSettingsGUI::forwardConfigGUI ( string $name )

protected

Definition at line 150 of file class.ilObjComponentSettingsGUI.php.

                                                     : void
    {
        $name = $this->ctrl->lookupOriginalClassName($name);
 
        if (!class_exists($name)) {
            throw new Exception("class $name not found!");
        }
 
        $plugin = $this->getPlugin();
        $gui = new $name();
        $gui->setPluginObject($plugin);
 
        $this->ctrl->forwardCommand($gui);
    }

References XapiProxy\$plugin, ILIAS\Repository\ctrl(), and getPlugin().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdminTabs()

ilObjComponentSettingsGUI::getAdminTabs ( )

administration tabs show only permissions and trash folder

Reimplemented from ilObjectGUI.

Definition at line 316 of file class.ilObjComponentSettingsGUI.php.

                                  : void
    {
        if ($this->rbac_system->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                self::TAB_PLUGINS,
                $this->lng->txt("cmps_plugins"),
                $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
            );
        }
 
        if ($this->rbac_system->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                "perm_settings",
                $this->lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm")
            );
        }
 
        if (
            $this->request_wrapper->has(self::P_CTYPE) &&
            $this->request_wrapper->retrieve(self::P_CTYPE, $this->refinery->kindlyTo()->string()) === "components/ILIAS"
        ) {
            $this->tabs_gui->activateTab("services");
        }
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getPlugin()

ilObjComponentSettingsGUI::getPlugin ( )

protected

Definition at line 283 of file class.ilObjComponentSettingsGUI.php.

                                  : ilPlugin
    {
        $plugin_name = $this->request_wrapper->retrieve(self::P_PLUGIN_NAME, $this->refinery->kindlyTo()->string());
        return $this->component_factory->getPlugin(
            $this->component_repository->getPluginByName($plugin_name)->getId()
        );
    }

References ILIAS\Repository\refinery().

Referenced by activatePlugin(), confirmUninstallPlugin(), deactivatePlugin(), forwardConfigGUI(), installPlugin(), uninstallPlugin(), and updatePlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSafePostCommands()

ilObjComponentSettingsGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 96 of file class.ilObjComponentSettingsGUI.php.

                                         : array
    {
        return [];
    }

◆ getUnsafeGetCommands()

ilObjComponentSettingsGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 86 of file class.ilObjComponentSettingsGUI.php.

                                          : array
    {
        return [
            self::CMD_UPDATE_PLUGIN,
            self::CMD_ACTIVATE_PLUGIN,
            self::CMD_DEACTIVATE_PLUGIN,
            self::CMD_REFRESH_LANGUAGES,
        ];
    }

References CMD_ACTIVATE_PLUGIN, CMD_DEACTIVATE_PLUGIN, CMD_REFRESH_LANGUAGES, and CMD_UPDATE_PLUGIN.

◆ installPlugin()

ilObjComponentSettingsGUI::installPlugin ( )

protected

Definition at line 165 of file class.ilObjComponentSettingsGUI.php.

                                      : void
    {
        $pl = $this->getPlugin();
 
        $pl->install();
        $this->update($pl);
    }

References getPlugin(), and update().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listPlugins()

ilObjComponentSettingsGUI::listPlugins ( )

protected

Definition at line 291 of file class.ilObjComponentSettingsGUI.php.

                                    : void
    {
        $this->tabs->activateTab(self::TAB_PLUGINS);
 
        $filters = new ilPluginsOverviewTableFilterGUI($this);
 
        $plugins = [];
        foreach ($this->component_repository->getPlugins() as $plugin) {
            $plugins[] = $plugin;
        }
 
        $table = new ilPluginsOverviewTable(
            $this,
            $this->ctrl,
            $this->ui,
            $this->renderer,
            $this->lng,
            $filters->getData()
        );
 
        $table = $table->withData($plugins)->getTable();
 
        $this->tpl->setContent($filters->getHTML() . $table);
    }

References XapiProxy\$plugin, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), renderer(), ILIAS\Repository\tabs(), and ILIAS\Repository\ui().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refreshLanguages()

ilObjComponentSettingsGUI::refreshLanguages ( )

protected

Definition at line 185 of file class.ilObjComponentSettingsGUI.php.

                                         : void
    {
        try {
            $plugin_name = $this->request_wrapper->retrieve(self::P_PLUGIN_NAME, $this->refinery->kindlyTo()->string());
            $plugin = $this->component_repository->getPluginByName($plugin_name);
            $language_handler = new ilPluginLanguage($plugin);
            $language_handler->updateLanguages();
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("cmps_refresh_lng"), true);
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage("failure", $e->getMessage(), true);
        }
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References Vendor\Package\$e, XapiProxy\$plugin, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uninstallPlugin()

ilObjComponentSettingsGUI::uninstallPlugin ( )

protected

Definition at line 269 of file class.ilObjComponentSettingsGUI.php.

                                        : void
    {
        $pl = $this->getPlugin();
 
        try {
            $pl->uninstall();
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("cmps_plugin_deinstalled"), true);
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage("failure", $e->getMessage(), true);
        }
 
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References Vendor\Package\$e, ILIAS\Repository\ctrl(), getPlugin(), and ILIAS\Repository\lng().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjComponentSettingsGUI::update ( ilPlugin $plugin )

protected

Definition at line 173 of file class.ilObjComponentSettingsGUI.php.

                                               : void
    {
        try {
            $plugin->update();
            $this->tpl->setOnScreenMessage("success", $this->lng->txt("cmps_plugin_updated"), true);
        } catch (Exception $e) {
            $this->tpl->setOnScreenMessage("failure", $e->getMessage(), true);
        }
 
        $this->ctrl->redirectByClass(ilAdministrationGUI::class, self::CMD_JUMP_TO_PLUGIN_SLOT);
    }

References Vendor\Package\$e, XapiProxy\$plugin, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by installPlugin(), and updatePlugin().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updatePlugin()

ilObjComponentSettingsGUI::updatePlugin ( )

protected

Definition at line 227 of file class.ilObjComponentSettingsGUI.php.

                                     : void
    {
        $pl = $this->getPlugin();
        $this->update($pl);
    }

References getPlugin(), and update().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $component_factory

ilComponentFactory ilObjComponentSettingsGUI::$component_factory

protected

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

◆ $component_repository

ilComponentRepository ilObjComponentSettingsGUI::$component_repository

protected

Definition at line 56 of file class.ilObjComponentSettingsGUI.php.

◆ $db

ilDBInterface ilObjComponentSettingsGUI::$db

protected

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

◆ $error

ilErrorHandling ilObjComponentSettingsGUI::$error

protected

Definition at line 58 of file class.ilObjComponentSettingsGUI.php.

◆ $rbac_system

ilRbacSystem ilObjComponentSettingsGUI::$rbac_system

protected

Definition at line 54 of file class.ilObjComponentSettingsGUI.php.

◆ $refinery

ILIAS Refinery Factory ilObjComponentSettingsGUI::$refinery

protected

Definition at line 59 of file class.ilObjComponentSettingsGUI.php.

◆ $renderer

Renderer ilObjComponentSettingsGUI::$renderer

protected

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

◆ $request_wrapper

ILIAS HTTP Wrapper RequestWrapper ilObjComponentSettingsGUI::$request_wrapper

protected

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

◆ $tabs

ilTabsGUI ilObjComponentSettingsGUI::$tabs

protected

Definition at line 53 of file class.ilObjComponentSettingsGUI.php.

◆ $ui

Factory ilObjComponentSettingsGUI::$ui

protected

Definition at line 61 of file class.ilObjComponentSettingsGUI.php.

◆ CMD_ACTIVATE_PLUGIN

const ilObjComponentSettingsGUI::CMD_ACTIVATE_PLUGIN = "activatePlugin"

Definition at line 38 of file class.ilObjComponentSettingsGUI.php.

Referenced by executeCommand(), ilPluginsOverviewTable\getActions(), and getUnsafeGetCommands().

◆ CMD_CONFIGURE

const ilObjComponentSettingsGUI::CMD_CONFIGURE = "configure"

Definition at line 36 of file class.ilObjComponentSettingsGUI.php.

Referenced by ilPluginsOverviewTable\getActions().

◆ CMD_CONFIRM_UNINSTALL_PLUGIN

const ilObjComponentSettingsGUI::CMD_CONFIRM_UNINSTALL_PLUGIN = "confirmUninstallPlugin"

Definition at line 43 of file class.ilObjComponentSettingsGUI.php.

Referenced by executeCommand(), and ilPluginsOverviewTable\getActions().

◆ CMD_DEACTIVATE_PLUGIN

const ilObjComponentSettingsGUI::CMD_DEACTIVATE_PLUGIN = "deactivatePlugin"

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

Referenced by executeCommand(), ilPluginsOverviewTable\getActions(), and getUnsafeGetCommands().

◆ CMD_DEFAULT

const ilObjComponentSettingsGUI::CMD_DEFAULT = "listPlugins"

Definition at line 34 of file class.ilObjComponentSettingsGUI.php.

◆ CMD_INSTALL_PLUGIN

const ilObjComponentSettingsGUI::CMD_INSTALL_PLUGIN = "installPlugin"

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

Referenced by executeCommand(), and ilPluginsOverviewTable\getActions().

◆ CMD_JUMP_TO_PLUGIN_SLOT

const ilObjComponentSettingsGUI::CMD_JUMP_TO_PLUGIN_SLOT = "jumpToPluginSlot"

Definition at line 41 of file class.ilObjComponentSettingsGUI.php.

◆ CMD_REFRESH_LANGUAGES

const ilObjComponentSettingsGUI::CMD_REFRESH_LANGUAGES = "refreshLanguages"

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

Referenced by executeCommand(), ilPluginsOverviewTable\getActions(), and getUnsafeGetCommands().

◆ CMD_UNINSTALL_PLUGIN

const ilObjComponentSettingsGUI::CMD_UNINSTALL_PLUGIN = "uninstallPlugin"

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

Referenced by executeCommand().

◆ CMD_UPDATE_PLUGIN

const ilObjComponentSettingsGUI::CMD_UPDATE_PLUGIN = "updatePlugin"

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

Referenced by executeCommand(), ilPluginsOverviewTable\getActions(), and getUnsafeGetCommands().

◆ P_ADMIN_MODE

const ilObjComponentSettingsGUI::P_ADMIN_MODE = 'admin_mode'

Definition at line 51 of file class.ilObjComponentSettingsGUI.php.

◆ P_CNAME

const ilObjComponentSettingsGUI::P_CNAME = "cname"

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

Referenced by ilPluginsOverviewTable\clearParameter(), and ilPluginsOverviewTable\setParameter().

◆ P_CTYPE

const ilObjComponentSettingsGUI::P_CTYPE = "ctype"

Definition at line 46 of file class.ilObjComponentSettingsGUI.php.

Referenced by ilPluginsOverviewTable\clearParameter(), and ilPluginsOverviewTable\setParameter().

◆ P_PLUGIN_ID

const ilObjComponentSettingsGUI::P_PLUGIN_ID = "plugin_id"

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

Referenced by ilPluginsOverviewTable\setParameter().

◆ P_PLUGIN_NAME

const ilObjComponentSettingsGUI::P_PLUGIN_NAME = "pname"

Definition at line 49 of file class.ilObjComponentSettingsGUI.php.

Referenced by ilPluginsOverviewTable\clearParameter(), and ilPluginsOverviewTable\setParameter().

◆ P_REF_ID

const ilObjComponentSettingsGUI::P_REF_ID = 'ref_id'

Definition at line 45 of file class.ilObjComponentSettingsGUI.php.

◆ P_SLOT_ID

const ilObjComponentSettingsGUI::P_SLOT_ID = "slot_id"

Definition at line 48 of file class.ilObjComponentSettingsGUI.php.

Referenced by ilPluginsOverviewTable\clearParameter(), and ilPluginsOverviewTable\setParameter().

◆ TAB_PERMISSION

const ilObjComponentSettingsGUI::TAB_PERMISSION = "perm_settings"

private

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

◆ TAB_PLUGINS

const ilObjComponentSettingsGUI::TAB_PLUGINS = "plugins"

private

Definition at line 31 of file class.ilObjComponentSettingsGUI.php.

◆ TYPE

const ilObjComponentSettingsGUI::TYPE = 'cmps'

private

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

Referenced by __construct().

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

components/ILIAS/Component/classes/Settings/class.ilObjComponentSettingsGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activatePlugin()

◆ confirmUninstallPlugin()

◆ deactivatePlugin()

◆ executeCommand()

◆ forwardConfigGUI()

◆ getAdminTabs()

◆ getPlugin()

◆ getSafePostCommands()

◆ getUnsafeGetCommands()

◆ installPlugin()

◆ listPlugins()

◆ refreshLanguages()

◆ uninstallPlugin()

◆ update()

◆ updatePlugin()

Field Documentation

◆ $component_factory

◆ $component_repository

◆ $db

◆ $error

◆ $rbac_system

◆ $refinery

◆ $renderer

◆ $request_wrapper

◆ $tabs

◆ $ui

◆ CMD_ACTIVATE_PLUGIN

◆ CMD_CONFIGURE

◆ CMD_CONFIRM_UNINSTALL_PLUGIN

◆ CMD_DEACTIVATE_PLUGIN

◆ CMD_DEFAULT

◆ CMD_INSTALL_PLUGIN

◆ CMD_JUMP_TO_PLUGIN_SLOT

◆ CMD_REFRESH_LANGUAGES

◆ CMD_UNINSTALL_PLUGIN

◆ CMD_UPDATE_PLUGIN

◆ P_ADMIN_MODE

◆ P_CNAME

◆ P_CTYPE

◆ P_PLUGIN_ID

◆ P_PLUGIN_NAME

◆ P_REF_ID

◆ P_SLOT_ID

◆ TAB_PERMISSION

◆ TAB_PLUGINS

◆ TYPE