Class ilObjSurveyAdministrationGUI. More...

Inheritance diagram for ilObjSurveyAdministrationGUI:

Collaboration diagram for ilObjSurveyAdministrationGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference)

	executeCommand ()

	settingsObject (ilPropertyFormGUI $a_form=null)
	display survey settings form More...

	saveSettingsObject ()
	Save survey settings. More...

	getAdminTabs ()

	getTabs ()
	get tabs public 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...

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

Data Fields
	$conditions
	Constructor public. 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 Member Functions
	initSettingsForm ()

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

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

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

Private Member Functions
	getSettingsTemplateConfig ()
	Get settings template configuration object. 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...

Protected Attributes inherited from ilObjectGUI
	$tmp_import_dir

	$tabs_gui = null

	$ctrl

Detailed Description

Class ilObjSurveyAdministrationGUI.

Author: Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

Version: $Id$

ilObjSurveyAdministrationGUI: ilPermissionGUI, ilSettingsTemplateGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjSurveyAdministrationGUI::__construct	(	$a_data,
		$a_id,
		$a_call_by_reference
	)

Definition at line 46 of file class.ilObjSurveyAdministrationGUI.php.

References ilObjectGUI\$lng.

         {
                 global $lng;
 
                 $this->type = "svyf";
                 $lng->loadLanguageModule("survey");
                 parent::__construct($a_data,$a_id,$a_call_by_reference,false);
         }

Member Function Documentation

◆ executeCommand()

ilObjSurveyAdministrationGUI::executeCommand ( )

Definition at line 55 of file class.ilObjSurveyAdministrationGUI.php.

References $cmd, $ret, getSettingsTemplateConfig(), and ilObjectGUI\prepareOutput().

         {
                 global $ilTabs;
 
                 $next_class = $this->ctrl->getNextClass($this);
                 $cmd = $this->ctrl->getCmd();
                 $this->prepareOutput();
 
                 switch($next_class)
                 {
                         case 'ilpermissiongui':
                                 $ilTabs->activateTab("perm_settings");
                                 include_once("Services/AccessControl/classes/class.ilPermissionGUI.php");
                                 $perm_gui = new ilPermissionGUI($this);
                                 $ret =& $this->ctrl->forwardCommand($perm_gui);
                                 break;
 
                         case 'ilsettingstemplategui':
                                 $ilTabs->activateTab("templates");
                                 include_once("./Services/Administration/classes/class.ilSettingsTemplateGUI.php");
                                 $set_tpl_gui = new ilSettingsTemplateGUI($this->getSettingsTemplateConfig());
                                 $this->ctrl->forwardCommand($set_tpl_gui);
                                 break;
 
                         default:
                                 if($cmd == "" || $cmd == "view")
                                 {
                                         $cmd = "settings";
                                 }
                                 $cmd .= "Object";
                                 $this->$cmd();
 
                                 break;
                 }
                 return true;
         }

Here is the call graph for this function:

◆ getAdminTabs()

ilObjSurveyAdministrationGUI::getAdminTabs ( )

Definition at line 219 of file class.ilObjSurveyAdministrationGUI.php.

References getTabs().

         {
                 $this->getTabs();
         }

Here is the call graph for this function:

◆ getSettingsTemplateConfig()

ilObjSurveyAdministrationGUI::getSettingsTemplateConfig ( )

private

Get settings template configuration object.

Returns: object settings template configuration object

Definition at line 266 of file class.ilObjSurveyAdministrationGUI.php.

References $config, ilObjectGUI\$lng, array, ilSettingsTemplateConfig\BOOL, ilObjSurvey\EVALUATION_ACCESS_ALL, ilObjSurvey\EVALUATION_ACCESS_OFF, ilObjSurvey\EVALUATION_ACCESS_PARTICIPANTS, and ilSettingsTemplateConfig\SELECT.

