Components (Modules, Services, Plugins) Settings. More...

Inheritance diagram for ilObjComponentSettingsGUI:

Collaboration diagram for ilObjComponentSettingsGUI:

Public Member Functions
	__construct ($a_data, int $a_id, bool $a_call_by_reference=true, bool $a_prepare_output=true)
	ilObjComponentSettingsGUI constructor. More...

	executeCommand ()
	Execute command @access public. More...

	getAdminTabs ()
	Get tabs @access public. More...

Public Member Functions inherited from ilObjectGUI
	executeCommand ()
	execute command More...

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

	setCreationMode ($a_mode=true)
	if true, a creation screen is displayed the current $_GET[ref_id] don't belong to the current class! the mode is determined in ilrepositorygui More...

	getCreationMode ()
	get creation mode More...

	prepareOutput ($a_show_subobjects=true)
	prepare output More...

	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...

	cancelDeleteObject ()
	cancel deletion of object More...

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

	createObject ()
	create new object form More...

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

	saveObject ()
	save object More...

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

	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()
	edit object More...

	addExternalEditFormCustom (ilPropertyFormGUI $a_form)

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

	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g. More...

	isVisible ($a_ref_id, $a_type)

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

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

	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI. More...

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

	addToDeskObject ()
	@inheritDoc More...

	removeFromDeskObject ()
	@inheritDoc More...

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

Data Fields
const	CMD_DEFAULT = "listPlugins"

const	CMD_LIST_SLOTS = "listSlots"

const	TAB_PLUGINS = "plugins"

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	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	CMD_SHOW_PLUGIN = "showPlugin"

const	CMD_JUMP_TO_PLUGIN_SLOT = "jumpToPluginSlot"

const	CMD_UNINSTALL_PLUGIN = "uninstallPlugin"

const	CMD_CONFIRM_UNINSTALL_PLUGIN = "confirmUninstallPlugin"

const	TAB_SLOTS = 'slots'

Data Fields inherited from ilObjectGUI
const	ALLOWED_TAGS_IN_TITLE_AND_DESCRIPTION

const	COPY_WIZARD_NEEDS_PAGE = 1

	$objDefinition

	$tpl

	$tree

	$lng

	$data

	$object

	$ref_id

	$obj_id

	$maxcount

	$formaction

	$return_location

	$target_frame

	$tab_target_script

	$actions

	$sub_objects

	$omit_locator = false

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

Protected Member Functions
	listSlots ()

	listPlugins ()

	showPluginSlotInfo ()

	showPlugin ()

	installPlugin ()

	activatePlugin ()

	updatePlugin ()

	update (ilPlugin $plugin)

	deactivatePlugin ()

	refreshLanguages ()

	confirmUninstallPlugin ()

	uninstallPlugin ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...

	assignObject ()

	setTitleAndDescription ()
	called by prepare output More...

	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...

	insertHeaderAction ($a_list_gui)
	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 @access public More...

	setAdminTabs ()
	set admin tabs @access public More...

	setLocator ()
	set Locator More...

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

	omitLocator ($a_omit=true)

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

	initCreationForms ($a_new_type)
	Init creation froms. More...

	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion) More...

	initCreateForm ($a_new_type)
	Init object creation form. More...

	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types. More...

	addDidacticTemplateOptions (array &$a_options)
	Add custom templates. More...

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

	initEditForm ()
	Init object edit form. More...

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

	getEditFormValues ()
	Get values for edit form. More...

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

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

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

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

	initImportForm ($a_new_type)
	Init object import form. More...

	importFileObject ($parent_id=null, $a_catch_errors=true)
	Import. More...

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

	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command More...

	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command More...

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

	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command More...

	showPossibleSubObjects ()
	show possible subobjects (pulldown menu) More...

	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl. More...

	getTabs ()
	get tabs abstract method. More...

	__showButton ($a_cmd, $a_text, $a_target='')

	hitsperpageObject ()

