ilObjComponentSettingsGUI Class Reference

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

Inheritance diagram for ilObjComponentSettingsGUI:

Collaboration diagram for ilObjComponentSettingsGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)
	Contructor. More...
	executeCommand ()
	Execute command. More...
	getAdminTabs ()
	Get tabs. More...
	listSlots ()
	List Services. 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 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 ()
	list childs of current object 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...

Protected Member Functions
	listPlugins ()
	List plugins. More...
	showPluginSlotInfo ()
	Show information about a plugin slot. More...
	showPlugin ()
	installPlugin ()
	Install a plugin. More...
	activatePlugin ()
	Activate a plugin. More...
	updatePlugin ()
	Update a plugin. More...
	update (ilPlugin $plugin)
	Execute update and ctrl reload. More...
	deactivatePlugin ()
	Deactivate a plugin. More...
	refreshLanguages ()
	Refresh Languages. More...
	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...
	showMountWebfolderIcon ()
	setTabs ()
	set admin tabs public More...
	setAdminTabs ()
	set admin tabs 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...

Static Private Attributes
static	$ERROR_MESSAGE

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...
Data Fields inherited from ilObjectGUI
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 Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$tmp_import_dir
	$tabs_gui = null
	$ctrl
	$object_service

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

Version

$Id$

ilObjComponentSettingsGUI: ilPermissionGUI

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

Constructor & Destructor Documentation

__construct()

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

Contructor.

public

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

    {
        $this->type = 'cmps';
        parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);

        $this->lng->loadLanguageModule('cmps');
    }

Member Function Documentation

activatePlugin()

ilObjComponentSettingsGUI::activatePlugin ( )

protected

Activate a plugin.

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

References $_GET, $DIC, $ilCtrl, ilObjectGUI\$lng, $result, ilPlugin\getPluginObject(), and ilUtil\sendFailure().

    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();

        include_once("./Services/Component/classes/class.ilPlugin.php");
        $pl = ilPlugin::getPluginObject(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        try {
            $result = $pl->activate();
            if ($result !== true) {
                ilUtil::sendFailure($result, true);
            } else {
                ilUtil::sendSuccess($lng->txt("cmps_plugin_activated"), true);
            }
        } catch (ilPluginException $e) {
            ilUtil::sendFailure($e->getMessage(), true);
        }

        $ilCtrl->setParameter($this, "ctype", $_GET["ctype"]);
        $ilCtrl->setParameter($this, "cname", $_GET["cname"]);
        $ilCtrl->setParameter($this, "slot_id", $_GET["slot_id"]);

        if ($_GET["plugin_id"]) {
            $ilCtrl->setParameter($this, "plugin_id", $_GET["plugin_id"]);
            $ilCtrl->redirect($this, "showPlugin");
        } else {
            $ilCtrl->redirect($this, "listPlugins");
        }
    }

Here is the call graph for this function:

confirmUninstallPlugin()

ilObjComponentSettingsGUI::confirmUninstallPlugin ( )

protected

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

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

    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $tpl = $DIC->ui()->mainTemplate();
        $ilPluginAdmin = $DIC['ilPluginAdmin'];

        include_once("./Services/Component/classes/class.ilPlugin.php");
        $pl = ilPlugin::getPluginObject(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        $pl_meta = $ilPluginAdmin->getAllData(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        $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);

        $ilCtrl->setParameter($this, "ctype", $_GET["ctype"]);
        $ilCtrl->setParameter($this, "cname", $_GET["cname"]);
        $ilCtrl->setParameter($this, "slot_id", $_GET["slot_id"]);
        $ilCtrl->setParameter($this, "pname", $_GET["pname"]);

        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($ilCtrl->getFormAction($this));
        $confirmation_gui->setHeaderText($question);
        $confirmation_gui->setCancel($this->lng->txt("cancel"), "listPlugins");
        $confirmation_gui->setConfirm($this->lng->txt("cmps_uninstall"), "uninstallPlugin");

        $tpl->setContent($confirmation_gui->getHTML());
    }

Here is the call graph for this function:

deactivatePlugin()

ilObjComponentSettingsGUI::deactivatePlugin ( )

protected

Deactivate a plugin.

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

