LearningSequence Administration Settings. More...

Inheritance diagram for ilObjLearningSequenceAdminGUI:

Collaboration diagram for ilObjLearningSequenceAdminGUI:

Public Member Functions
	__construct ($a_data, $a_id, $a_call_by_reference=true, $a_prepare_output=true)

	getAdminTabs ()

	executeCommand ()

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

	redirectAfterCreation ()
	Redirect after creation, see https://docu.ilias.de/goto_docu_wiki_wpage_5035_1357.html. More...

Data Fields
const	CMD_VIEW = 'view'

const	CMD_EDIT = 'edit'

const	CMD_SAVE = 'save'

const	F_POLL_INTERVAL = 'polling'

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
	getForm (array $values=[])

	show (Input\Container\Form\Form $form)

	edit ()

	save ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()
	Get object service. More...

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

Protected Attributes
	$settings_db

Protected Attributes inherited from ilObjectGUI
	$ilErr

	$locator

	$user

	$access

	$settings

	$rbacreview

	$toolbar

	$tmp_import_dir

	$tabs_gui = null

	$ctrl

	$object_service

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

Detailed Description

LearningSequence Administration Settings.

ilObjLearningSequenceAdminGUI: ilPermissionGUI

Definition at line 10 of file class.ilObjLearningSequenceAdminGUI.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC.

     {
         $this->type = 'lsos';
 
         global $DIC;
         $this->ctrl = $DIC['ilCtrl'];
         $this->rbacsystem = $DIC['rbacsystem'];
         parent::__construct($a_data, $a_id, $a_call_by_reference, $a_prepare_output);
 
         $this->settings_db = new ilLSGlobalSettingsDB($DIC['ilSetting']);
         $this->ui_factory = $DIC['ui.factory'];
         $this->ui_renderer = $DIC['ui.renderer'];
         $this->request = $DIC->http()->request();
         $this->validation_factory = new \ILIAS\Validation\Factory(
             new \ILIAS\Data\Factory(),
             $this->lng
         );
         $this->transformation_factory = new \ILIAS\Transformation\Factory();
     }

Member Function Documentation

◆ edit()

ilObjLearningSequenceAdminGUI::edit ( )

protected

Definition at line 124 of file class.ilObjLearningSequenceAdminGUI.php.

References $form, $values, getForm(), and show().

