Inheritance diagram for ilObjTermsOfServiceGUI:

Collaboration diagram for ilObjTermsOfServiceGUI:

Public Member Functions
	__construct (int $a_id=0, int $a_id_type=self::REPOSITORY_NODE_ID, int $a_parent_node_id=0)

	getType ()

	executeCommand ()

	getAdminTabs ()

	form ()

	afterDocumentDeletion ()

Public Member Functions inherited from ilObject2GUI
	__construct (int $id=0, int $id_type=self::REPOSITORY_NODE_ID, int $parent_node_id=0)

	executeCommand ()
	execute command More...

	getIdType ()

	delete ()
	Display delete confirmation form (repository/workspace switch) More...

	confirmedDelete ()
	Delete objects (repository/workspace switch) More...

	getHTML ()

	withReferences ()
	Final/Private declaration of unchanged parent methods. More...

	setCreationMode (bool $mode=true)

	getCreationMode ()

	prepareOutput (bool $show_sub_objects=true)

	isVisible (int $ref_id, string $type)

	setColumnSettings (ilColumnGUI $column_gui)

	view ()
	view object content (repository/workspace switch) More...

	getType ()
	Functions that must be overwritten. More...

	create ()
	CRUD. More...

	save ()

	edit ()

	update ()

	cancel ()

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

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
	settings ()

Protected Member Functions inherited from ilObject2GUI
	afterConstructor ()
	Do anything that should be done after constructor in here. More...

	assignObject ()
	create object instance as internal property (repository/workspace switch) More...

	getAccessHandler ()

	setLocator ()
	set Locator More...

	deleteConfirmedObjects ()
	Delete objects (workspace specific) This should probably be moved elsewhere as done with RepUtil. More...

	setTitleAndDescription ()

	omitLocator (bool $omit=true)

	getTargetFrame (string $cmd, string $target_frame="")

	setTargetFrame (string $cmd, string $target_frame)

	getCenterColumnHTML ()

	getRightColumnHTML ()

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

	showPossibleSubObjects ()

	redirectToRefId (int $ref_id, string $cmd="")

	addAdminLocatorItems (bool $do_not_add_object=false)

	setTabs ()
	create tabs (repository/workspace switch) More...

	getReturnLocation (string $cmd, string $location="")
	Deprecated functions. More...

	setReturnLocation (string $cmd, string $location)

	showActions ()

	getTabs ()

	addLocatorItems ()
	Functions to be overwritten. More...

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

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

	redrawHeaderAction ()
	Updating icons after ajax call. More...

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)

Protected Attributes
ILIAS DI Container	$dic

ilErrorHandling	$error

Protected Attributes inherited from ilObject2GUI
ilObjectDefinition	$obj_definition

ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs_gui

ilFavouritesManager	$favourites

ilErrorHandling	$error

ilLocatorGUI	$locator

ilObjUser	$user

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ArrayBasedRequestWrapper	$post_wrapper

RequestWrapper	$request_wrapper

Factory	$refinery

ilRbacAdmin	$rbac_admin

ilRbacSystem	$rbac_system

ilRbacReview	$rbac_review

int	$request_ref_id

int	$id_type

int	$parent_id

string	$type

string	$html

int	$object_id

int	$node_id = null

array	$creation_forms = []

	$access_handler

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 = ""

Private Member Functions
	documents ()

	confirmReset ()

	resetNow ()

	createSettings ()

Private Attributes
readonly ilLegalDocumentsAdministrationGUI	$legal_documents

readonly Config	$config

readonly UI	$ui

readonly Settings	$tos_settings

Additional Inherited Members
Static Public Member Functions inherited from ilObject2GUI
static	handleAfterSaveCallback (ilObject $obj, ?int $callback_ref_id)
	After creation callback. More...

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

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]

Detailed Description

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de ilObjTermsOfServiceGUI: ilPermissionGUI ilObjTermsOfServiceGUI: ilTermsOfServiceDocumentGUI ilObjTermsOfServiceGUI: ilTermsOfServiceAcceptanceHistoryGUI ilObjTermsOfServiceGUI: ilLegalDocumentsAdministrationGUI ilObjTermsOfServiceGUI: ilAdministrationGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjTermsOfServiceGUI::__construct	(	int	$a_id = `0`,
		int	$a_id_type = `self::REPOSITORY_NODE_ID`,
		int	$a_parent_node_id = `0`
	)

Definition at line 47 of file class.ilObjTermsOfServiceGUI.php.

