ilObjHelpSettingsGUI Class Reference

Help settings gui class. More...

Inheritance diagram for ilObjHelpSettingsGUI:

Collaboration diagram for ilObjHelpSettingsGUI:

Public Member Functions
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	getType ()
	Get type. More...
	executeCommand ()
	Execute command. More...
	editSettings ()
	Edit news settings. More...
	getAdminTabs ()
	administration tabs show only permissions and trash folder More...
	uploadHelpFile ()
	Upload help file. More...
	confirmHelpModulesDeletion ()
	Confirm help modules deletion. More...
	deleteHelpModules ()
	Delete help modules. More...
	activateModule ()
	Activate module. More...
	deactivateModule ()
	Deactivate module. More...
	setMode ()
	Set mode. More...
Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor. More...
	executeCommand ()
	execute command More...
	delete ()
	Display delete confirmation form (repository/workspace switch) More...
	confirmedDelete ()
	Delete objects (repository/workspace switch) More...
	getHTML ()
	withReferences ()
	Final/Private declaration of unchanged parent methods. More...
	setCreationMode ($a_mode=true)
	getCreationMode ()
	prepareOutput ($a_show_subobjects=true)
	isVisible ($a_ref_id, $a_type)
	trash ()
	undelete ()
	cancelDelete ()
	removeFromSystem ()
	cloneAll ()
	view ()
	view object content (repository/workspace switch) More...
	getType ()
	Functions that must be overwritten. More...
	create ()
	Deleted in ilObject. More...
	save ()
	edit ()
	update ()
	cancel ()
	importFile ()
	Import. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. 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...

Protected Attributes
	$rbacsystem
	$error
	$access
	$settings
	$tabs
	$toolbar
	$db
Protected Attributes inherited from ilObject2GUI
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler
Protected Attributes inherited from ilObjectGUI
	$ilErr
	$locator
	$user
	$access
	$settings
	$rbacreview
	$toolbar
	$rbacsystem
	$tmp_import_dir
	$tabs_gui = null
	$ctrl

Additional Inherited Members
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $a_obj, $a_callback_ref_id)
	After creation callback. More...
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 ilObject2GUI
	$tree
const	OBJECT_ID = 0
const	REPOSITORY_NODE_ID = 1
const	WORKSPACE_NODE_ID = 2
const	REPOSITORY_OBJECT_ID = 3
const	WORKSPACE_OBJECT_ID = 4
const	PORTFOLIO_OBJECT_ID = 5
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 Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...
	assignObject ()
	create object instance as internal property (repository/workspace switch) More...
	getAccessHandler ()
	Get access handler. More...
	setLocator ()
	set Locator More...
	deleteConfirmation ()
	Display delete confirmation form (workspace specific) More...
	deleteConfirmedObjects ()
	Delete objects (workspace specific) More...
	setTitleAndDescription ()
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	setTargetFrame ($a_cmd, $a_target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	setColumnSettings (ilColumnGUI $column_gui)
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	showPossibleSubObjects ()
	redirectToRefId ($a_ref_id, $a_cmd="")
	fillCloneTemplate ($a_tpl_varname, $a_type)
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ($a_do_not_add_object=false)
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation ($a_cmd, $a_location="")
	Deprecated functions. More...
	setReturnLocation ($a_cmd, $a_location)
	showActions ()
	getTabs ()
	__showButton ($a_cmd, $a_text, $a_target='')
	hitsperpageObject ()
&	__initTableGUI ()
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission. More...
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu. More...
	redrawHeaderAction ()
	Updating icons after ajax call. More...
	getPermanentLinkWidget ($a_append=null, $a_center=false)
	handleAutoRating (ilObject $a_new_obj)
Protected Member Functions inherited from ilObjectGUI
	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...

Detailed Description

Help settings gui class.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilObjHelpSettingsGUI: ilPermissionGUI ilObjHelpSettingsGUI: ilAdministrationGUI

Definition at line 17 of file class.ilObjHelpSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjHelpSettingsGUI::__construct	(		$a_id = 0,
			$a_id_type = self::REPOSITORY_NODE_ID,
			$a_parent_node_id = 0
	)

Constructor.

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

References $DIC, and settings().

    {
        global $DIC;
        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $this->rbacsystem = $DIC->rbac()->system();
        $this->error = $DIC["ilErr"];
        $this->access = $DIC->access();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->tpl = $DIC["tpl"];
        $this->db = $DIC->database();
    }

Here is the call graph for this function:

Member Function Documentation

activateModule()

ilObjHelpSettingsGUI::activateModule

(

)

Activate module.

Parameters

Definition at line 275 of file class.ilObjHelpSettingsGUI.php.

References $_GET, ilObjectGUI\$ctrl, $ilCtrl, $ilSetting, ilObjectGUI\$lng, $settings, ilObject2GUI\checkPermission(), and ilUtil\sendSuccess().

    {
        $ilSetting = $this->settings;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->checkPermission("write");
        
        $ilSetting->set("help_module", (int) $_GET["hm_id"]);
        ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        $ilCtrl->redirect($this, "editSettings");
    }

Here is the call graph for this function:

confirmHelpModulesDeletion()

ilObjHelpSettingsGUI::confirmHelpModulesDeletion

(

)

Confirm help modules deletion.

Definition at line 220 of file class.ilObjHelpSettingsGUI.php.

References $_POST, ilObjectGUI\$ctrl, $i, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObject2GUI\checkPermission(), object, and ilUtil\sendInfo().

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;

        $this->checkPermission("write");
            
        if (!is_array($_POST["id"]) || count($_POST["id"]) == 0) {
            ilUtil::sendInfo($lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "editSettings");
        } else {
            include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("help_sure_delete_help_modules"));
            $cgui->setCancel($lng->txt("cancel"), "editSettings");
            $cgui->setConfirm($lng->txt("delete"), "deleteHelpModules");
            
            foreach ($_POST["id"] as $i) {
                $cgui->addItem("id[]", $i, $this->object->lookupModuleTitle($i));
            }
            
            $tpl->setContent($cgui->getHTML());
        }
    }