References $_GET, $DIC, $ilCtrl, ilObjectGUI\$lng, $result, ilPlugin\getPluginObject(), and ilUtil\sendFailure().

    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();

        include_once("./Services/Component/classes/class.ilPlugin.php");
        $pl = ilPlugin::getPluginObject(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        $result = $pl->deactivate();

        if ($result !== true) {
            ilUtil::sendFailure($result, true);
        } else {
            ilUtil::sendSuccess($lng->txt("cmps_plugin_deactivated"), true);
        }

        $ilCtrl->setParameter($this, "ctype", $_GET["ctype"]);
        $ilCtrl->setParameter($this, "cname", $_GET["cname"]);
        $ilCtrl->setParameter($this, "slot_id", $_GET["slot_id"]);

        if ($_GET["plugin_id"]) {
            $ilCtrl->setParameter($this, "plugin_id", $_GET["plugin_id"]);
            $ilCtrl->redirect($this, "showPlugin");
        } else {
            $ilCtrl->redirect($this, "listPlugins");
        }
    }

Here is the call graph for this function:

executeCommand()

ilObjComponentSettingsGUI::executeCommand

(

)

Execute command.

public

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

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

    {
        global $DIC;
        $rbacsystem = $DIC->rbac()->system();
        $ilErr = $DIC['ilErr'];
        $ilCtrl = $DIC->ctrl();

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        if (!$rbacsystem->checkAccess('read', $this->object->getRefId())) {
            $ilErr->raiseError($this->lng->txt('no_permission'), $ilErr->WARNING);
        }

        switch ($next_class) {
            case 'ilpermissiongui':
                $this->tabs_gui->setTabActive('perm_settings');
                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                $perm_gui = new ilPermissionGUI($this);
                $ret = $this->ctrl->forwardCommand($perm_gui);
                break;

            default:

                // configure classes
                $config = false;
                if (substr(strtolower($next_class), strlen($next_class) - 9) == "configgui") {
                    $path = $ilCtrl->lookupClassPath(strtolower($next_class));
                    if ($path != "") {
                        include_once($path);
                        $nc = new $next_class();

                        $pl = ilPluginAdmin::getPluginObject(
                            $_GET["ctype"],
                            $_GET["cname"],
                            $_GET["slot_id"],
                            $_GET["pname"]
                        );

                        $nc->setPluginObject($pl);

                        $ret = $this->ctrl->forwardCommand($nc);
                        $config = true;
                    }
                }

                if (!$config) {
                    if (!$cmd || $cmd == 'view') {
                        $cmd = "listPlugins";
                    }

                    $this->$cmd();
                }
                break;
        }
        return true;
    }

Here is the call graph for this function:

getAdminTabs()

ilObjComponentSettingsGUI::getAdminTabs

(

)

Get tabs.

public

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

References $_GET, $DIC, and ilObjectGUI\$lng.

    {
        global $DIC;
        $rbacsystem = $DIC->rbac()->system();
        $lng = $DIC->language();

        if ($rbacsystem->checkAccess("visible,read", $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                "plugins",
                $lng->txt("cmps_plugins"),
                $this->ctrl->getLinkTarget($this, "listPlugins")
            );

            if (DEVMODE) {
                $this->tabs_gui->addTab(
                    "slots",
                    $lng->txt("cmps_slots"),
                    $this->ctrl->getLinkTarget($this, "listSlots")
                );
            }
        }

        if ($rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
            $this->tabs_gui->addTab(
                "perm_settings",
                $lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm")
            );
        }

        if ($_GET["ctype"] == "Services") {
            $this->tabs_gui->activateTab("services");
        }
    }

installPlugin()

ilObjComponentSettingsGUI::installPlugin ( )

protected

Install a plugin.

Returns