References $config, $DIC, ILIAS\GlobalScreen\Provider\__construct(), afterDocumentDeletion(), createSettings(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

     {
         global $DIC;
 
         $this->dic = $DIC;
         $this->lng = $DIC->language();
         $this->error = $DIC['ilErr'];
 
         parent::__construct($a_id, $a_id_type, $a_parent_node_id);
 
         $this->lng->loadLanguageModule('tos');
         $this->lng->loadLanguageModule('meta');
         $config = new Config($this->dic['legalDocuments']->provide(Consumer::ID));
         if ($this->rbac_system->checkAccess('write', $this->object->getRefId())) {
             $config = $config->allowEditing();
         }
         $this->config = $config;
         $this->legal_documents = new ilLegalDocumentsAdministrationGUI(self::class, $this->config, $this->afterDocumentDeletion(...));
         $this->ui = new UI(Consumer::ID, $this->dic->ui(), $this->dic->language());
         $this->tos_settings = $this->createSettings();
     }

Here is the call graph for this function:

Member Function Documentation

◆ afterDocumentDeletion()

ilObjTermsOfServiceGUI::afterDocumentDeletion ( )

Definition at line 174 of file class.ilObjTermsOfServiceGUI.php.

Referenced by __construct().

                                            : void
     {
         if ($this->config->legalDocuments()->document()->repository()->countAll() === 0) {
             $this->tos_settings->enabled()->update(false);
         }
     }

Here is the caller graph for this function:

◆ confirmReset()

ilObjTermsOfServiceGUI::confirmReset ( )

private

Definition at line 216 of file class.ilObjTermsOfServiceGUI.php.

Referenced by executeCommand().

                                    : void
     {
         $this->legal_documents->admin()->requireEditable();
         $this->legal_documents->admin()->setContent((new Confirmation($this->dic->language()))->render(
             $this->dic->ctrl()->getFormAction($this, 'resetNow'),
             'resetNow',
             'documents',
             $this->dic->language()->txt('tos_sure_reset_tos')
         ));
     }

Here is the caller graph for this function:

◆ createSettings()

ilObjTermsOfServiceGUI::createSettings ( )

private

Definition at line 236 of file class.ilObjTermsOfServiceGUI.php.

References $dic.

Referenced by __construct().

                                      : Settings
     {
         $blocks = new Blocks($this->config->legalDocuments()->id(), $this->dic, $this->config->legalDocuments());
         return new Settings($blocks->selectSettingsFrom($blocks->globalStore()));
     }

Here is the caller graph for this function:

◆ documents()

ilObjTermsOfServiceGUI::documents ( )

private

Definition at line 203 of file class.ilObjTermsOfServiceGUI.php.

Referenced by executeCommand().

                                 : void
     {
         $buttons = $this->config->editable() ?
                  [$this->legal_documents->admin()->resetButton($this->dic->ctrl()->getLinkTarget($this, 'confirmReset'))] :
                  [];
 
         $reset_date = new DateTimeImmutable('@' . $this->dic->settings()->get('tos_last_reset', '0'));
 
         $this->tpl->setCurrentBlock('mess');
         $this->legal_documents->admin()->setVariable('MESSAGE', $this->legal_documents->admin()->resetBox($reset_date, $buttons));
         $this->tpl->parseCurrentBlock('mess');
     }

Here is the caller graph for this function:

◆ executeCommand()

ilObjTermsOfServiceGUI::executeCommand ( )

Definition at line 74 of file class.ilObjTermsOfServiceGUI.php.

References confirmReset(), ILIAS\Repository\ctrl(), documents(), ILIAS\Repository\lng(), ilObject2GUI\prepareOutput(), resetNow(), and settings().

                                     : void
     {
         if (!$this->rbac_system->checkAccess('read', $this->object->getRefId())) {
             $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
         }
         $this->prepareOutput();
         $next_class = $this->ctrl->getNextClass($this) ?? '';
         $cmd = $this->ctrl->getCmd() ?? '';
 
         switch (strtolower($next_class)) {
             case strtolower(ilLegalDocumentsAdministrationGUI::class):
                 switch ($cmd) {
                     case 'documents': $this->documents();
                         // no break.
                     default: $this->ctrl->forwardCommand($this->legal_documents);
                 }
                 return;
             case strtolower(ilPermissionGUI::class):
                 $this->tabs_gui->activateTab('permissions');
                 $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                 return;
             default:
                 switch ($cmd) {
                     case 'documents':
                         $this->ctrl->redirectByClass([self::class, ilLegalDocumentsAdministrationGUI::class], 'documents');
                         return;
                     case 'confirmReset': $this->confirmReset();
                         return;
                     case 'resetNow': $this->resetNow();
                         return;
                     default: $this->settings();
                         return;
                 }
         }
     }

Here is the call graph for this function:

◆ form()

ilObjTermsOfServiceGUI::form ( )

Definition at line 128 of file class.ilObjTermsOfServiceGUI.php.

References ilObjectGUI\$data, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), null, ILIAS\Repository\object(), and ILIAS\Repository\ui().