Here is the call graph for this function:

deactivateModule()

ilObjHelpSettingsGUI::deactivateModule

(

)

Deactivate module.

Parameters

Definition at line 294 of file class.ilObjHelpSettingsGUI.php.

References $_GET, ilObjectGUI\$ctrl, $ilCtrl, $ilSetting, ilObjectGUI\$lng, $settings, ilObject2GUI\checkPermission(), and ilUtil\sendSuccess().

    {
        $ilSetting = $this->settings;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        $this->checkPermission("write");
        
        if ($ilSetting->get("help_module") == (int) $_GET["hm_id"]) {
            $ilSetting->set("help_module", "");
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        }
        $ilCtrl->redirect($this, "editSettings");
    }

Here is the call graph for this function:

deleteHelpModules()

ilObjHelpSettingsGUI::deleteHelpModules

(

)

Delete help modules.

Parameters

Definition at line 253 of file class.ilObjHelpSettingsGUI.php.

References $_POST, ilObjectGUI\$ctrl, $db, $i, $ilCtrl, $ilDB, and ilObject2GUI\checkPermission().

    {
        $ilDB = $this->db;
        $ilCtrl = $this->ctrl;

        $this->checkPermission("write");
        
        if (is_array($_POST["id"])) {
            foreach ($_POST["id"] as $i) {
                $this->object->deleteModule((int) $i);
            }
        }
        
        $ilCtrl->redirect($this, "editSettings");
    }

Here is the call graph for this function:

editSettings()

ilObjHelpSettingsGUI::editSettings

(

)

Edit news settings.

Definition at line 127 of file class.ilObjHelpSettingsGUI.php.

