Inheritance diagram for ilObjTestFolderGUI:

Collaboration diagram for ilObjTestFolderGUI:

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

	executeCommand ()

	showGlobalSettingsObject (?Form $form=null)

	saveGlobalSettingsObject ()
	Save Assessment settings. More...

	exportLegacyLogsObject ()

	logsObject ()

	getAdminTabs ()

	getLogdataSubtabs ()

Public Member Functions inherited from ilObjectGUI
	getRefId ()

	setAdminMode (string $mode)

	getAdminMode ()

	getObject ()

	executeCommand ()

	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...

	setCreationMode (bool $mode=true)
	If true, a creation screen is displayed the current [ref_id] does belong to the parent class The mode is determined in ilRepositoryGUI. More...

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

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

	cancelObject ()
	cancel action and go back to previous page More...

	createObject ()
	create new object form More...

	editAvailabilityPeriodObject ()

	saveAvailabilityPeriodObject ()

	cancelCreation ()
	cancel create action and go back to repository parent More...

	saveObject ()

	getDidacticTemplateVar (string $type)
	Get didactic template setting from creation screen. More...

	putObjectInTree (ilObject $obj, ?int $parent_node_id=null)
	Add object to tree at given position. More...

	editObject ()

	addExternalEditFormCustom (ilPropertyFormGUI $form)

	updateObject ()
	updates object entry in object_data More...

	getFormAction (string $cmd, string $default_form_action="")
	Get form action for command (command is method name without "Object", e.g. More...

	isVisible (int $ref_id, string $type)

	viewObject ()
	viewObject container presentation for "administration -> repository, trash, permissions" More...

	deleteObject (bool $error=false)
	Display deletion confirmation screen. More...

	setColumnSettings (ilColumnGUI $column_gui)

	addToDeskObject ()

	removeFromDeskObject ()

Public Member Functions inherited from ILIAS\Object\ImplementsCreationCallback
	callCreationCallback (\ilObject $object, \ilObjectDefinition $obj_definition, int $requested_crtcb)

Protected Member Functions
	showLogSettingsObject (?Form $form=null)

	saveLogSettingsObject ()

	buildLogSettingsForm ()

	getTabs ()

Protected Member Functions inherited from ilObjectGUI
	getObjectService ()

	assignObject ()

	setTitleAndDescription ()

	createActionDispatcherGUI ()

	initHeaderAction (?string $sub_type=null, ?int $sub_id=null)
	Add header action menu. More...

	insertHeaderAction (?ilObjectListGUI $list_gui=null)
	Insert header action into main template. More...

	addHeaderAction ()
	Add header action menu. More...

	redrawHeaderActionObject ()
	Ajax call: redraw action header only. More...

	setTabs ()
	set admin tabs More...

	setAdminTabs ()
	set admin tabs More...

	setLocator ()

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

	omitLocator (bool $omit=true)

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

	getCreationFormsHTML (StandardForm\|ilPropertyFormGUI\|array $form)

	getTitleForCreationFormPage ()

	getCreationFormTitle ()

	initCreateForm (string $new_type)

	didacticTemplatesToForm ()

	initDidacticTemplate (ilPropertyFormGUI $form)

	retrieveAdditionalDidacticTemplateOptions ()

	addAdoptContentLinkToToolbar ()

	addImportButtonToToolbar ()

	addAvailabilityPeriodButtonToToolbar (ilToolbarGUI $toolbar)

	parseDidacticTemplateVar (string $var, string $type)

	afterSave (ilObject $new_object)
	Post (successful) object creation hook. More...

	initEditForm ()

	initEditCustomForm (ilPropertyFormGUI $a_form)
	Add custom fields to update form. More...

	getEditFormValues ()

	getEditFormCustomValues (array &$a_values)
	Add values to custom edit fields. More...

	validateCustom (ilPropertyFormGUI $form)
	Validate custom values (if not possible with checkInput()) More...

	updateCustom (ilPropertyFormGUI $form)
	Insert custom update form values into object. More...

	afterUpdate ()
	Post (successful) object update hook. More...

	routeImportCmdObject ()

	importFile (string $file_to_import, string $path_to_uploaded_file_in_temp_dir)

	deleteUploadedImportFile (string $path_to_uploaded_file_in_temp_dir)

	afterImport (ilObject $new_object)
	Post (successful) object import hook. More...

	setFormAction (string $cmd, string $form_action)

	getReturnLocation (string $cmd, string $default_location="")
	Get return location for command (command is method name without "Object", e.g. More...

	setReturnLocation (string $cmd, string $location)
	set specific return location for command More...

	getTargetFrame (string $cmd, string $default_target_frame="")
	get target frame for command (command is method name without "Object", e.g. More...

	setTargetFrame (string $cmd, string $target_frame)
	Set specific target frame for command. More...

	showPossibleSubObjects ()
	show possible sub objects (pull down menu) More...

	getTabs ()
	overwrite in derived GUI class of your object type More...

	redirectToRefId (int $ref_id, string $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 ["ref_id"] value of the request More...

	getCenterColumnHTML ()
	Get center column. More...

	getRightColumnHTML ()
	Display right column. More...

	checkPermission (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	checkPermissionBool (string $perm, string $cmd="", string $type="", ?int $ref_id=null)

	enableDragDropFileUpload ()
	Enables the file upload into this object by dropping files. More...

	getCreatableObjectTypes ()

	buildAddNewItemElements (array $subtypes, string $create_target_class=ilRepositoryGUI::class, ?int $redirect_target_ref_id=null,)

	buildGroup (string $create_target_class, array $obj_types_in_group, string $title, array $subtypes)

Private Member Functions
	getTestFolder ()

	buildGlobalSettingsForm ()

Private Attributes
const	SHOW_LOGS_CMD = 'logs'

RequestDataCollector	$testrequest

TestLogViewer	$log_viewer

GeneralQuestionPropertiesRepository	$questionrepository

DataFactory	$data_factory

Additional Inherited Members
Static Public Member Functions inherited from ilObjectGUI
static	_gotoRepositoryRoot (bool $raise_error=false)
	Goto repository root. More...

static	_gotoRepositoryNode (int $ref_id, string $cmd="")

static	_gotoSharedWorkspaceNode (int $wsp_id)

Data Fields inherited from ilObjectGUI
const	ADMIN_MODE_NONE = ""

const	ADMIN_MODE_SETTINGS = "settings"

const	ADMIN_MODE_REPOSITORY = "repository"

const	UPLOAD_TYPE_LOCAL = 1

const	UPLOAD_TYPE_UPLOAD_DIRECTORY = 2

const	CFORM_NEW = 1

const	CFORM_IMPORT = 2

const	CFORM_CLONE = 3

const	SUPPORTED_IMPORT_MIME_TYPES = [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED]

Protected Attributes inherited from ilObjectGUI
ILIAS Notes Service	$notes_service

ServerRequestInterface	$request

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilSetting	$settings

ilToolbarGUI	$toolbar

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

ilObjectService	$object_service

ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilCtrl	$ctrl

ilErrorHandling	$error

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ILIAS	$ilias

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Refinery	$refinery

ilFavouritesManager	$favourites

ilObjectCustomIconFactory	$custom_icon_factory

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Filesystem	$temp_file_system

ilObject	$object = null

bool	$creation_mode = false

	$data

int	$id

bool	$call_by_reference = false

bool	$prepare_output

int	$ref_id

int	$obj_id

int	$maxcount

array	$form_action = []

array	$return_location = []

array	$target_frame = []

string	$tmp_import_dir

string	$sub_objects = ""

bool	$omit_locator = false

string	$type = ""

string	$admin_mode = self::ADMIN_MODE_NONE

int	$requested_ref_id = 0

int	$requested_crtptrefid = 0

int	$requested_crtcb = 0

string	$requested_new_type = ""

string	$link_params

string	$html = ""

Detailed Description

Author: Helmut Schottmüller hscho.nosp@m.ttm@.nosp@m.gmx.d.nosp@m.e ilObjTestFolderGUI: ilPermissionGUI, ilGlobalUnitConfigurationGUI

Definition at line 34 of file class.ilObjTestFolderGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjTestFolderGUI::__construct	(		$a_data,
		int	$a_id = `0`,
		bool	$a_call_by_reference = `true`,
		bool	$a_prepare_output = `true`
	)

Definition at line 45 of file class.ilObjTestFolderGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

       {
         global $DIC;
         $rbacsystem = $DIC['rbacsystem'];
         $this->data_factory = new DataFactory();
 
         $local_dic = TestDIC::dic();
         $this->testrequest = $local_dic['request_data_collector'];
         $this->log_viewer = $local_dic['logging.viewer'];
         $this->questionrepository = $local_dic['question.general_properties.repository'];
 
         $this->type = 'assf';
 
         parent::__construct($a_data, $a_id, $a_call_by_reference, false);
 
         if (!$rbacsystem->checkAccess('read', $this->object->getRefId())) {
             $this->ilias->raiseError($this->lng->txt("msg_no_perm_read_assf"), $this->ilias->error_obj->WARNING);
         }
 
         $this->lng->loadLanguageModule('assessment');
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildGlobalSettingsForm()

ilObjTestFolderGUI::buildGlobalSettingsForm ( )

private

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

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), getTestFolder(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by saveGlobalSettingsObject(), and showGlobalSettingsObject().

                                               : Form
     {
         $inputs = $this->getTestFolder()->getGlobalSettingsRepository()->getGlobalSettings()->toForm(
             $this->ui_factory,
             $this->refinery,
             $this->lng
         );
 
         return $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormActionByClass(self::class, 'SaveGlobalSettings'),
             $inputs
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildLogSettingsForm()

ilObjTestFolderGUI::buildLogSettingsForm ( )

protected

Definition at line 204 of file class.ilObjTestFolderGUI.php.

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), getTestFolder(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by saveLogSettingsObject(), and showLogSettingsObject().

                                              : Form
     {
         $inputs = $this->getTestFolder()->getGlobalSettingsRepository()->getLoggingSettings()->toForm(
             $this->ui_factory,
             $this->refinery,
             $this->lng
         );
 
         return $this->ui_factory->input()->container()->form()->standard(
             $this->ctrl->getFormActionByClass(self::class, 'saveLogSettings'),
             $inputs
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjTestFolderGUI::executeCommand ( )

Definition at line 77 of file class.ilObjTestFolderGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, and ilObjectGUI\prepareOutput().

                                     : void
     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
         $this->prepareOutput();
 
         switch ($next_class) {
             case 'ilpermissiongui':
                 $this->tabs_gui->activateTab('perm_settings');
                 $perm_gui = new \ilPermissionGUI($this);
                 $this->ctrl->forwardCommand($perm_gui);
                 break;
             case 'ilglobalunitconfigurationgui':
                 if (!$this->rbac_system->checkAccess('visible,read', $this->getTestFolder()->getRefId())) {
                     $this->ilias->raiseError($this->lng->txt('permission_denied'), $this->ilias->error_obj->WARNING);
                 }
 
                 $this->tabs_gui->setTabActive('units');
 
                 $gui = new \ilGlobalUnitConfigurationGUI(
                     new \ilUnitConfigurationRepository(0)
                 );
                 $this->ctrl->forwardCommand($gui);
                 break;
 
             default:
                 if ($cmd === null || $cmd === '' || $cmd === 'view') {
                     $cmd = 'showGlobalSettings';
                 }
                 $cmd .= 'Object';
                 $this->$cmd();
 
                 break;
         }
     }

Here is the call graph for this function:

◆ exportLegacyLogsObject()

ilObjTestFolderGUI::exportLegacyLogsObject ( )

Definition at line 162 of file class.ilObjTestFolderGUI.php.

References ilUtil\deliverData(), and getTestFolder().

                                             : void
     {
         $csv_output = $this->getTestFolder()->getTestLogViewer()->getLegacyLogExportForObjId();
 
         ilUtil::deliverData(
             $csv_output,
             'legacy_logs.csv'
         );
     }

Here is the call graph for this function:

◆ getAdminTabs()

ilObjTestFolderGUI::getAdminTabs ( )

Definition at line 251 of file class.ilObjTestFolderGUI.php.

References getTabs().

                                   : void
     {
         $this->getTabs();
     }

Here is the call graph for this function:

◆ getLogdataSubtabs()

ilObjTestFolderGUI::getLogdataSubtabs ( )

Definition at line 256 of file class.ilObjTestFolderGUI.php.

References ILIAS\Repository\ctrl().

Referenced by getTabs().

                                        : void
     {
         $this->tabs_gui->addSubTabTarget(
             'settings',
             $this->ctrl->getLinkTarget($this, 'showLogSettings'),
             ['saveLogSettings', 'showLogSettings'],
             ''
         );
 
         // log output
         $this->tabs_gui->addSubTabTarget(
             'logs_output',
             $this->ctrl->getLinkTargetByClass(self::class, self::SHOW_LOGS_CMD),
             [self::SHOW_LOGS_CMD],
             ''
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTabs()

ilObjTestFolderGUI::getTabs ( )

protected

Definition at line 274 of file class.ilObjTestFolderGUI.php.

References ILIAS\Repository\ctrl(), and getLogdataSubtabs().

Referenced by getAdminTabs().

                                 : void
     {
         if (in_array($this->ctrl->getCmd(), ['saveLogSettings', 'showLogSettings', self::SHOW_LOGS_CMD])) {
             $this->getLogdataSubtabs();
         }
 
         if ($this->rbac_system->checkAccess('visible,read', $this->getTestFolder()->getRefId())) {
             $this->tabs_gui->addTarget(
                 'settings',
                 $this->ctrl->getLinkTarget($this, 'showGlobalSettings'),
                 ['showGlobalSettings', 'settings', '', 'view'],
                 '',
                 ''
             );
 
             $this->tabs_gui->addTarget(
                 'logs',
                 $this->ctrl->getLinkTarget($this, "showLogSettings"),
                 ['saveLogSettings', 'showLogSettings', self::SHOW_LOGS_CMD, 'showLog', 'exportLog', 'logAdmin', 'deleteLog'],
                 '',
                 ''
             );
 
             $this->tabs_gui->addTarget(
                 'units',
                 $this->ctrl->getLinkTargetByClass('ilGlobalUnitConfigurationGUI', ''),
                 '',
                 'ilglobalunitconfigurationgui'
             );
         }
 
         if ($this->rbac_system->checkAccess('edit_permission', $this->getTestFolder()->getRefId())) {
             $this->tabs_gui->addTarget(
                 "perm_settings",
                 $this->ctrl->getLinkTargetByClass([get_class($this), 'ilpermissiongui'], "perm"),
                 ["perm", "info", "owner"],
                 'ilpermissiongui'
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTestFolder()

ilObjTestFolderGUI::getTestFolder ( )

private

PhpIncompatibleReturnTypeInspection

Definition at line 71 of file class.ilObjTestFolderGUI.php.

References ilObjectGUI\$object.

Referenced by buildGlobalSettingsForm(), buildLogSettingsForm(), exportLegacyLogsObject(), saveGlobalSettingsObject(), and saveLogSettingsObject().

                                     : ilObjTestFolder
     {
         return $this->object;
     }

Here is the caller graph for this function:

◆ logsObject()

ilObjTestFolderGUI::logsObject ( )

Definition at line 218 of file class.ilObjTestFolderGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

                                 : void
     {
         $this->tabs_gui->activateTab('logs');
         $this->toolbar->addComponent(
             $this->ui_factory->button()->standard(
                 $this->lng->txt('export_legacy_logs'),
                 $this->ctrl->getLinkTargetByClass(self::class, 'exportLegacyLogs')
             )
         );
         $here_uri = $this->data_factory->uri(ILIAS_HTTP_PATH
             . '/' . $this->ctrl->getLinkTargetByClass(self::class, self::SHOW_LOGS_CMD));
         list($url_builder, $action_parameter_token, $row_id_token) = (new URLBuilder($here_uri))->acquireParameters(
             LogTable::QUERY_PARAMETER_NAME_SPACE,
             LogTable::ACTION_TOKEN_STRING,
             LogTable::ENTRY_TOKEN_STRING
         );
 
         if ($this->request_wrapper->has($action_parameter_token->getName())) {
             $this->object->getTestLogViewer()->executeLogTableAction(
                 $url_builder,
                 $action_parameter_token,
                 $row_id_token
             );
         }
 
         $table_gui = $this->log_viewer->getLogTable(
             $url_builder,
             $action_parameter_token,
             $row_id_token
         );
         $this->tpl->setVariable('ADM_CONTENT', $this->ui_renderer->render($table_gui));
     }

Here is the call graph for this function:

◆ saveGlobalSettingsObject()

ilObjTestFolderGUI::saveGlobalSettingsObject ( )

Save Assessment settings.

Definition at line 141 of file class.ilObjTestFolderGUI.php.

References ilObjectGUI\$data, ILIAS\Repository\access(), buildGlobalSettingsForm(), getTestFolder(), ILIAS\Repository\lng(), null, and showGlobalSettingsObject().

                                               : void
     {
         if (!$this->access->checkAccess('write', '', $this->getTestFolder()->getRefId())) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'));
             $this->showGlobalSettingsObject();
             return;
         }
 
         $form = $this->buildGlobalSettingsForm()->withRequest($this->request);
         $data = $form->getData();
         if ($data === null) {
             $this->showGlobalSettingsObject($form);
             return;
         }
 
         $this->getTestFolder()->getGlobalSettingsRepository()
             ->storeGlobalSettings($data['global_settings']);
 
         $this->showGlobalSettingsObject($form);
     }

Here is the call graph for this function:

◆ saveLogSettingsObject()

ilObjTestFolderGUI::saveLogSettingsObject ( )

protected

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

References ilObjectGUI\$data, ILIAS\Repository\access(), buildLogSettingsForm(), getTestFolder(), ILIAS\Repository\lng(), null, and showLogSettingsObject().

                                               : void
     {
         if (!$this->access->checkAccess('write', '', $this->getTestFolder()->getRefId())) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'));
             $this->showLogSettingsObject();
             return;
         }
 
         $form = $this->buildLogSettingsForm()->withRequest($this->request);
         $data = $form->getData();
         if ($data === null) {
             $this->showLogSettingsObject($form);
             return;
         }
 
         $this->getTestFolder()->getGlobalSettingsRepository()
             ->storeLoggingSettings($data['logging']);
 
         $this->showLogSettingsObject($form);
     }

Here is the call graph for this function:

◆ showGlobalSettingsObject()

ilObjTestFolderGUI::showGlobalSettingsObject ( ?Form $form = null )

Definition at line 113 of file class.ilObjTestFolderGUI.php.

References buildGlobalSettingsForm(), and null.

Referenced by saveGlobalSettingsObject().

                                                                 : void
     {
         $this->tabs_gui->setTabActive('settings');
 
         if ($form === null) {
             $form = $this->buildGlobalSettingsForm();
         }
 
         $this->tpl->setContent($this->ui_renderer->render($form));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showLogSettingsObject()

ilObjTestFolderGUI::showLogSettingsObject ( ?Form $form = null )

protected

Definition at line 172 of file class.ilObjTestFolderGUI.php.

References buildLogSettingsForm(), and null.

Referenced by saveLogSettingsObject().

                                                                 : void
     {
         $this->tabs_gui->activateTab('logs');
 
         if ($form === null) {
             $form = $this->buildLogSettingsForm();
         }
 
         $this->tpl->setContent($this->ui_renderer->render($form));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $data_factory

DataFactory ilObjTestFolderGUI::$data_factory

private

Definition at line 43 of file class.ilObjTestFolderGUI.php.

◆ $log_viewer

TestLogViewer ilObjTestFolderGUI::$log_viewer

private

Definition at line 39 of file class.ilObjTestFolderGUI.php.

◆ $questionrepository

GeneralQuestionPropertiesRepository ilObjTestFolderGUI::$questionrepository

private

Definition at line 41 of file class.ilObjTestFolderGUI.php.

◆ $testrequest

RequestDataCollector ilObjTestFolderGUI::$testrequest

private

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

◆ SHOW_LOGS_CMD

const ilObjTestFolderGUI::SHOW_LOGS_CMD = 'logs'

private

Definition at line 36 of file class.ilObjTestFolderGUI.php.

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

components/ILIAS/Test/classes/class.ilObjTestFolderGUI.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildGlobalSettingsForm()

◆ buildLogSettingsForm()

◆ executeCommand()

◆ exportLegacyLogsObject()

◆ getAdminTabs()

◆ getLogdataSubtabs()

◆ getTabs()

◆ getTestFolder()

◆ logsObject()

◆ saveGlobalSettingsObject()

◆ saveLogSettingsObject()

◆ showGlobalSettingsObject()

◆ showLogSettingsObject()

Field Documentation

◆ $data_factory

◆ $log_viewer

◆ $questionrepository

◆ $testrequest

◆ SHOW_LOGS_CMD