Referenced by executeCommand().

         {
                 global $lng;
 
                 $lng->loadLanguageModule("survey");
                 include_once "Modules/Survey/classes/class.ilObjSurvey.php";
 
                 include_once("./Services/Administration/classes/class.ilSettingsTemplateConfig.php");
                 $config = new ilSettingsTemplateConfig("svy");
 
                 $config->addHidableTab("survey_question_editor", $lng->txt("survey_question_editor_settings_template"));
                 $config->addHidableTab("constraints", $lng->txt("constraints"));
                 $config->addHidableTab("invitation", $lng->txt("invitation"));
                 $config->addHidableTab("meta_data", $lng->txt("meta_data"));
                 $config->addHidableTab("export", $lng->txt("export"));
 
                 $config->addSetting(
                         "use_pool",
                         ilSettingsTemplateConfig::SELECT,
                         $lng->txt("survey_question_pool_usage"),
                         true,
                         0,
                         array(1 => $this->lng->txt("survey_question_pool_usage_active"),        
                                 0 => $this->lng->txt("survey_question_pool_usage_inactive"))
                         );
                 
                 
                 $config->addSetting(
                         "enabled_start_date",
                         ilSettingsTemplateConfig::BOOL,
                         $lng->txt("start_date"),
                         true
                         );
 
                 $config->addSetting(
                         "enabled_end_date",
                         ilSettingsTemplateConfig::BOOL,
                         $lng->txt("end_date"),
                         true
                         );
 
                 $config->addSetting(
                         "show_question_titles",
                         ilSettingsTemplateConfig::BOOL,
                         $lng->txt("svy_show_questiontitles"),
                         true
                         );
 
                 
                 // #17585
                 
                 $config->addSetting(
                         "acc_codes",
                         ilSettingsTemplateConfig::BOOL,
                         $lng->txt("survey_access_codes"),
                         true
                         );
                 
                 $config->addSetting(
                         "evaluation_access",
                         ilSettingsTemplateConfig::SELECT,
                         $lng->txt("evaluation_access"),
                         true,
                         0,
                         array(ilObjSurvey::EVALUATION_ACCESS_OFF => $this->lng->txt("evaluation_access_off"),   
                                 ilObjSurvey::EVALUATION_ACCESS_ALL => $this->lng->txt("evaluation_access_all"),
                                 ilObjSurvey::EVALUATION_ACCESS_PARTICIPANTS => $this->lng->txt("evaluation_access_participants"))
                         );              
                 
                 $config->addSetting(
                         "anonymization_options",
                         ilSettingsTemplateConfig::SELECT,
                         $lng->txt("survey_results_anonymization"),
                         true,
                         0,
                         array("statpers" => $this->lng->txt("survey_results_personalized"),     
                                 "statanon" => $this->lng->txt("survey_results_anonymized"))
                         );
                 
                 /*
                 $config->addSetting(
                         "rte_switch",
                         ilSettingsTemplateConfig::SELECT,
                         $lng->txt("set_edit_mode"),
                         true,
                         0,
                         array(0 => $this->lng->txt("rte_editor_disabled"),
                                 1 => $this->lng->txt("rte_editor_enabled"))
                         );
                 */
         
                 return $config;
         }

Here is the caller graph for this function:

◆ getTabs()

ilObjSurveyAdministrationGUI::getTabs ( )

get tabs public

Parameters

object tabs gui object

Definition at line 229 of file class.ilObjSurveyAdministrationGUI.php.

References ilObjectGUI\$lng, and ilObjectGUI\checkPermissionBool().