References ilObjectGUI\$ctrl, $ilCtrl, $ilSetting, ilObjectGUI\$lng, $options, $settings, $si, $tab, $tabs, $toolbar, array, ilObject2GUI\checkPermissionBool(), ilUtil\sendInfo(), ilSelectInputGUI\setOptions(), and ilFileInputGUI\setSuffixes().

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $ilTabs = $this->tabs;
        $ilToolbar = $this->toolbar;
        
        $ilTabs->activateTab("settings");
        
        if (OH_REF_ID > 0) {
            ilUtil::sendInfo("This installation is used for online help authoring. Help modules cannot be imported.");
            return;
        }
        
        if ($this->checkPermissionBool("write")) {
            // help file
            include_once("./Services/Form/classes/class.ilFileInputGUI.php");
            $fi = new ilFileInputGUI($lng->txt("help_help_file"), "help_file");
            $fi->setSuffixes(array("zip"));
            $ilToolbar->addInputItem($fi, true);
            $ilToolbar->addFormButton($lng->txt("upload"), "uploadHelpFile");
            $ilToolbar->addSeparator();
            
            // help mode
            include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
            $options = array(
                "" => $lng->txt("help_tooltips_and_help"),
                "1" => $lng->txt("help_help_only"),
                "2" => $lng->txt("help_tooltips_only")
                );
            $si = new ilSelectInputGUI($this->lng->txt("help_mode"), "help_mode");
            $si->setOptions($options);
            $si->setValue($ilSetting->get("help_mode"));
            $ilToolbar->addInputItem($si);
            
            $ilToolbar->addFormButton($lng->txt("help_set_mode"), "setMode");
        }
        $ilToolbar->setFormAction($ilCtrl->getFormAction($this), true);
        
        include_once("./Services/Help/classes/class.ilHelpModuleTableGUI.php");
        $tab = new ilHelpModuleTableGUI($this, "editSettings", $this->checkPermissionBool("write"));
        
        $this->tpl->setContent($tab->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilObjHelpSettingsGUI::executeCommand

(

)

Execute command.

public

Definition at line 89 of file class.ilObjHelpSettingsGUI.php.

References $access, $error, ilObjectGUI\$ilErr, ilObjectGUI\$lng, $ret, and ilObject2GUI\prepareOutput().

    {
        $ilErr = $this->error;
        $ilAccess = $this->access;
        $lng = $this->lng;
        $lng->loadLanguageModule("help");

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

        $this->prepareOutput();

        if (!$ilAccess->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:
                if (!$cmd || $cmd == 'view') {
                    $cmd = "editSettings";
                }

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

Here is the call graph for this function:

getAdminTabs()

ilObjHelpSettingsGUI::getAdminTabs

(

)

administration tabs show only permissions and trash folder

Definition at line 176 of file class.ilObjHelpSettingsGUI.php.

References array, and ilObject2GUI\checkPermissionBool().

    {
        if ($this->checkPermissionBool("visible,read")) {
            $this->tabs_gui->addTab(
                "settings",
                $this->lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "editSettings")
            );
        }
        
        if ($this->checkPermissionBool("edit_permission")) {
            $this->tabs_gui->addTab(
                "perm_settings",
                $this->lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass(array(get_class($this),'ilpermissiongui'), "perm")
            );
        }
    }

Here is the call graph for this function:

getType()

ilObjHelpSettingsGUI::getType

(

)

Get type.

Definition at line 78 of file class.ilObjHelpSettingsGUI.php.

    {
        return "hlps";
    }

setMode()

ilObjHelpSettingsGUI::setMode

(

)

Set mode.

Parameters

Definition at line 315 of file class.ilObjHelpSettingsGUI.php.

References $_POST, ilObjectGUI\$ctrl, $ilCtrl, $ilSetting, ilObjectGUI\$lng, $settings, ilObject2GUI\checkPermission(), ilObject2GUI\checkPermissionBool(), ilUtil\sendSuccess(), and ilUtil\stripSlashes().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;

        $this->checkPermission("write");
        
        if ($this->checkPermissionBool("write")) {
            $ilSetting->set("help_mode", ilUtil::stripSlashes($_POST["help_mode"]));
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);
        }
        
        $ilCtrl->redirect($this, "editSettings");
    }

Here is the call graph for this function:

uploadHelpFile()

ilObjHelpSettingsGUI::uploadHelpFile

(

)

Upload help file.

Parameters

Definition at line 204 of file class.ilObjHelpSettingsGUI.php.

References ilObjectGUI\$ctrl, $ilCtrl, ilObjectGUI\$lng, ilObject2GUI\checkPermissionBool(), and ilUtil\sendSuccess().

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        if ($this->checkPermissionBool("write")) {
            $this->object->uploadHelpModule($_FILES["help_file"]);
            ilUtil::sendSuccess($lng->txt("help_module_uploaded"), true);
        }
        
        $ilCtrl->redirect($this, "editSettings");
    }

Here is the call graph for this function:

Field Documentation

$access

ilObjHelpSettingsGUI::$access

protected

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

Referenced by executeCommand().

$db

ilObjHelpSettingsGUI::$db

protected

Definition at line 52 of file class.ilObjHelpSettingsGUI.php.

Referenced by deleteHelpModules().

$error

ilObjHelpSettingsGUI::$error

protected

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

Referenced by executeCommand().

$rbacsystem

ilObjHelpSettingsGUI::$rbacsystem

protected

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

$settings

ilObjHelpSettingsGUI::$settings

protected

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

Referenced by activateModule(), deactivateModule(), editSettings(), and setMode().

$tabs

ilObjHelpSettingsGUI::$tabs

protected

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

Referenced by editSettings().

$toolbar

ilObjHelpSettingsGUI::$toolbar

protected

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

Referenced by editSettings().

---

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

• Services/Help/classes/class.ilObjHelpSettingsGUI.php