&	__initTableGUI ()

	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table More...

	redirectToRefId ($a_ref_id, $a_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 $_GET["ref_id"] value More...

	fillCloneTemplate ($a_tpl_varname, $a_type)
	Fill object clone template This method can be called from any object GUI class that wants to offer object cloning. More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	setColumnSettings (ilColumnGUI $column_gui)
	May be overwritten in subclasses. More...

	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error. More...

	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission. More...

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

	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting. More...

Protected Attributes
	$type

	$tabs

	$rbac_system

	$db

Protected Attributes inherited from ilObjectGUI
const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

	$ilErr

	$locator

	$user

	$access

	$rbacsystem

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

	$favourites

	$request

Private Attributes
const	TYPE = 'cmps'

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

static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root. More...

Detailed Description

Components (Modules, Services, Plugins) Settings.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e @ilCtrl_Calls ilObjComponentSettingsGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjComponentSettingsGUI::__construct	(		$a_data,
		int	$a_id,
		bool	$a_call_by_reference = `true`,
		bool	$a_prepare_output = `true`
	)

ilObjComponentSettingsGUI constructor.

Parameters

	$a_data
	$a_id
bool	$a_call_by_reference
bool	$a_prepare_output

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

    {
        global $DIC;
        $this->tabs        = $DIC->tabs();
        $this->ctrl        = $DIC->ctrl();
        $this->rbac_system = $DIC->rbac()->system();
        $this->db          = $DIC->database();
        $this->type        = self::TYPE;
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
        $this->lng->loadLanguageModule(self::TYPE);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and TYPE.

Here is the call graph for this function:

Member Function Documentation

◆ activatePlugin()

ilObjComponentSettingsGUI::activatePlugin ( )

protected

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

                                        : void
    {
        $pl = ilPlugin::getPluginObject(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        try {
            $result = $pl->activate();
            if ($result !== true) {
                ilUtil::sendFailure($result, true);
            } else {
                ilUtil::sendSuccess($this->lng->txt("cmps_plugin_activated"), true);
            }
        } catch (ilPluginException $e) {
            ilUtil::sendFailure($e->getMessage(), true);
        }
 
        $this->ctrl->setParameter($this, self::P_CTYPE, $_GET[self::P_CTYPE]);
        $this->ctrl->setParameter($this, self::P_CNAME, $_GET[self::P_CNAME]);
        $this->ctrl->setParameter($this, self::P_SLOT_ID, $_GET[self::P_SLOT_ID]);
 
        if ($_GET[self::P_PLUGIN_ID]) {
            $this->ctrl->setParameter($this, self::P_PLUGIN_ID, $_GET[self::P_PLUGIN_ID]);
            $this->ctrl->redirect($this, self::CMD_SHOW_PLUGIN);
        } else {
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
    }

References $_GET, Vendor\Package\$e, $result, ilPlugin\getPluginObject(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ confirmUninstallPlugin()

ilObjComponentSettingsGUI::confirmUninstallPlugin ( )

protected

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

                                                : void
    {
        global $DIC;
        $ilPluginAdmin = $DIC['ilPluginAdmin'];
 
        $pl = ilPlugin::getPluginObject(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        $pl_meta = $ilPluginAdmin->getAllData(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        $activation = ((bool) $pl_meta["activation_possible"] || (bool) $pl_meta["is_active"]); // #18827
        $reason     = $pl_meta["inactive_reason"];
 
        $question = $activation
            ? sprintf($this->lng->txt("cmps_uninstall_confirm"), $pl->getPluginName())
            : sprintf($this->lng->txt("cmps_uninstall_inactive_confirm"), $pl->getPluginName(), $reason);
 
        $this->ctrl->setParameter($this, self::P_CTYPE, $_GET[self::P_CTYPE]);
        $this->ctrl->setParameter($this, self::P_CNAME, $_GET[self::P_CNAME]);
        $this->ctrl->setParameter($this, self::P_SLOT_ID, $_GET[self::P_SLOT_ID]);
        $this->ctrl->setParameter($this, self::P_PLUGIN_NAME, $_GET[self::P_PLUGIN_NAME]);
 
        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($this->ctrl->getFormAction($this));
        $confirmation_gui->setHeaderText($question);
        $confirmation_gui->setCancel($this->lng->txt("cancel"), self::CMD_DEFAULT);
        $confirmation_gui->setConfirm($this->lng->txt("cmps_uninstall"), self::CMD_UNINSTALL_PLUGIN);
 
        $this->tpl->setContent($confirmation_gui->getHTML());
    }

References $_GET, $DIC, and ilPlugin\getPluginObject().

Here is the call graph for this function:

◆ deactivatePlugin()

ilObjComponentSettingsGUI::deactivatePlugin ( )

protected

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

                                          : void
    {
        $pl = ilPlugin::getPluginObject(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        $result = $pl->deactivate();
 
        if ($result !== true) {
            ilUtil::sendFailure($result, true);
        } else {
            ilUtil::sendSuccess($this->lng->txt("cmps_plugin_deactivated"), true);
        }
 
        $this->ctrl->setParameter($this, self::P_CTYPE, $_GET[self::P_CTYPE]);
        $this->ctrl->setParameter($this, self::P_CNAME, $_GET[self::P_CNAME]);
        $this->ctrl->setParameter($this, self::P_SLOT_ID, $_GET[self::P_SLOT_ID]);
 
        if ($_GET[self::P_PLUGIN_ID]) {
            $this->ctrl->setParameter($this, self::P_PLUGIN_ID, $_GET[self::P_PLUGIN_ID]);
            $this->ctrl->redirect($this, self::CMD_SHOW_PLUGIN);
        } else {
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
    }

References $_GET, $result, ilPlugin\getPluginObject(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ executeCommand()

ilObjComponentSettingsGUI::executeCommand ( )

Execute command @access public.

Reimplemented from ilObjectGUI.

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

    {
        global $DIC;
        $ilErr = $DIC['ilErr'];
 
        $next_class = $this->ctrl->getNextClass($this);
        $cmd        = $this->ctrl->getCmd();
 
        $this->prepareOutput();
 
        if (!$this->rbac_system->checkAccess('read', $this->object->getRefId())) {
            $ilErr->raiseError($this->lng->txt('no_permission'), $ilErr->WARNING);
        }
 
        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs->activateTab('perm_settings');
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
 
            default:
 
                // configure classes
                $config = false;
                if (strtolower(substr($next_class, strlen($next_class) - 9)) === "configgui") {
                    $path = $this->ctrl->lookupClassPath(strtolower($next_class));
                    if ($path != "") {
                        include_once($path);
                        $nc = new $next_class();
 
                        $pl = ilPluginAdmin::getPluginObject(
                            $_GET[self::P_CTYPE],
                            $_GET[self::P_CNAME],
                            $_GET[self::P_SLOT_ID],
                            $_GET[self::P_PLUGIN_NAME]
                        );
 
                        $nc->setPluginObject($pl);
 
                        $this->ctrl->forwardCommand($nc);
                        $config = true;
                    }
                }
 
                if (!$config) {
                    if (!$cmd || $cmd === 'view') {
                        $cmd = self::CMD_DEFAULT;
                    }
 
                    $this->$cmd();
                }
                break;
        }
        return true;
    }

References $_GET, $config, $DIC, ilObjectGUI\$ilErr, CMD_DEFAULT, ilPluginAdmin\getPluginObject(), and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ getAdminTabs()

ilObjComponentSettingsGUI::getAdminTabs ( )

Get tabs @access public.

Reimplemented from ilObjectGUI.

Definition at line 134 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 (DEVMODE) {
                $this->tabs_gui->addTab(
                    self::TAB_SLOTS,
                    $this->lng->txt("cmps_slots"),
                    $this->ctrl->getLinkTarget($this, self::CMD_LIST_SLOTS)
                );
            }
        }
 
        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 ($_GET[self::P_CTYPE] === "Services") {
            $this->tabs_gui->activateTab("services");
        }
    }

References $_GET.

◆ installPlugin()

ilObjComponentSettingsGUI::installPlugin ( )

protected

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

                                       : void
    {
        $pl = ilPlugin::getPluginObject(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        $pl->install();
        $this->update($pl);
    }

References $_GET, ilPlugin\getPluginObject(), and update().

Here is the call graph for this function:

◆ listPlugins()

ilObjComponentSettingsGUI::listPlugins ( )

protected

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

                                     : void
    {
        $this->tabs->activateTab(self::TAB_PLUGINS);
 
        $filters = new ilPluginsOverviewTableFilterGUI($this);
        $table   = new ilPluginsOverviewTableGUI($this, $filters->getData(), self::CMD_DEFAULT);
 
        $this->tpl->setContent($filters->getHTML() . $table->getHTML());
    }

◆ listSlots()

ilObjComponentSettingsGUI::listSlots ( )

protected

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

                                   : void
    {
        if (!DEVMODE) {
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        $this->tabs_gui->activateTab(self::TAB_SLOTS);
        $comp_table = new ilComponentsTableGUI($this, self::CMD_LIST_SLOTS);
        $this->tpl->setContent($comp_table->getHTML());
    }

◆ refreshLanguages()

ilObjComponentSettingsGUI::refreshLanguages ( )

protected

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

                                          : void
    {
        $pl = ilPlugin::getPluginObject(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        $pl->updateLanguages();
 
        $this->ctrl->setParameter($this, self::P_CTYPE, $_GET[self::P_CTYPE]);
        $this->ctrl->setParameter($this, self::P_CNAME, $_GET[self::P_CNAME]);
        $this->ctrl->setParameter($this, self::P_SLOT_ID, $_GET[self::P_SLOT_ID]);
 
        if ($_GET[self::P_PLUGIN_ID]) {
            $this->ctrl->setParameter($this, self::P_PLUGIN_ID, $_GET[self::P_PLUGIN_ID]);
            $this->ctrl->redirect($this, self::CMD_SHOW_PLUGIN);
        } else {
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
    }

References $_GET, and ilPlugin\getPluginObject().

Here is the call graph for this function:

◆ showPlugin()

ilObjComponentSettingsGUI::showPlugin ( )

protected

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

                                    : void
    {
 
        if (!$_GET[self::P_CTYPE] ||
            !$_GET[self::P_CNAME] ||
            !$_GET[self::P_SLOT_ID] ||
            !$_GET[self::P_PLUGIN_ID]) {
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        $slot = new ilPluginSlot($_GET[self::P_CTYPE], $_GET[self::P_CNAME], $_GET[self::P_SLOT_ID]);
 
        $plugin = null;
        foreach ($slot->getPluginsInformation() as $item) {
            if ($item["id"] === $_GET[self::P_PLUGIN_ID]) {
                $plugin = $item;
                break;
            }
        }
        if (!$plugin) {
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt("cmps_plugins"),
            $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
        );
 
        $this->ctrl->setParameter($this, self::P_CTYPE, $_GET[self::P_CTYPE]);
        $this->ctrl->setParameter($this, self::P_CNAME, $_GET[self::P_CNAME]);
        $this->ctrl->setParameter($this, self::P_SLOT_ID, $_GET[self::P_SLOT_ID]);
        $this->ctrl->setParameter($this, self::P_PLUGIN_ID, $_GET[self::P_PLUGIN_ID]);
        $this->ctrl->setParameter($this, self::P_PLUGIN_NAME, $plugin["name"]);
 
        $langs = ilPlugin::getAvailableLangFiles($slot->getPluginsDirectory() . "/" .
            $plugin["name"] . "/lang");
 
        // dbupdate
        $file    = ilPlugin::getDBUpdateScriptName(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            ilPluginSlot::lookupSlotName($_GET[self::P_CTYPE], $_GET[self::P_CNAME], $_GET[self::P_SLOT_ID]),
            $plugin["name"]
        );
        $db_curr = $db_file = null;
        if (@is_file($file)) {
            include_once("./Services/Component/classes/class.ilPluginDBUpdate.php");
            $dbupdate = new ilPluginDBUpdate(
                $_GET[self::P_CTYPE],
                $_GET[self::P_CNAME],
                $_GET[self::P_SLOT_ID],
                $plugin["name"],
                $this->db,
                true,
                ""
            );
 
            $db_curr = $dbupdate->getCurrentVersion();
            $db_file = $dbupdate->getFileVersion();
        }
 
        $plugin_db_data = ilPlugin::getPluginRecord($plugin["component_type"], $plugin["component_name"], $plugin[self::P_SLOT_ID], $plugin["name"]);
 
        // toolbar actions
        if ($plugin["must_install"]) {
            $this->toolbar->addButton(
                $this->lng->txt("cmps_install"),
                $this->ctrl->getLinkTarget($this, self::CMD_INSTALL_PLUGIN)
            );
        } else {
            // configure button
            if (ilPlugin::hasConfigureClass($slot->getPluginsDirectory(), $plugin, $plugin_db_data) &&
                $this->ctrl->checkTargetClass(ilPlugin::getConfigureClassName($plugin))) {
                $this->toolbar->addButton(
                    $this->lng->txt("cmps_configure"),
                    $this->ctrl->getLinkTargetByClass(strtolower(ilPlugin::getConfigureClassName($plugin)), self::CMD_CONFIGURE)
                );
            }
            // refresh languages button
            if (count($langs) > 0) {
                $this->toolbar->addButton(
                    $this->lng->txt("cmps_refresh"),
                    $this->ctrl->getLinkTarget($this, self::CMD_REFRESH_LANGUAGES)
                );
            }
 
            if ($plugin["activation_possible"]) {
                $this->toolbar->addButton(
                    $this->lng->txt("cmps_activate"),
                    $this->ctrl->getLinkTarget($this, self::CMD_ACTIVATE_PLUGIN)
                );
            }
 
            // deactivation/refresh languages button
            if ($plugin["is_active"]) {
                // deactivate button
                $this->toolbar->addButton(
                    $this->lng->txt("cmps_deactivate"),
                    $this->ctrl->getLinkTarget($this, self::CMD_DEACTIVATE_PLUGIN)
                );
            }
 
            // update button
            if ($plugin["needs_update"]) {
                $this->toolbar->addButton(
                    $this->lng->txt("cmps_update"),
                    $this->ctrl->getLinkTarget($this, self::CMD_UPDATE_PLUGIN)
                );
            }
        }
 
        // info
        $resp = array();
        if ($plugin["responsible"] != '') {
            $responsibles = explode('/', $plugin["responsible_mail"]);
            foreach ($responsibles as $responsible) {
                if (!strlen($responsible = trim($responsible))) {
                    continue;
                }
 
                $resp[] = $responsible;
            }
 
            $resp = $plugin["responsible"] . " (" . implode(" / ", $resp) . ")";
        }
 
        if ($plugin["is_active"]) {
            $status = $this->lng->txt("cmps_active");
        } else {
            $r = ($plugin["inactive_reason"] != "")
                ? " (" . $plugin["inactive_reason"] . ")"
                : "";
 
            $status = $this->lng->txt("cmps_inactive") . $r;
        }
 
        $info[""][$this->lng->txt("cmps_name")]    = $plugin["name"];
        $info[""][$this->lng->txt("cmps_id")]      = $plugin["id"];
        $info[""][$this->lng->txt("cmps_version")] = $plugin["version"];
        if ($resp) {
            $info[""][$this->lng->txt("cmps_responsible")] = $resp;
        }
        $info[""][$this->lng->txt("cmps_ilias_min_version")] = $plugin["ilias_min_version"];
        $info[""][$this->lng->txt("cmps_ilias_max_version")] = $plugin["ilias_max_version"];
        $info[""][$this->lng->txt("cmps_status")]            = $status;
 
        if (sizeof($langs)) {
            $lang_files = array();
            foreach ($langs as $lang) {
                $lang_files[] = $lang["file"];
            }
            $info[""][$this->lng->txt("cmps_languages")] = implode(", ", $lang_files);
        } else {
            $info[""][$this->lng->txt("cmps_languages")] = $this->lng->txt("cmps_no_language_file_available");
        }
 
        $info[$this->lng->txt("cmps_basic_files")]["plugin.php"]                       = $plugin["plugin_php_file_status"] ?
            $this->lng->txt("cmps_available") :
            $this->lng->txt("cmps_missing");
        $info[$this->lng->txt("cmps_basic_files")][$this->lng->txt("cmps_class_file")] = ($plugin["class_file_status"] ?
                $this->lng->txt("cmps_available") :
                $this->lng->txt("cmps_missing")) .
            " (" . $plugin["class_file"] . ")";
 
        if (!$db_file) {
            $info[$this->lng->txt("cmps_database")][$this->lng->txt("file")] = $this->lng->txt("cmps_no_db_update_file_available");
        } else {
            $info[$this->lng->txt("cmps_database")][$this->lng->txt("file")]                 = "dbupdate.php";
            $info[$this->lng->txt("cmps_database")][$this->lng->txt("cmps_current_version")] = $db_curr;
            $info[$this->lng->txt("cmps_database")][$this->lng->txt("cmps_file_version")]    = $db_file;
        }
 
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt("cmps_plugin"));
 
        foreach ($info as $section => $items) {
            if (trim($section)) {
                $sec = new ilFormSectionHeaderGUI();
                $sec->setTitle($section);
                $form->addItem($sec);
            }
            foreach ($items as $key => $value) {
                $non = new ilNonEditableValueGUI($key);
                $non->setValue($value);
                $form->addItem($non);
            }
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References $_GET, $lang, XapiProxy\$plugin, XapiProxy\$resp, $section, ilPlugin\getAvailableLangFiles(), ilPlugin\getConfigureClassName(), ilPlugin\getDBUpdateScriptName(), ilPlugin\getPluginRecord(), ilPlugin\hasConfigureClass(), and ilPluginSlot\lookupSlotName().

Here is the call graph for this function:

◆ showPluginSlotInfo()

ilObjComponentSettingsGUI::showPluginSlotInfo ( )

protected

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

                                            : void
    {
        if (!DEVMODE) {
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        $this->tabs->clearTargets();
 
        $this->tabs->setBackTarget(
            $this->lng->txt("cmps_slots"),
            $this->ctrl->getLinkTarget($this, self::CMD_LIST_SLOTS)
        );
 
        $comp = ilComponent::getComponentObject($_GET[self::P_CTYPE], $_GET[self::P_CNAME]);
 
        $form = new ilPropertyFormGUI();
 
        // component
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_component"), "", true);
        $ne->setValue($comp->getComponentType() . "/" . $comp->getName() . " [" . $comp->getId() . "]");
        $form->addItem($ne);
 
        // plugin slot
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_plugin_slot"), "", true);
        $ne->setValue($comp->getPluginSlotName($_GET[self::P_SLOT_ID]) . " [" . $_GET[self::P_SLOT_ID] . "]");
        $form->addItem($ne);
 
        // main dir
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_main_dir"), "", true);
        $ne->setValue($comp->getPluginSlotDirectory($_GET[self::P_SLOT_ID]) . "/&lt;Plugin_Name&gt;");
        $form->addItem($ne);
 
        // plugin file
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_plugin_file"), "", true);
        $ne->setValue("&lt;" . $this->lng->txt("cmps_main_dir") . "&gt;" .
            "/classes/class.il&lt;Plugin_Name&gt;Plugin.php");
        $form->addItem($ne);
 
        // language files
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_lang_files"), "", true);
        $ne->setValue("&lt;" . $this->lng->txt("cmps_main_dir") . "&gt;" .
            "/lang/ilias_&lt;Language ID&gt;.lang");
        $form->addItem($ne);
 
        // db update
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_db_update"), "", true);
        $ne->setValue("&lt;" . $this->lng->txt("cmps_main_dir") . "&gt;" .
            "/sql/dbupdate.php");
        $form->addItem($ne);
 
        // lang prefix
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_plugin_lang_prefixes"), "", true);
        $ne->setValue($comp->getPluginSlotLanguagePrefix($_GET[self::P_SLOT_ID]) . "&lt;Plugin_ID&gt;_");
        $form->addItem($ne);
 
        // db prefix
        $ne = new ilNonEditableValueGUI($this->lng->txt("cmps_plugin_db_prefixes"), "", true);
        $ne->setValue($comp->getPluginSlotLanguagePrefix($_GET[self::P_SLOT_ID]) . "&lt;Plugin_ID&gt;_");
        $form->addItem($ne);
 
        $form->setTitle($this->lng->txt("cmps_plugin_slot"));
 
        // set content and title
        $this->tpl->setContent($form->getHTML());
        $this->tpl->setTitle($comp->getComponentType() . "/" . $comp->getName() . ": " .
            $this->lng->txt("cmps_plugin_slot") . " \"" . $comp->getPluginSlotName($_GET[self::P_SLOT_ID]) . "\"");
        $this->tpl->setDescription("");
    }

References $_GET, and ilComponent\getComponentObject().

Here is the call graph for this function:

◆ uninstallPlugin()

ilObjComponentSettingsGUI::uninstallPlugin ( )

protected

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

                                         : void
    {
        $pl = ilPlugin::getPluginObject(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        try {
            $result = $pl->uninstall();
            if ($result !== true) {
                ilUtil::sendFailure($result, true);
            } else {
                ilUtil::sendSuccess($this->lng->txt("cmps_plugin_uninstalled"), true);
            }
        } catch (ilPluginException $e) {
            ilUtil::sendFailure($e->getMessage(), true);
        }
 
        ilGlobalCache::flushAll();
        $ilPluginsOverviewTableGUI = new ilPluginsOverviewTableGUI($this, []);
 
        $this->ctrl->setParameter($this, self::P_CTYPE, $_GET[self::P_CTYPE]);
        $this->ctrl->setParameter($this, self::P_CNAME, $_GET[self::P_CNAME]);
        $this->ctrl->setParameter($this, self::P_SLOT_ID, $_GET[self::P_SLOT_ID]);
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References $_GET, Vendor\Package\$e, $result, ilPlugin\getPluginObject(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ update()

ilObjComponentSettingsGUI::update ( ilPlugin $plugin )

protected

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

                                                : void
    {
        $result = $plugin->update();
 
        if ($result !== true) {
            ilUtil::sendFailure($plugin->getMessage(), true);
        } else {
            ilUtil::sendSuccess($plugin->getMessage(), true);
        }
 
        // reinitialize control class
        $_GET["cmd"] = self::CMD_JUMP_TO_PLUGIN_SLOT;
        $this->ctrl->initBaseClass(ilAdministrationGUI::class);
        $this->ctrl->setParameterByClass(ilAdministrationGUI::class, self::P_CTYPE, $_GET[self::P_CTYPE]);
        $this->ctrl->setParameterByClass(ilAdministrationGUI::class, self::P_CNAME, $_GET[self::P_CNAME]);
        $this->ctrl->setParameterByClass(ilAdministrationGUI::class, self::P_SLOT_ID, $_GET[self::P_SLOT_ID]);
        $this->ctrl->setParameterByClass(ilAdministrationGUI::class, self::P_PLUGIN_ID, $_GET[self::P_PLUGIN_ID]);
        ilUtil::redirect("ilias.php?admin_mode=settings&baseClass=ilAdministrationGUI" .
            "&cmd=jumpToPluginSlot&ref_id=" . $_GET["ref_id"] . "&ctype=" . $_GET[self::P_CTYPE] .
            "&cname=" . $_GET[self::P_CNAME] . "&slot_id=" . $_GET[self::P_SLOT_ID] . "&plugin_id=" . $_GET[self::P_PLUGIN_ID]);
    }

References $_GET, XapiProxy\$plugin, $result, CMD_JUMP_TO_PLUGIN_SLOT, ilUtil\redirect(), and ilUtil\sendFailure().

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 493 of file class.ilObjComponentSettingsGUI.php.

                                      : void
    {
        $pl = ilPlugin::getPluginObject(
            $_GET[self::P_CTYPE],
            $_GET[self::P_CNAME],
            $_GET[self::P_SLOT_ID],
            $_GET[self::P_PLUGIN_NAME]
        );
 
        $this->update($pl);
    }