void

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

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

    {
        include_once("./Services/Component/classes/class.ilPlugin.php");
        $pl = ilPlugin::getPluginObject(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        $pl->install();
        $this->update($pl);
    }

Here is the call graph for this function:

listPlugins()

ilObjComponentSettingsGUI::listPlugins ( )

protected

List plugins.

Parameters

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

References $DIC, $table, and ilObjectGUI\$tpl.

    {
        global $DIC;
        $tpl = $DIC->ui()->mainTemplate();
        $ilTabs = $DIC->tabs();

        $ilTabs->activateTab("plugins");
        include_once("./Services/Component/classes/class.ilPluginsOverviewTableGUI.php");
        $table = new ilPluginsOverviewTableGUI($this, "listPlugins");
        $tpl->setContent($table->getHTML());
    }

listSlots()

ilObjComponentSettingsGUI::listSlots

(

)

List Services.

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

    {
        if (!DEVMODE) {
            $this->ctrl->redirect($this, "listPlugins");
        }

        $this->tabs_gui->activateTab('slots');

        include_once("./Services/Component/classes/class.ilComponentsTableGUI.php");
        $comp_table = new ilComponentsTableGUI($this, "listSlots");

        $this->tpl->setContent($comp_table->getHTML());
    }

refreshLanguages()

ilObjComponentSettingsGUI::refreshLanguages ( )

protected

Refresh Languages.

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

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

    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();

        include_once("./Services/Component/classes/class.ilPlugin.php");
        $pl = ilPlugin::getPluginObject(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        $result = $pl->updateLanguages();

        if ($result !== true) {
            ilUtil::sendFailure($result, true);
        }

        $ilCtrl->setParameter($this, "ctype", $_GET["ctype"]);
        $ilCtrl->setParameter($this, "cname", $_GET["cname"]);
        $ilCtrl->setParameter($this, "slot_id", $_GET["slot_id"]);

        if ($_GET["plugin_id"]) {
            $ilCtrl->setParameter($this, "plugin_id", $_GET["plugin_id"]);
            $ilCtrl->redirect($this, "showPlugin");
        } else {
            $ilCtrl->redirect($this, "listPlugins");
        }
    }

Here is the call graph for this function:

showPlugin()

ilObjComponentSettingsGUI::showPlugin ( )

protected

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

References $_GET, $DIC, $form, $ilCtrl, $ilDB, $info, $key, $lang, ilObjectGUI\$lng, $r, $section, ilObjectGUI\$tpl, ilPlugin\getAvailableLangFiles(), ilPlugin\getConfigureClassName(), ilPlugin\getDBUpdateScriptName(), ilPlugin\getPluginRecord(), ilPlugin\hasConfigureClass(), and ilPluginSlot\lookupSlotName().

    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $ilTabs = $DIC->tabs();
        $lng = $DIC->language();
        $tpl = $DIC->ui()->mainTemplate();
        $ilDB = $DIC->database();
        $ilToolbar = $DIC->toolbar();

        if (!$_GET["ctype"] ||
            !$_GET["cname"] ||
            !$_GET["slot_id"] ||
            !$_GET["plugin_id"]) {
            $ilCtrl->redirect($this, "listPlugins");
        }

        include_once("./Services/Component/classes/class.ilPluginSlot.php");
        $slot = new ilPluginSlot($_GET["ctype"], $_GET["cname"], $_GET["slot_id"]);

        $plugin = null;
        foreach ($slot->getPluginsInformation() as $item) {
            if ($item["id"] == $_GET["plugin_id"]) {
                $plugin = $item;
                break;
            }
        }
        if (!$plugin) {
            $ilCtrl->redirect($this, "listPlugins");
        }

        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $lng->txt("cmps_plugins"),
            $ilCtrl->getLinkTarget($this, "listPlugins")
        );

        $ilCtrl->setParameter($this, "ctype", $_GET["ctype"]);
        $ilCtrl->setParameter($this, "cname", $_GET["cname"]);
        $ilCtrl->setParameter($this, "slot_id", $_GET["slot_id"]);
        $ilCtrl->setParameter($this, "plugin_id", $_GET["plugin_id"]);
        $ilCtrl->setParameter($this, "pname", $plugin["name"]);

        $langs = ilPlugin::getAvailableLangFiles($slot->getPluginsDirectory() . "/" .
            $plugin["name"] . "/lang");

        // dbupdate
        $file = ilPlugin::getDBUpdateScriptName(
            $_GET["ctype"],
            $_GET["cname"],
            ilPluginSlot::lookupSlotName($_GET["ctype"], $_GET["cname"], $_GET["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["ctype"],
                $_GET["cname"],
                $_GET["slot_id"],
                $plugin["name"],
                $ilDB,
                true,
                ""
            );

            $db_curr = $dbupdate->getCurrentVersion();
            $db_file = $dbupdate->getFileVersion();
        }

        $plugin_db_data = ilPlugin::getPluginRecord($plugin["component_type"], $plugin["component_name"], $plugin["slot_id"], $plugin["name"]);

        // toolbar actions
        if ($plugin["must_install"]) {
            $ilToolbar->addButton(
                $lng->txt("cmps_install"),
                $ilCtrl->getLinkTarget($this, "installPlugin")
            );
        } else {
            // configure button
            if (ilPlugin::hasConfigureClass($slot->getPluginsDirectory(), $plugin, $plugin_db_data) &&
                $ilCtrl->checkTargetClass(ilPlugin::getConfigureClassName($plugin))) {
                $ilToolbar->addButton(
                    $lng->txt("cmps_configure"),
                    $ilCtrl->getLinkTargetByClass(strtolower(ilPlugin::getConfigureClassName($plugin)), "configure")
                );
            }
            // refresh languages button
            if (count($langs) > 0) {
                $ilToolbar->addButton(
                    $lng->txt("cmps_refresh"),
                    $ilCtrl->getLinkTarget($this, "refreshLanguages")
                );
            }

            if ($plugin["activation_possible"]) {
                $ilToolbar->addButton(
                    $lng->txt("cmps_activate"),
                    $ilCtrl->getLinkTarget($this, "activatePlugin")
                );
            }

            // deactivation/refresh languages button
            if ($plugin["is_active"]) {
                // deactivate button
                $ilToolbar->addButton(
                    $lng->txt("cmps_deactivate"),
                    $ilCtrl->getLinkTarget($this, "deactivatePlugin")
                );
            }

            // update button
            if ($plugin["needs_update"]) {
                $ilToolbar->addButton(
                    $lng->txt("cmps_update"),
                    $ilCtrl->getLinkTarget($this, "updatePlugin")
                );
            }
        }

        // info
        $resp = array();
        if (strlen($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 = $lng->txt("cmps_active");
        } else {
            $r = ($plugin["inactive_reason"] != "")
                ? " (" . $plugin["inactive_reason"] . ")"
                : "";

            $status = $lng->txt("cmps_inactive") . $r;
        }

        $info[""][$lng->txt("cmps_name")] = $plugin["name"];
        $info[""][$lng->txt("cmps_id")] = $plugin["id"];
        $info[""][$lng->txt("cmps_version")] = $plugin["version"];
        if ($resp) {
            $info[""][$lng->txt("cmps_responsible")] = $resp;
        }
        $info[""][$lng->txt("cmps_ilias_min_version")] = $plugin["ilias_min_version"];
        $info[""][$lng->txt("cmps_ilias_max_version")] = $plugin["ilias_max_version"];
        $info[""][$lng->txt("cmps_status")] = $status;

        if (sizeof($langs)) {
            $lang_files = array();
            foreach ($langs as $lang) {
                $lang_files[] = $lang["file"];
            }
            $info[""][$lng->txt("cmps_languages")] = implode(", ", $lang_files);
        } else {
            $info[""][$lng->txt("cmps_languages")] = $lng->txt("cmps_no_language_file_available");
        }

        $info[$lng->txt("cmps_basic_files")]["plugin.php"] = $plugin["plugin_php_file_status"] ?
            $lng->txt("cmps_available") :
            $lng->txt("cmps_missing");
        $info[$lng->txt("cmps_basic_files")][$lng->txt("cmps_class_file")] = ($plugin["class_file_status"] ?
                $lng->txt("cmps_available") :
                $lng->txt("cmps_missing")) .
            " (" . $plugin["class_file"] . ")";

        if (!$db_file) {
            $info[$lng->txt("cmps_database")][$lng->txt("file")] = $lng->txt("cmps_no_db_update_file_available");
        } else {
            $info[$lng->txt("cmps_database")][$lng->txt("file")] = "dbupdate.php";
            $info[$lng->txt("cmps_database")][$lng->txt("cmps_current_version")] = $db_curr;
            $info[$lng->txt("cmps_database")][$lng->txt("cmps_file_version")] = $db_file;
        }

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
        $form->setTitle($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);
            }
        }

        $tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