Referenced by settings().

                           : Form
     {
         $read_only = !$this->rbac_system->checkAccess('write', $this->object->getRefId());
 
         $no_documents = $this->config->legalDocuments()->document()->repository()->countAll() === 0;
         if ($no_documents) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('tos_no_documents_exist'));
         }
 
         $enabled = $this->dic->ui()->factory()->input()->field()->optionalGroup(
             [
                 'reeval_on_login' => $this->dic->ui()->factory()->input()->field()->checkbox(
                     $this->ui->txt('reevaluate_on_login'),
                     $this->ui->txt('reevaluate_on_login_desc')
                 )
             ],
             $this->lng->txt('tos_status_enable'),
             $this->lng->txt('tos_status_desc')
         );
         $enabled = $enabled->withValue($this->tos_settings->enabled()->value() ? ['reeval_on_login' => $this->tos_settings->validateOnLogin()->value()] : null);
         $enabled = $enabled->withDisabled($read_only);
 
         $form = $this->dic->ui()->factory()->input()->container()->form()->standard(
             $this->ctrl->getFormAction($this, 'saveSettings'),
             ['enabled' => $enabled]
         );
 
         if ($read_only) {
             $form = $form->withSubmitLabel($this->lng->txt('refresh'));
             return $this->legal_documents->admin()->withFormData($form, function () {
                 $this->ctrl->redirect($this, 'settings');
             });
         }
 
         return $this->legal_documents->admin()->withFormData($form, function (array $data) use ($no_documents): void {
             if ($no_documents && $data['enabled']) {
                 $this->tpl->setOnScreenMessage('failure', $this->lng->txt('tos_no_documents_exist_cant_save'), true);
                 $this->ctrl->redirect($this, 'settings');
             }
             $this->tos_settings->enabled()->update(isset($data['enabled']));
             $this->tos_settings->validateOnLogin()->update($data['enabled']['reeval_on_login'] ?? false);
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
             $this->ctrl->redirect($this, 'settings');
         });
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdminTabs()

ilObjTermsOfServiceGUI::getAdminTabs ( )

Definition at line 110 of file class.ilObjTermsOfServiceGUI.php.

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

                                   : void
     {
         $can_edit_permissions = $this->rbac_system->checkAccess('edit_permission', $this->object->getRefId());
 
         // Read right is already required by self::executeCommand.
         $this->legal_documents->tabs([
             'documents' => fn() => $this->tabs_gui->addTab('settings', $this->lng->txt('settings'), $this->ctrl->getLinkTarget($this, 'settings')),
         ]);
 
         if ($can_edit_permissions) {
             $this->tabs_gui->addTab(
                 'permissions',
                 $this->lng->txt('perm_settings'),
                 $this->ctrl->getLinkTargetByClass([self::class, ilPermissionGUI::class], 'perm')
             );
         }
     }

Here is the call graph for this function:

◆ getType()

ilObjTermsOfServiceGUI::getType ( )

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

                              : string
     {
         return 'tos';
     }

◆ resetNow()

ilObjTermsOfServiceGUI::resetNow ( )

private

Definition at line 227 of file class.ilObjTermsOfServiceGUI.php.

References ANONYMOUS_USER_ID, and SYSTEM_USER_ID.

Referenced by executeCommand().

                                : void
     {
         $this->legal_documents->admin()->requireEditable();
         $in = $this->dic->database()->in('usr_id', [ANONYMOUS_USER_ID, SYSTEM_USER_ID], true, 'integer');
         $this->dic->database()->manipulate("UPDATE usr_data SET agree_date = NULL WHERE $in");
         $this->tos_settings->lastResetDate()->update((new DataFactory())->clock()->system()->now());
         $this->dic->ctrl()->redirectByClass([self::class, $this->legal_documents::class], 'documents');
     }

Here is the caller graph for this function:

◆ settings()

ilObjTermsOfServiceGUI::settings ( )

protected

Definition at line 181 of file class.ilObjTermsOfServiceGUI.php.

References $components, form(), ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by executeCommand().

                                  : void
     {
         if (!$this->rbac_system->checkAccess('read', $this->object->getRefId())) {
             $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
         }
 
         $this->tabs_gui->activateTab('settings');
 
         $components = [];
 
         if ($this->tos_settings->enabled()->value() && $this->config->legalDocuments()->document()->repository()->countAll() === 0) {
             $components[] = $this->ui->create()->messageBox()->info(
                 $this->ui->txt('no_documents_exist')
             );
         }
 
         $components[] = $this->legal_documents->admin()->externalSettingsMessage($this->tos_settings->deleteUserOnWithdrawal()->value());
 
         $components[] = $this->form();
         $this->tpl->setContent($this->dic->ui()->renderer()->render($components));
     }