ilObjHelpSettingsGUI Class Reference

Help settings gui class. More...

Inheritance diagram for ilObjHelpSettingsGUI:

Collaboration diagram for ilObjHelpSettingsGUI:

Public Member Functions
	getType ()
	Get type. More...
	executeCommand ()
	Execute command. More...
	editSettings ()
	Edit news settings. More...
	getAdminTabs (&$tabs_gui)
	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 ()
	isVisible ()
	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...
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public. More...
&	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...
	getAdminTabs (&$tabs_gui)
	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 ($in_rep=false)
	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...
	editObject ()
	edit object More...
	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...

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 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
	$ilias
	$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...
	prepareOutput ()
	setTitleAndDescription ()
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	setTargetFrame ($a_cmd, $a_target_frame)
	getCenterColumnHTML ()
	getRightColumnHTML ()
	setColumnSettings ($column_gui)
	checkPermission ($a_perm, $a_cmd="")
	showPossibleSubObjects ()
	redirectToRefId ()
	fillCloneTemplate ($a_tpl_varname, $a_type)
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ()
	setTabs ()
	create tabs (repository/workspace switch) More...
	getReturnLocation ()
	Deprecated functions. More...
	setReturnLocation ()
	showActions ()
	getTitlesByRefId ()
	getTabs ()
	__showButton ()
	hitsperpageObject ()
	__initTableGUI ()
	__setTableGUIBasicData ()
	addLocatorItems ()
	Functions to be overwritten. More...
	initCreationForms ($a_new_type)
	Init creation froms. More...
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position. 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 ()
	prepareOutput ()
	prepare output More...
	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...
	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...
	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...
	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)
	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...
	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste More...
	getTabs (&$tabs_gui)
	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 ($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 inherited from ilObject2GUI
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler

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.

Member Function Documentation

activateModule()

ilObjHelpSettingsGUI::activateModule

(

)

Activate module.

Parameters

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

References $_GET, $ilCtrl, $ilSetting, ilObjectGUI\$lng, and ilUtil\sendSuccess().

        {
                global $ilSetting, $lng, $ilCtrl;
                
                $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 167 of file class.ilObjHelpSettingsGUI.php.

References $_POST, $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, and ilUtil\sendInfo().

        {
                global $ilCtrl, $tpl, $lng;
                        
                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 236 of file class.ilObjHelpSettingsGUI.php.

References $_GET, $ilCtrl, $ilSetting, ilObjectGUI\$lng, and ilUtil\sendSuccess().

        {
                global $ilSetting, $lng, $ilCtrl;
                
                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 200 of file class.ilObjHelpSettingsGUI.php.

References $_POST, and $ilCtrl.

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

editSettings()

ilObjHelpSettingsGUI::editSettings

(

)

Edit news settings.

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

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

        {
                global $ilCtrl, $lng, $ilSetting, $ilTabs, $ilToolbar;
                
                $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->tpl->setContent($tab->getHTML());
        }

Here is the call graph for this function:

executeCommand()

ilObjHelpSettingsGUI::executeCommand

(

)

Execute command.

public

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

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

        {
                global $rbacsystem, $ilErr, $ilAccess, $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

(

&

$tabs_gui

)

administration tabs show only permissions and trash folder

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

References ilObject2GUI\$tree, and ilObject2GUI\checkPermissionBool().

        {
                global $tree;

                if ($this->checkPermissionBool("visible,read"))
                {
                        $tabs_gui->addTab("settings",
                                $this->lng->txt("settings"),
                                $this->ctrl->getLinkTarget($this, "editSettings"));

                }
                
                if ($this->checkPermissionBool("edit_permission"))
                {
                        $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 22 of file class.ilObjHelpSettingsGUI.php.

        {
                return "hlps";
        }

setMode()

ilObjHelpSettingsGUI::setMode

(

)

Set mode.

Parameters

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

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

        {
                global $lng, $ilCtrl, $ilSetting;
                
                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 151 of file class.ilObjHelpSettingsGUI.php.

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

        {
                global $lng, $ilCtrl;
                
                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:

---

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

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