showPluginSlotInfo()

ilObjComponentSettingsGUI::showPluginSlotInfo ( )

protected

Show information about a plugin slot.

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

References $_GET, $DIC, $form, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilComponent\getComponentObject(), and ilNonEditableValueGUI\setValue().

    {
        global $DIC;
        $tpl = $DIC->ui()->mainTemplate();
        $lng = $DIC->language();
        $ilTabs = $DIC->tabs();
        $ilCtrl = $DIC->ctrl();

        if (!DEVMODE) {
            $ilCtrl->redirect($this, "listPlugins");
        }

        $ilTabs->clearTargets();

        $ilTabs->setBackTarget(
            $lng->txt("cmps_slots"),
            $ilCtrl->getLinkTarget($this, "listSlots")
        );

        include_once("./Services/Component/classes/class.ilComponent.php");
        $comp = ilComponent::getComponentObject($_GET["ctype"], $_GET["cname"]);

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();

        // component
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_component"), "", true);
        $ne->setValue($comp->getComponentType() . "/" . $comp->getName() . " [" . $comp->getId() . "]");
        $form->addItem($ne);

        // plugin slot
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_plugin_slot"), "", true);
        $ne->setValue($comp->getPluginSlotName($_GET["slot_id"]) . " [" . $_GET["slot_id"] . "]");
        $form->addItem($ne);

        // main dir
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_main_dir"), "", true);
        $ne->setValue($comp->getPluginSlotDirectory($_GET["slot_id"]) . "/<Plugin_Name>");
        $form->addItem($ne);

        // plugin file
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_plugin_file"), "", true);
        $ne->setValue("<" . $lng->txt("cmps_main_dir") . ">" .
            "/classes/class.il<Plugin_Name>Plugin.php");
        $form->addItem($ne);

        // language files
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_lang_files"), "", true);
        $ne->setValue("<" . $lng->txt("cmps_main_dir") . ">" .
            "/lang/ilias_<Language ID>.lang");
        $form->addItem($ne);

        // db update
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_db_update"), "", true);
        $ne->setValue("<" . $lng->txt("cmps_main_dir") . ">" .
            "/sql/dbupdate.php");
        $form->addItem($ne);

        // lang prefix
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_plugin_lang_prefixes"), "", true);
        $ne->setValue($comp->getPluginSlotLanguagePrefix($_GET["slot_id"]) . "<Plugin_ID>_");
        $form->addItem($ne);

        // db prefix
        $ne = new ilNonEditableValueGUI($lng->txt("cmps_plugin_db_prefixes"), "", true);
        $ne->setValue($comp->getPluginSlotLanguagePrefix($_GET["slot_id"]) . "<Plugin_ID>_");
        $form->addItem($ne);

        $form->setTitle($lng->txt("cmps_plugin_slot"));

        // set content and title
        $tpl->setContent($form->getHTML());
        $tpl->setTitle($comp->getComponentType() . "/" . $comp->getName() . ": " .
            $lng->txt("cmps_plugin_slot") . " \"" . $comp->getPluginSlotName($_GET["slot_id"]) . "\"");
        $tpl->setDescription("");
    }

