Awareness tool administration. More...

Inheritance diagram for ilObjAwarenessAdministrationGUI:

Collaboration diagram for ilObjAwarenessAdministrationGUI:

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

	editSettings ($a_form=null)
	Edit settings. More...

	saveSettings ()
	Save settings. More...

	cancel ()
	Save settings. More...

Public Member Functions inherited from ilObjectGUI
	ilObjectGUI ($a_data, $a_id=0, $a_call_by_reference=true, $a_prepare_output=true)
	Constructor @access 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 @access 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...

	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 Member Functions
	initFormSettings ()
	Init settings property form. More...

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 @access public More...

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

	setLocator ()
	set Locator More...

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

	omitLocator ($a_omit=true)

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

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

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

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

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

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

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

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

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

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

	$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 Attributes inherited from ilObjectGUI
	$tmp_import_dir

Detailed Description

Awareness tool administration.

Author: Alex Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..com

Version: $Id$

@ilCtrl_Calls ilObjAwarenessAdministrationGUI: ilPermissionGUI @ilCtrl_IsCalledBy ilObjAwarenessAdministrationGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

◆ __construct()

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

Contructor.

@access public

Definition at line 23 of file class.ilObjAwarenessAdministrationGUI.php.

        {
                $this->type = "awra";
                parent::ilObjectGUI($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
 
                $this->lng->loadLanguageModule("awrn");
                $this->lng->loadLanguageModule("pd");
        }

Member Function Documentation

◆ cancel()

ilObjAwarenessAdministrationGUI::cancel ( )

Save settings.

Definition at line 149 of file class.ilObjAwarenessAdministrationGUI.php.

        {
                global $ilCtrl;
                
                $ilCtrl->redirect($this, "view");
        }

References $ilCtrl.

◆ editSettings()

ilObjAwarenessAdministrationGUI::editSettings ( $a_form = null )

Edit settings.

Definition at line 92 of file class.ilObjAwarenessAdministrationGUI.php.

        {
                $this->tabs_gui->setTabActive('settings');
                
                if(!$a_form)
                {
                        $a_form = $this->initFormSettings();
                }               
                $this->tpl->setContent($a_form->getHTML());
                return true;
        }

References initFormSettings().

Referenced by saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjAwarenessAdministrationGUI::executeCommand ( )

Execute command.

@access public

Reimplemented from ilObjectGUI.

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

        {               
                $next_class = $this->ctrl->getNextClass($this);
                $cmd = $this->ctrl->getCmd();
 
                $this->prepareOutput();
 
                switch($next_class)
                {
                        case 'ilpermissiongui':
                                $this->tabs_gui->setTabActive('perm_settings');
                                include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                                $perm_gui = new ilPermissionGUI($this);
                                $this->ctrl->forwardCommand($perm_gui);
                                break;
 
                        default:
                                if(!$cmd || $cmd == 'view')
                                {
                                        $cmd = "editSettings";
                                }
 
                                $this->$cmd();
                                break;
                }
                return true;
        }

References $cmd, and ilObjectGUI\prepareOutput().

Here is the call graph for this function:

◆ getAdminTabs()

ilObjAwarenessAdministrationGUI::getAdminTabs ( )

Get tabs.

Definition at line 69 of file class.ilObjAwarenessAdministrationGUI.php.

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

◆ initFormSettings()

ilObjAwarenessAdministrationGUI::initFormSettings ( )

protected

Init settings property form.

@access protected

Definition at line 161 of file class.ilObjAwarenessAdministrationGUI.php.

        {
            global $lng;
                
                include_once('Services/Form/classes/class.ilPropertyFormGUI.php');
                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this));
                $form->setTitle($this->lng->txt('awareness_settings'));
                $form->addCommandButton('saveSettings',$this->lng->txt('save'));
                $form->addCommandButton('cancel',$this->lng->txt('cancel'));
 
                $en = new ilCheckboxInputGUI($lng->txt("awrn_enable"), "enable_awareness");
                $form->addItem($en);
 
                $awrn_set = new ilSetting("awrn");
                $en->setChecked($awrn_set->get("awrn_enabled", false));
 
                // caching period
                $ti = new ilNumberInputGUI($this->lng->txt("awrn_caching_period"), "caching_period");
                $ti->setInfo($this->lng->txt("awrn_caching_period_info"));
                $ti->setSuffix($this->lng->txt("awrn_seconds"));
                $ti->setSize(6);
                $ti->setMaxLength(6);
                $ti->setValue($awrn_set->get("caching_period"));
                $en->addSubItem($ti);
 
                // limit number of entries
                $ti = new ilNumberInputGUI($this->lng->txt("awrn_max_nr_entries"), "max_nr_entries");
                $ti->setInfo($this->lng->txt("awrn_max_nr_entries_info"));
                $ti->setSize(3);
                $ti->setMaxLength(3);
                $ti->setMinValue(5);
                $ti->setMaxValue(200);
                $ti->setValue($awrn_set->get("max_nr_entries"));
                $en->addSubItem($ti);
 
                // maximum inactivity time
                $pd_set = new ilSetting("pd");          // under pd settings due to historical reasons
                $ti_prop = new ilNumberInputGUI($lng->txt("awrn_max_inactivity"),
                        "time_removal");
                $ti_prop->setSuffix($this->lng->txt("awrn_minutes"));
                if ($pd_set->get("user_activity_time") > 0)
                {
                        $ti_prop->setValue($pd_set->get("user_activity_time"));
                }
                $ti_prop->setInfo($lng->txt("awrn_max_inactivity_info"));
                $ti_prop->setMaxLength(3);
                $ti_prop->setSize(3);
                $en->addSubItem($ti_prop);
 
 
                include_once("./Services/Awareness/classes/class.ilAwarenessUserProviderFactory.php");
                $prov = ilAwarenessUserProviderFactory::getAllProviders();
                foreach ($prov as $p)
                {
                        // activation mode
                        $options = array(
                                ilAwarenessUserProvider::MODE_INACTIVE => $lng->txt("awrn_inactive"),
                                ilAwarenessUserProvider::MODE_ONLINE_ONLY => $lng->txt("awrn_online_only"),
                                ilAwarenessUserProvider::MODE_INCL_OFFLINE => $lng->txt("awrn_incl_offline")
                                );
                        $si = new ilSelectInputGUI($p->getTitle(), "up_act_mode_".$p->getProviderId());
                        $si->setOptions($options);
                        $si->setInfo($p->getInfo());
                        $si->setValue($p->getActivationMode());
                        $en->addSubItem($si);
                }
 
                return $form;
        }

