ilObjWikiSettingsGUI Class Reference

Wiki settings gui class. More...

Inheritance diagram for ilObjWikiSettingsGUI:

Collaboration diagram for ilObjWikiSettingsGUI:

Public Member Functions
	getType ()
	Get type.
	executeCommand ()
	Execute command.
	initForm ($a_mode="edit")
	getAdminTabs ($tabs_gui)
	administration tabs show only permissions and trash folder
	addToExternalSettingsForm ($a_form_id)
Public Member Functions inherited from ilObject2GUI
	__construct ($a_id=0, $a_id_type=self::REPOSITORY_NODE_ID, $a_parent_node_id=0)
	Constructor.
	delete ()
	Display delete confirmation form (repository/workspace switch)
	confirmedDelete ()
	Delete objects (repository/workspace switch)
	getHTML ()
	withReferences ()
	Final/Private declaration of unchanged parent methods.
	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
	getCreationMode ()
	get creation mode
	isVisible ()
	trash ()
	undelete ()
	cancelDelete ()
	removeFromSystem ()
	cloneAll ()
	view ()
	view object content (repository/workspace switch)
	create ()
	Deleted in ilObject.
	save ()
	edit ()
	update ()
	cancel ()
	importFile ()
	Import.
Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor public.
	getAdminTabs (&$tabs_gui)
	administration tabs show only permissions and trash folder
	confirmedDeleteObject ()
	confirmed deletion of object -> objects are moved to trash or deleted immediately, if trash is disabled
	cancelDeleteObject ()
	cancel deletion of object
	cancelObject ($in_rep=false)
	cancel action and go back to previous page public
	createObject ()
	create new object form
	cancelCreation ()
	cancel create action and go back to repository parent
	saveObject ()
	save object
	editObject ()
	edit object
	updateObject ()
	updates object entry in object_data
	getFormAction ($a_cmd, $a_formaction="")
	get form action for command (command is method name without "Object", e.g.
	isVisible ($a_ref_id, $a_type)
	viewObject ()
	list childs of current object
	deleteObject ($a_error=false)
	Display deletion confirmation screen.
	cloneAllObject ()
	Clone single (not container object) Method is overwritten in ilContainerGUI.

Protected Member Functions
	editSettings (ilPropertyFormGUI $form=null)
	populateWithCurrentSettings (ilPropertyFormGUI $form)
Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here.
	assignObject ()
	create object instance as internal property (repository/workspace switch)
	getAccessHandler ()
	Get access handler.
	setLocator ()
	set Locator
	deleteConfirmation ()
	Display delete confirmation form (workspace specific)
	deleteConfirmedObjects ()
	Delete objects (workspace specific)
	prepareOutput ()
	prepare output
	setTitleAndDescription ()
	called by prepare output
	showUpperIcon ()
	omitLocator ($a_omit=true)
	getTargetFrame ($a_cmd, $a_target_frame="")
	get target frame for command (command is method name without "Object", e.g.
	setTargetFrame ($a_cmd, $a_target_frame)
	set specific target frame for command
	getCenterColumnHTML ()
	Get center column.
	getRightColumnHTML ()
	Display right column.
	setColumnSettings ($column_gui)
	May be overwritten in subclasses.
	checkPermission ($a_perm, $a_cmd="")
	showPossibleSubObjects ()
	show possible subobjects (pulldown menu)
	redirectToRefId ()
	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.
	fillCloneSearchTemplate ($a_tpl_varname, $a_type)
	searchCloneSource ()
	buildCloneSelect ($existing_objs)
	addAdminLocatorItems ()
	setTabs ()
	create tabs (repository/workspace switch)
	getReturnLocation ()
	Deprecated functions.
	setReturnLocation ()
	showActions ()
	getTitlesByRefId ()
	getTabs ()
	__showButton ()
	hitsperpageObject ()
	__initTableGUI ()
	__setTableGUIBasicData ()
	addLocatorItems ()
	Functions to be overwritten.
	initCreationForms ($a_new_type)
	Init creation froms.
	putObjectInTree (ilObject $a_obj, $a_parent_node_id=null)
	Add object to tree at given position.
	checkPermissionBool ($a_perm, $a_cmd="", $a_type="", $a_node_id=null)
	Check permission.
	initHeaderAction ($a_sub_type=null, $a_sub_id=null)
	Add header action menu.
	redrawHeaderAction ()
	Updating icons after ajax call.
	getPermanentLinkWidget ($a_append=null, $a_center=false)
	handleAutoRating (ilObject $a_new_obj)
	Activate rating automatically if parent container setting.
Protected Member Functions inherited from ilObjectGUI
	insertHeaderAction ($a_list_gui)
	Insert header action into main template.
	addHeaderAction ()
	Add header action menu.
	redrawHeaderActionObject ()
	Ajax call: redraw action header only.
	showMountWebfolderIcon ()
	setAdminTabs ()
	set admin tabs public
	addAdminLocatorItems ($a_do_not_add_object=false)
	should be overwritten to add object specific items (repository items are preloaded)
	getCreationFormsHTML (array $a_forms)
	Get HTML for creation forms (accordion)
	initCreateForm ($a_new_type)
	Init object creation form.
	initDidacticTemplate (ilPropertyFormGUI $form)
	Show didactic template types.
	addDidacticTemplateOptions (array &$a_options)
	Add custom templates.
	getDidacticTemplateVar ($a_type)
	Get didactic template setting from creation screen.
	afterSave (ilObject $a_new_object)
	Post (successful) object creation hook.
	initEditForm ()
	Init object edit form.
	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form.
	getEditFormValues ()
	Get values for edit form.
	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields.
	updateCustom (ilPropertyFormGUI $a_form)
	Insert custom update form values into object.
	afterUpdate ()
	Post (successful) object update hook.
	initImportForm ($a_new_type)
	Init object import form.
	importFileObject ($parent_id=null)
	Import.
	afterImport (ilObject $a_new_object)
	Post (successful) object import hook.
	setFormAction ($a_cmd, $a_formaction)
	set specific form action for command
	getReturnLocation ($a_cmd, $a_location="")
	get return location for command (command is method name without "Object", e.g.
	setReturnLocation ($a_cmd, $a_location)
	set specific return location for command
	getTemplateFile ($a_cmd, $a_type="")
	get a template blockfile format: tpl.
	getTitlesByRefId ($a_ref_ids)
	get Titles of objects this method is used for error messages in methods cut/copy/paste
	getTabs (&$tabs_gui)
	get tabs abstract method.
	__showButton ($a_cmd, $a_text, $a_target= '')
	__setTableGUIBasicData (&$tbl, &$result_set, $a_from="")
	standard implementation for tables use 'from' variable use different initial setting of table
	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
	checkPermission ($a_perm, $a_cmd="", $a_type="", $a_ref_id=null)
	Check permission and redirect on error.
	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files.

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot ($a_raise_error=false)
	Goto repository root.
static	_gotoRepositoryNode ($a_ref_id, $a_cmd="frameset")
	Goto repository root.
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
Protected Attributes inherited from ilObject2GUI
	$object_id
	$node_id
	$creation_forms = array()
	$id_type = array()
	$parent_id
	$access_handler

Detailed Description

Wiki settings gui class.

Author

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

Version

$Id$

ilObjWikiSettingsGUI: ilPermissionGUI ilObjWikiSettingsGUI: ilAdministrationGUI

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

Member Function Documentation

ilObjWikiSettingsGUI::addToExternalSettingsForm

(

$a_form_id

)

Parameters

string

$a_form_id

Returns

array

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

References ilAdministrationSettingsFormHandler\FORM_ACCESSIBILITY, and ilAdministrationSettingsFormHandler\VALUE_BOOL.

        {
                switch($a_form_id)
                {
                        case ilAdministrationSettingsFormHandler::FORM_ACCESSIBILITY:
                                require_once 'Services/Captcha/classes/class.ilCaptchaUtil.php';
                                $fields = array(
                                        'adm_captcha_anonymous_short' => array(ilCaptchaUtil::isActiveForWiki(), ilAdministrationSettingsFormHandler::VALUE_BOOL)
                                );

                                return array('obj_wiks' => array('editSettings', $fields));
                }
        }

ilObjWikiSettingsGUI::editSettings ( ilPropertyFormGUI  $form = null )

protected

Parameters

ilPropertyFormGUI

$form

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

References $ilCtrl, ilObjectGUI\$lng, ilObjectGUI\$tpl, ilObject2GUI\checkPermissionBool(), initForm(), and populateWithCurrentSettings().

        {
                global $ilCtrl, $lng, $ilTabs, $ilToolbar, $tpl;
                
                $ilTabs->activateTab("settings");
                
                if ($this->checkPermissionBool("read"))
                {
                        if(!$form)
                        {
                                $form = $this->initForm();
                                $this->populateWithCurrentSettings($form);
                        }
                        $tpl->setContent($form->getHTML());
                }
        }

Here is the call graph for this function:

ilObjWikiSettingsGUI::executeCommand

(

)

Execute command.

public

Reimplemented from ilObject2GUI.

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

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

        {
                global $rbacsystem, $ilErr, $ilAccess, $lng;
                
                $lng->loadLanguageModule("wiki");

                $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:

ilObjWikiSettingsGUI::getAdminTabs

(

$tabs_gui

)

administration tabs show only permissions and trash folder

Definition at line 174 of file class.ilObjWikiSettingsGUI.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:

ilObjWikiSettingsGUI::getType

(

)

Get type.

Parameters

@return

Reimplemented from ilObject2GUI.

Definition at line 26 of file class.ilObjWikiSettingsGUI.php.

        {
                return "wiks";
        }

ilObjWikiSettingsGUI::initForm

(

$a_mode = "edit"

)

Parameters

string

$a_mode

Returns

ilPropertyFormGUI

Definition at line 111 of file class.ilObjWikiSettingsGUI.php.

References $ilCtrl, ilObjectGUI\$lng, ilCaptchaUtil\checkFreetype(), ilObject2GUI\checkPermissionBool(), and ilFormPropertyGUI\setInfo().

Referenced by editSettings().

        {
                global $lng, $ilCtrl;

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

                require_once 'Services/Captcha/classes/class.ilCaptchaUtil.php';
                $cap = new ilCheckboxInputGUI($this->lng->txt('adm_captcha_anonymous_short'), 'activate_captcha_anonym');
                $cap->setInfo($this->lng->txt('adm_captcha_anonymous_wiki'));
                $cap->setValue(1);
                if(!ilCaptchaUtil::checkFreetype())
                {
                        $cap->setAlert(ilCaptchaUtil::getPreconditionsMessage());
                }
                $form->addItem($cap);
                
                if ($this->checkPermissionBool("write"))
                {
                        $form->addCommandButton("saveSettings", $lng->txt("save"));
                }

                $form->setTitle($lng->txt("settings"));
                $form->setFormAction($ilCtrl->getFormAction($this));
         
                return $form;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjWikiSettingsGUI::populateWithCurrentSettings ( ilPropertyFormGUI  $form )

protected

Parameters

ilPropertyFormGUI

$form

Definition at line 98 of file class.ilObjWikiSettingsGUI.php.

References ilPropertyFormGUI\setValuesByArray().

Referenced by editSettings().

        {
                require_once 'Services/Captcha/classes/class.ilCaptchaUtil.php';

                $form->setValuesByArray(array(
                        'activate_captcha_anonym' => ilCaptchaUtil::isActiveForWiki()
                ));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Modules/Wiki/classes/class.ilObjWikiSettingsGUI.php