Referenced by getAdminTabs().

         {
                 global $lng;
 
                 if ($this->checkPermissionBool("read"))
                 {
                         $this->tabs_gui->addTab("settings",
                                 $lng->txt("settings"),
                                 $this->ctrl->getLinkTarget($this, "settings"));
 
                         // #7927: special users are deprecated
                         /*
                         $tabs_gui->addTab("specialusers",
                                 $lng->txt("specialusers"),
                                 $this->ctrl->getLinkTarget($this, "specialusers"));                     
                         */
 
                         if ($this->checkPermissionBool("write"))
                         {
                                 $this->tabs_gui->addTab("templates",
                                         $lng->txt("adm_settings_templates"),
                                         $this->ctrl->getLinkTargetByClass("ilsettingstemplategui", ""));
                         }
                 }
                 if ($this->checkPermissionBool("edit_permission"))
                 {
                         $this->tabs_gui->addTab("perm_settings",
                                 $lng->txt("perm_settings"),
                                 $this->ctrl->getLinkTargetByClass('ilpermissiongui', "perm"));
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettingsForm()

ilObjSurveyAdministrationGUI::initSettingsForm ( )

protected

Definition at line 114 of file class.ilObjSurveyAdministrationGUI.php.

References $_GET, $code, $ilCtrl, ilObjectGUI\$lng, ilCheckboxInputGUI\setChecked(), ilRadioOption\setInfo(), ilFormPropertyGUI\setInfo(), ilFormPropertyGUI\setRequired(), and ilTextInputGUI\setSize().

Referenced by saveSettingsObject(), and settingsObject().

         {
                 global $ilAccess, $lng, $ilCtrl;
 
                 $surveySetting = new ilSetting("survey");
                 $unlimited_invitation = array_key_exists("unlimited_invitation", $_GET) ? $_GET["unlimited_invitation"] : $surveySetting->get("unlimited_invitation");  
                 $use_anonymous_id = array_key_exists("use_anonymous_id", $_GET) ? $_GET["use_anonymous_id"] : $surveySetting->get("use_anonymous_id");
                 
                 include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                 $form = new ilPropertyFormGUI();
                 $form->setFormAction($ilCtrl->getFormAction($this));
                 $form->setTitle($lng->txt("survey_defaults"));
                 
                 // unlimited invitation
                 $enable = new ilCheckboxInputGUI($lng->txt("survey_unlimited_invitation"), "unlimited_invitation");
                 $enable->setChecked($unlimited_invitation);
                 $enable->setInfo($lng->txt("survey_unlimited_invitation_desc"));
                 $form->addItem($enable);
                 
                 // Survey Code
                 $code = new ilCheckboxInputGUI($lng->txt("use_anonymous_id"), "use_anonymous_id");
                 $code->setChecked($use_anonymous_id);
                 $code->setInfo($lng->txt("use_anonymous_id_desc"));
                 $form->addItem($code);
                 
                 // Skipped
                 $eval_skipped = new ilRadioGroupInputGUI($lng->txt("svy_eval_skipped_value"), "skcust");
                 $eval_skipped->setRequired(true);
                 $form->addItem($eval_skipped);
                 
                 $eval_skipped->setValue($surveySetting->get("skipped_is_custom", false) 
                         ? "cust"
                         : "lng");
                 
                 $skipped_lng = new ilRadioOption($lng->txt("svy_eval_skipped_value_lng"), "lng");
                 $skipped_lng->setInfo(sprintf($lng->txt("svy_eval_skipped_value_lng_info"), $lng->txt("skipped")));
                 $eval_skipped->addOption($skipped_lng);
                 $skipped_cust = new ilRadioOption($lng->txt("svy_eval_skipped_value_custom"), "cust");
                 $skipped_cust->setInfo($lng->txt("svy_eval_skipped_value_custom_info"));
                 $eval_skipped->addOption($skipped_cust);
                 
                 $skipped_cust_value = new ilTextInputGUI($lng->txt("svy_eval_skipped_value_custom_value"), "cust_value");
                 $skipped_cust_value->setSize(15);
                 $skipped_cust_value->setValue($surveySetting->get("skipped_custom_value", ""));
                 $skipped_cust->addSubItem($skipped_cust_value);
                 
                 $anon_part = new ilCheckboxInputGUI($lng->txt("svy_anonymous_participants"), "anon_part");
                 $anon_part->setInfo($lng->txt("svy_anonymous_participants_info"));
                 $anon_part->setChecked($surveySetting->get("anonymous_participants", false));
                 $form->addItem($anon_part);             
                 
                 $anon_part_min = new ilNumberInputGUI($lng->txt("svy_anonymous_participants_min"), "anon_part_min");
                 $anon_part_min->setInfo($lng->txt("svy_anonymous_participants_min_info"));
                 $anon_part_min->setSize(4);
                 $anon_part_min->setMinValue(1);
                 $anon_part_min->setValue($surveySetting->get("anonymous_participants_min", null));
                 $anon_part->addSubItem($anon_part_min);
 
                 if ($ilAccess->checkAccess("write", "", $this->object->getRefId()))
                 {
                         $form->addCommandButton("saveSettings", $lng->txt("save"));
                 }
                 
                 return $form;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSettingsObject()

ilObjSurveyAdministrationGUI::saveSettingsObject ( )

Save survey settings.

Definition at line 183 of file class.ilObjSurveyAdministrationGUI.php.

References $_POST, $ilCtrl, initSettingsForm(), ilUtil\sendSuccess(), and settingsObject().

         {
                 global $ilCtrl, $ilAccess;
                 
                 if (!$ilAccess->checkAccess("write", "", $this->object->getRefId())) 
                 {
                         $ilCtrl->redirect($this, "settings");
                 }
                 
                 $form = $this->initSettingsForm();
                 if($form->checkInput())
                 {                                       
                         $surveySetting = new ilSetting("survey");
                         $surveySetting->set("unlimited_invitation", ($_POST["unlimited_invitation"]) ? "1" : "0");
                         $surveySetting->set("use_anonymous_id", ($_POST["use_anonymous_id"]) ? "1" : "0");
                         $surveySetting->set("anonymous_participants", ($_POST["anon_part"]) ? "1" : "0");
                         $surveySetting->set("anonymous_participants_min", (trim($_POST["anon_part_min"])) ? (int)$_POST["anon_part_min"] : null);
 
                         if($_POST["skcust"] == "lng")
                         {
                                 $surveySetting->set("skipped_is_custom", false);
                         }
                         else
                         {
                                 $surveySetting->set("skipped_is_custom", true);
                                 $surveySetting->set("skipped_custom_value", trim($_POST["cust_value"]));
                         }
 
                         ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
                         $ilCtrl->redirect($this, "settings");
                 }
                 
                 $form->setValuesByPost();
                 $this->settingsObject($form);
         }

Here is the call graph for this function:

◆ settingsObject()

ilObjSurveyAdministrationGUI::settingsObject ( ilPropertyFormGUI $a_form = null )

display survey settings form

Default settings tab for Survey settings

public

Definition at line 100 of file class.ilObjSurveyAdministrationGUI.php.

References ilObjectGUI\$tpl, and initSettingsForm().

Referenced by saveSettingsObject().

         {
                 global $tpl, $ilTabs;
                 
                 $ilTabs->activateTab("settings");
                 
                 if(!$a_form)
                 {
                         $a_form = $this->initSettingsForm();
                 }
                 
                 $tpl->setContent($a_form->getHTML());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $conditions

ilObjSurveyAdministrationGUI::$conditions

Constructor public.

Definition at line 44 of file class.ilObjSurveyAdministrationGUI.php.

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

Modules/Survey/classes/class.ilObjSurveyAdministrationGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ getAdminTabs()

◆ getSettingsTemplateConfig()

◆ getTabs()

◆ initSettingsForm()

◆ saveSettingsObject()

◆ settingsObject()

Field Documentation

◆ $conditions