References ilObjectGUI\$lng, $options, $si, ilAwarenessUserProviderFactory\getAllProviders(), ilAwarenessUserProvider\MODE_INACTIVE, ilAwarenessUserProvider\MODE_INCL_OFFLINE, and ilAwarenessUserProvider\MODE_ONLINE_ONLY.

Referenced by editSettings(), and saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettings()

ilObjAwarenessAdministrationGUI::saveSettings ( )

Save settings.

Definition at line 107 of file class.ilObjAwarenessAdministrationGUI.php.

        {
                global $ilCtrl;
                
                $this->checkPermission("write");
                
                $form = $this->initFormSettings();
                if($form->checkInput())
                {
                        $awrn_set = new ilSetting("awrn");
                        $awrn_set->set("awrn_enabled", (bool) $form->getInput("enable_awareness"));
 
                        $p = (int) $form->getInput("caching_period");
                        if ($p < 0)
                        {
                                $p = 0;
                        }
                        $awrn_set->set("caching_period", $p);
 
                        $awrn_set->set("max_nr_entries", (int) $form->getInput("max_nr_entries"));
 
                        $pd_set = new ilSetting("pd");
                        $pd_set->set("user_activity_time", (int) $_POST["time_removal"]);
 
                        include_once("./Services/Awareness/classes/class.ilAwarenessUserProviderFactory.php");
                        $prov = ilAwarenessUserProviderFactory::getAllProviders();
                        foreach ($prov as $p)
                        {
                                $p->setActivationMode($form->getInput("up_act_mode_".$p->getProviderId()));
                        }
 
                        ilUtil::sendSuccess($this->lng->txt("settings_saved"),true);
                        $ilCtrl->redirect($this, "editSettings");
                }
                
                $form->setValuesByPost();
                $this->editSettings($form);
        }

References $_POST, $ilCtrl, ilObjectGUI\checkPermission(), editSettings(), ilAwarenessUserProviderFactory\getAllProviders(), initFormSettings(), and ilUtil\sendSuccess().

Here is the call graph for this function:

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

Services/Awareness/classes/class.ilObjAwarenessAdministrationGUI.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancel()

◆ editSettings()

◆ executeCommand()

◆ getAdminTabs()

◆ initFormSettings()

◆ saveSettings()