Referenced by executeCommand().

     {
         $values = [
             self::F_POLL_INTERVAL => $this->settings_db->getSettings()->getPollingIntervalSeconds()
         ];
         $form = $this->getForm($values);
         $this->show($form);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjLearningSequenceAdminGUI::executeCommand ( )

Definition at line 50 of file class.ilObjLearningSequenceAdminGUI.php.

References ilObjectGUI\checkPermission(), edit(), ilObjectGUI\prepareOutput(), and save().

     {
         $this->checkPermission('read');
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
         $this->prepareOutput();
         
         switch ($next_class) {
             case 'ilpermissiongui':
                 $this->tabs_gui->setTabActive('perm_settings');
                 $perm_gui = new ilPermissionGUI($this);
                 $this->ctrl->forwardCommand($perm_gui);
                 break;
 
             default:
                 switch ($cmd) {
                     case self::CMD_VIEW:
                     case self::CMD_EDIT:
                         $this->edit();
                         break;
                     case self::CMD_SAVE:
                         $this->save();
                         break;
                     default:
                         throw new Exception(__METHOD__ . " :: Unknown command " . $cmd);
                 }
         }
     }

Here is the call graph for this function:

◆ getAdminTabs()

ilObjLearningSequenceAdminGUI::getAdminTabs ( )

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

     {
         $this->tabs_gui->addTarget('settings', $this->ctrl->getLinkTargetByClass(self::class, self::CMD_EDIT));
         if ($this->rbacsystem->checkAccess('edit_permission', $this->object->getRefId())) {
             $this->tabs_gui->addTarget('perm_settings', $this->ctrl->getLinkTargetByClass('ilpermissiongui', 'perm'), array(), 'ilpermissiongui');
         }
     }

◆ getForm()

ilObjLearningSequenceAdminGUI::getForm ( array $values = [] )

protected

Definition at line 79 of file class.ilObjLearningSequenceAdminGUI.php.

References ilObjectGUI\$data, $form, $section, $target, and $values.

Referenced by edit(), and save().

                                                    : Input\Container\Form\Form
     {
         $target = $this->ctrl->getLinkTargetByClass(self::class, self::CMD_SAVE);
         $poll_interval = $this->ui_factory->input()->field()->numeric(
             $this->lng->txt("lso_admin_interval_label"),
             $this->lng->txt("lso_admin_interval_byline")
         )
         ->withAdditionalConstraint($this->validation_factory->greaterThan(0))
         ->withAdditionalTransformation(
             $this->transformation_factory->custom(
                 function ($v) {
                     return (float) $v;
                 }
             )
         );
 
         if (isset($values[self::F_POLL_INTERVAL])) {
             $poll_interval = $poll_interval->withValue($values[self::F_POLL_INTERVAL]);
         }
 
         $section = $this->ui_factory->input()->field()->section(
             [self::F_POLL_INTERVAL => $poll_interval],
             $this->lng->txt("lso_admin_form_title"),
             $this->lng->txt("lso_admin_form_byline")
         );
         $form = $this->ui_factory->input()->container()->form()
             ->standard($target, [$section])
             ->withAdditionalTransformation(
                 $this->transformation_factory->custom(
                     function ($data) {
                         return array_shift($data);
                     }
                 )
             );
 
         return $form;
     }

Here is the caller graph for this function:

◆ save()

ilObjLearningSequenceAdminGUI::save ( )

protected

Definition at line 133 of file class.ilObjLearningSequenceAdminGUI.php.

References ilObjectGUI\$data, $form, ilObjectGUI\$settings, getForm(), and show().

Referenced by executeCommand().

     {
         $form = $this->getForm()->withRequest($this->request);
         $data = $form->getData();
         if ($data) {
             $settings = $this->settings_db->getSettings()
                 ->withPollingIntervalSeconds($data[self::F_POLL_INTERVAL]);
             $this->settings_db->storeSettings($settings);
         }
         $this->show($form);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ show()

ilObjLearningSequenceAdminGUI::show ( Input\Container\Form\Form $form )

protected

Definition at line 117 of file class.ilObjLearningSequenceAdminGUI.php.

Referenced by edit(), and save().

     {
         $this->tpl->setContent(
             $this->ui_renderer->render($form)
         );
     }

Here is the caller graph for this function:

Field Documentation

◆ $settings_db

ilObjLearningSequenceAdminGUI::$settings_db

protected

Definition at line 20 of file class.ilObjLearningSequenceAdminGUI.php.

◆ CMD_EDIT

const ilObjLearningSequenceAdminGUI::CMD_EDIT = 'edit'

Definition at line 13 of file class.ilObjLearningSequenceAdminGUI.php.

◆ CMD_SAVE

const ilObjLearningSequenceAdminGUI::CMD_SAVE = 'save'

Definition at line 14 of file class.ilObjLearningSequenceAdminGUI.php.

◆ CMD_VIEW

const ilObjLearningSequenceAdminGUI::CMD_VIEW = 'view'

Definition at line 12 of file class.ilObjLearningSequenceAdminGUI.php.

◆ F_POLL_INTERVAL

const ilObjLearningSequenceAdminGUI::F_POLL_INTERVAL = 'polling'

Definition at line 15 of file class.ilObjLearningSequenceAdminGUI.php.

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

Modules/LearningSequence/classes/class.ilObjLearningSequenceAdminGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ edit()

◆ executeCommand()

◆ getAdminTabs()

◆ getForm()

◆ save()

◆ show()

Field Documentation

◆ $settings_db

◆ CMD_EDIT

◆ CMD_SAVE

◆ CMD_VIEW

◆ F_POLL_INTERVAL