Here is the call graph for this function:

uninstallPlugin()

ilObjComponentSettingsGUI::uninstallPlugin ( )

protected

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

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

    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();

        include_once("./Services/Component/classes/class.ilPlugin.php");
        $pl = ilPlugin::getPluginObject(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        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);

        $ilCtrl->setParameter($this, "ctype", $_GET["ctype"]);
        $ilCtrl->setParameter($this, "cname", $_GET["cname"]);
        $ilCtrl->setParameter($this, "slot_id", $_GET["slot_id"]);
        $ilCtrl->redirect($this, "listPlugins");
    }

Here is the call graph for this function:

update()

ilObjComponentSettingsGUI::update ( ilPlugin  $plugin )

protected

Execute update and ctrl reload.

Parameters

ilPlugin

$plugin

Returns

void

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

References $_GET, $DIC, $ilCtrl, $result, ilUtil\redirect(), ilUtil\sendFailure(), and ilPlugin\update().

Referenced by installPlugin(), and updatePlugin().

    {
        $result = $plugin->update();

        if ($result !== true) {
            ilUtil::sendFailure($plugin->message, true);
        } else {
            ilUtil::sendSuccess($plugin->message, true);
        }

        // reinitialize control class
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $ilCtrl->initBaseClass("iladministrationgui");
        $_GET["cmd"] = "jumpToPluginSlot";
        $ilCtrl->setParameterByClass("iladministrationgui", "ctype", $_GET["ctype"]);
        $ilCtrl->setParameterByClass("iladministrationgui", "cname", $_GET["cname"]);
        $ilCtrl->setParameterByClass("iladministrationgui", "slot_id", $_GET["slot_id"]);
        $ilCtrl->setParameterByClass("iladministrationgui", "plugin_id", $_GET["plugin_id"]);
        ilUtil::redirect("ilias.php?admin_mode=settings&baseClass=ilAdministrationGUI" .
            "&cmd=jumpToPluginSlot&ref_id=" . $_GET["ref_id"] . "&ctype=" . $_GET["ctype"] .
            "&cname=" . $_GET["cname"] . "&slot_id=" . $_GET["slot_id"] . "&plugin_id=" . $_GET["plugin_id"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updatePlugin()

ilObjComponentSettingsGUI::updatePlugin ( )

protected

Update a plugin.

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

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

    {
        include_once("./Services/Component/classes/class.ilPlugin.php");
        $pl = ilPlugin::getPluginObject(
            $_GET["ctype"],
            $_GET["cname"],
            $_GET["slot_id"],
            $_GET["pname"]
        );

        $this->update($pl);
    }

Here is the call graph for this function:

Field Documentation

$ERROR_MESSAGE

ilObjComponentSettingsGUI::$ERROR_MESSAGE

staticprivate

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

---

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

• Services/Component/classes/class.ilObjComponentSettingsGUI.php