Class ilTermsOfServiceDocumentGUI. More...

Inheritance diagram for ilTermsOfServiceDocumentGUI:

Collaboration diagram for ilTermsOfServiceDocumentGUI:

Public Member Functions
	__construct (ilObjTermsOfService $tos, ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory, ilGlobalTemplateInterface $tpl, ilObjUser $user, ilCtrlInterface $ctrl, ilLanguage $lng, ilRbacSystem $rbacsystem, ilErrorHandling $error, ilLogger $log, ilToolbarGUI $toolbar, GlobalHttpState $httpState, Factory $uiFactory, Renderer $uiRenderer, Filesystems $fileSystems, FileUpload $fileUpload, ilTermsOfServiceTableDataProviderFactory $tableDataProviderFactory, ilHtmlPurifierInterface $documentPurifier, Refinery $refinery)

	executeCommand ()
	The implemented class should be ilCtrlInterface enabled and execute or forward the given command. More...

	detachCriterionAssignment ()

	executeCommand ()
	The implemented class should be ilCtrlInterface enabled and execute or forward the given command. More...

Protected Member Functions
	confirmReset ()

	reset ()

	showDocuments ()

	getResetMessageBoxHtml ()

	getDocumentForm (ilTermsOfServiceDocument $document)

	saveAddDocumentForm ()

	showAddDocumentForm ()

	showEditDocumentForm ()

	saveEditDocumentForm ()

	getDocumentsByServerRequest ()

	getFirstDocumentFromList (array $documents)

	deleteDocument ()

	saveDocumentSorting ()

	getCriterionForm (ilTermsOfServiceDocument $document, ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment)

	saveAttachCriterionForm ()

	showAttachCriterionForm ()

	showChangeCriterionForm ()

	saveChangeCriterionForm ()

Detailed Description

Class ilTermsOfServiceDocumentGUI.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 32 of file class.ilTermsOfServiceDocumentGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceDocumentGUI::__construct	(	ilObjTermsOfService	$tos,
		ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory,
		ilGlobalTemplateInterface	$tpl,
		ilObjUser	$user,
		ilCtrlInterface	$ctrl,
		ilLanguage	$lng,
		ilRbacSystem	$rbacsystem,
		ilErrorHandling	$error,
		ilLogger	$log,
		ilToolbarGUI	$toolbar,
		GlobalHttpState	$httpState,
		Factory	$uiFactory,
		Renderer	$uiRenderer,
		Filesystems	$fileSystems,
		FileUpload	$fileUpload,
		ilTermsOfServiceTableDataProviderFactory	$tableDataProviderFactory,
		ilHtmlPurifierInterface	$documentPurifier,
		Refinery	$refinery
	)

Definition at line 53 of file class.ilTermsOfServiceDocumentGUI.php.

      {
        $this->tos = $tos;
        $this->criterionTypeFactory = $criterionTypeFactory;
        $this->tpl = $tpl;
        $this->ctrl = $ctrl;
        $this->lng = $lng;
        $this->rbacsystem = $rbacsystem;
        $this->error = $error;
        $this->user = $user;
        $this->log = $log;
        $this->toolbar = $toolbar;
        $this->httpState = $httpState;
        $this->uiFactory = $uiFactory;
        $this->uiRenderer = $uiRenderer;
        $this->fileSystems = $fileSystems;
        $this->fileUpload = $fileUpload;
        $this->tableDataProviderFactory = $tableDataProviderFactory;
        $this->documentPurifier = $documentPurifier;
        $this->refinery = $refinery;
    }

References $criterionTypeFactory, $ctrl, $documentPurifier, $error, $fileSystems, $fileUpload, $httpState, $lng, $log, $rbacsystem, $refinery, $tableDataProviderFactory, $toolbar, $tos, $tpl, $uiFactory, $uiRenderer, $user, ILIAS\Repository\ctrl(), error(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ confirmReset()

ilTermsOfServiceDocumentGUI::confirmReset ( )

protected

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

                                     : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this, 'confirmReset'));
        $confirmation->setConfirm($this->lng->txt('confirm'), 'reset');
        $confirmation->setCancel($this->lng->txt('cancel'), 'showDocuments');
        $confirmation->setHeaderText($this->lng->txt('tos_sure_reset_tos'));
 
        $this->tpl->setContent($confirmation->getHTML());
    }

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

Here is the call graph for this function:

◆ deleteDocument()

ilTermsOfServiceDocumentGUI::deleteDocument ( )

protected

Definition at line 402 of file class.ilTermsOfServiceDocumentGUI.php.

                                       : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $this->processDocumentDeletion([$document]);
 
        $this->ctrl->redirect($this);
    }

References ILIAS\Repository\ctrl(), error(), getDocumentsByServerRequest(), getFirstDocumentFromList(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ detachCriterionAssignment()

ilTermsOfServiceDocumentGUI::detachCriterionAssignment ( )

Definition at line 571 of file class.ilTermsOfServiceDocumentGUI.php.

                                               : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $criterionId = $this->httpState->request()->getQueryParams()['crit_id'] ?? 0;
        if (!is_numeric($criterionId) || $criterionId < 1) {
            $this->showDocuments();
            return;
        }
 
        $criterionAssignment = array_values(array_filter(
            $document->criteria(),
            static function (ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment) use (
                $criterionId
            ): bool {
                return $criterionAssignment->getId() == $criterionId;
            }
        ))[0];
 
        $document->detachCriterion($criterionAssignment);
        $document->update();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('tos_doc_crit_detached'), true);
        $this->ctrl->redirect($this, 'showDocuments');
    }

References ilTermsOfServiceDocument\criteria(), ILIAS\Repository\ctrl(), ilTermsOfServiceDocument\detachCriterion(), error(), function, ILIAS\Repository\lng(), and ilTermsOfServiceDocument\update().

Here is the call graph for this function:

◆ executeCommand()

ilTermsOfServiceDocumentGUI::executeCommand ( )

The implemented class should be ilCtrlInterface enabled and execute or forward the given command.

Implements ilTermsOfServiceControllerEnabled.

Definition at line 93 of file class.ilTermsOfServiceDocumentGUI.php.

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
 
        if (!$this->rbacsystem->checkAccess('read', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        if ($cmd === null || $cmd === '' || !method_exists($this, $cmd)) {
            $cmd = 'showDocuments';
        }
        $this->$cmd();
    }

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

Here is the call graph for this function:

◆ getCriterionForm()

ilTermsOfServiceDocumentGUI::getCriterionForm	(	ilTermsOfServiceDocument	$document,
		ilTermsOfServiceDocumentCriterionAssignment	$criterionAssignment
	)

protected

Definition at line 448 of file class.ilTermsOfServiceDocumentGUI.php.

     : ilTermsOfServiceCriterionFormGUI {
        $this->ctrl->setParameter($this, 'tos_id', $document->getId());
 
        if ($criterionAssignment->getId() > 0) {
            $this->ctrl->setParameter($this, 'crit_id', $criterionAssignment->getId());
        }
 
        $formAction = $this->ctrl->getFormAction($this, 'saveAttachCriterionForm');
        $saveCommand = 'saveAttachCriterionForm';
 
        if ($criterionAssignment->getId() > 0) {
            $formAction = $this->ctrl->getFormAction($this, 'saveChangeCriterionForm');
            $saveCommand = 'saveChangeCriterionForm';
        }
 
        $form = new ilTermsOfServiceCriterionFormGUI(
            $document,
            $criterionAssignment,
            $this->criterionTypeFactory,
            $this->user,
            $formAction,
            $saveCommand,
            'showDocuments'
        );
 
        return $form;
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getDocumentForm()

ilTermsOfServiceDocumentGUI::getDocumentForm ( ilTermsOfServiceDocument $document )

protected

Definition at line 196 of file class.ilTermsOfServiceDocumentGUI.php.

                                                                          : ilTermsOfServiceDocumentFormGUI
    {
        if ($document->getId() > 0) {
            $this->ctrl->setParameter($this, 'tos_id', $document->getId());
        }
 
        $formAction = $this->ctrl->getFormAction($this, 'saveAddDocumentForm');
        $saveCommand = 'saveAddDocumentForm';
 
        if ($document->getId() > 0) {
            $formAction = $this->ctrl->getFormAction($this, 'saveEditDocumentForm');
            $saveCommand = 'saveEditDocumentForm';
        }
 
        $form = new ilTermsOfServiceDocumentFormGUI(
            $document,
            $this->documentPurifier,
            $this->user,
            $this->fileSystems->temp(),
            $this->fileUpload,
            $formAction,
            $saveCommand,
            'showDocuments',
            $this->rbacsystem->checkAccess('write', $this->tos->getRefId())
        );
 
        return $form;
    }

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

Referenced by saveAddDocumentForm(), saveEditDocumentForm(), showAddDocumentForm(), and showEditDocumentForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDocumentsByServerRequest()

ilTermsOfServiceDocumentGUI::getDocumentsByServerRequest ( )

protected

Returns: ilTermsOfServiceDocument[]

Definition at line 292 of file class.ilTermsOfServiceDocumentGUI.php.

                                                    : array
    {
        $documentIds = [];
 
        if ($this->httpState->wrapper()->post()->has('tos_id')) {
            $documentIds = $this->httpState->wrapper()->post()->retrieve(
                'tos_id',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            );
        }
 
        if ($documentIds === [] && $this->httpState->wrapper()->query()->has('tos_id')) {
            $documentIds = [$this->httpState->wrapper()->query()->retrieve(
                'tos_id',
                $this->refinery->kindlyTo()->int()
            )];
        }
 
        if ($documentIds === []) {
            return $documentIds;
        }
 
        $documents = ilTermsOfServiceDocument::where(
            ['id' => array_filter(array_map('intval', $documentIds))],
            ['id' => 'IN']
        )->getArray();
 
        return $documents;
    }

References ILIAS\Repository\refinery(), and ActiveRecord\where().

Referenced by deleteDocument(), saveEditDocumentForm(), and showEditDocumentForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFirstDocumentFromList()

ilTermsOfServiceDocumentGUI::getFirstDocumentFromList ( array $documents )

protected

Definition at line 322 of file class.ilTermsOfServiceDocumentGUI.php.

                                                                 : ilTermsOfServiceDocument
    {
        if (1 !== count($documents)) {
            throw new UnexpectedValueException('Expected exactly one document in list');
        }
 
        $document = new ilTermsOfServiceDocument(0);
        $document = $document->buildFromArray(current($documents));
 
        return $document;
    }

Referenced by deleteDocument(), saveEditDocumentForm(), and showEditDocumentForm().

Here is the caller graph for this function:

◆ getResetMessageBoxHtml()

ilTermsOfServiceDocumentGUI::getResetMessageBoxHtml ( )

protected

Definition at line 163 of file class.ilTermsOfServiceDocumentGUI.php.

                                               : string
    {
        if (((int) $this->tos->getLastResetDate()->get(IL_CAL_UNIX)) !== 0) {
            $status = ilDatePresentation::useRelativeDates();
            ilDatePresentation::setUseRelativeDates(false);
            $resetText = sprintf(
                $this->lng->txt('tos_last_reset_date'),
                ilDatePresentation::formatDate($this->tos->getLastResetDate())
            );
            ilDatePresentation::setUseRelativeDates($status);
        } else {
            $resetText = $this->lng->txt('tos_never_reset');
        }
 
        $buttons = [];
        if ($this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $buttons = [
                $this->uiFactory
                    ->button()
                    ->standard(
                        $this->lng->txt('tos_reset_tos_for_all_users'),
                        $this->ctrl->getLinkTarget($this, 'confirmReset')
                    )
            ];
        }
 
        return $this->uiRenderer->render(
            $this->uiFactory->messageBox()
                            ->info($resetText)
                            ->withButtons($buttons)
        );
    }

References ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Repository\lng(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by showDocuments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

ilTermsOfServiceDocumentGUI::reset ( )

protected

Definition at line 122 of file class.ilTermsOfServiceDocumentGUI.php.

                              : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $this->tos->resetAll();
 
        $this->log->info('Terms of service reset by ' . $this->user->getId() . ' [' . $this->user->getLogin() . ']');
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('tos_reset_successful'));
 
        $this->showDocuments();
    }

References error(), ILIAS\Repository\lng(), showDocuments(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ saveAddDocumentForm()

ilTermsOfServiceDocumentGUI::saveAddDocumentForm ( )

protected

Definition at line 225 of file class.ilTermsOfServiceDocumentGUI.php.

                                            : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $form = $this->getDocumentForm(new ilTermsOfServiceDocument());
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                $this->tpl->setOnScreenMessage('info', $form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            $this->tpl->setOnScreenMessage('failure', $form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References ILIAS\Repository\ctrl(), error(), getDocumentForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ saveAttachCriterionForm()

ilTermsOfServiceDocumentGUI::saveAttachCriterionForm ( )

protected

Definition at line 479 of file class.ilTermsOfServiceDocumentGUI.php.

                                                : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $form = $this->getCriterionForm($document, new ilTermsOfServiceDocumentCriterionAssignment());
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('tos_doc_crit_attached'), true);
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            $this->tpl->setOnScreenMessage('failure', $form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

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

Here is the call graph for this function:

◆ saveChangeCriterionForm()

ilTermsOfServiceDocumentGUI::saveChangeCriterionForm ( )

protected

Definition at line 537 of file class.ilTermsOfServiceDocumentGUI.php.

                                                : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $criterionId = $this->httpState->request()->getQueryParams()['crit_id'] ?? 0;
        if (!is_numeric($criterionId) || $criterionId < 1) {
            $this->showDocuments();
            return;
        }
 
        $criterionAssignment = array_values(array_filter(
            $document->criteria(),
            static function (ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment) use (
                $criterionId
            ): bool {
                return $criterionAssignment->getId() == $criterionId;
            }
        ))[0];
 
        $form = $this->getCriterionForm($document, $criterionAssignment);
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('tos_doc_crit_changed'), true);
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            $this->tpl->setOnScreenMessage('failure', $form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References ilTermsOfServiceDocument\criteria(), ILIAS\Repository\ctrl(), error(), function, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ saveDocumentSorting()

ilTermsOfServiceDocumentGUI::saveDocumentSorting ( )

protected

Definition at line 415 of file class.ilTermsOfServiceDocumentGUI.php.

                                            : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $sorting = $this->httpState->request()->getParsedBody()['sorting'] ?? [];
        if (!is_array($sorting) || 0 === count($sorting)) {
            $this->showDocuments();
            return;
        }
 
        asort($sorting, SORT_NUMERIC);
 
        $position = 0;
        foreach ($sorting as $documentId => $ignoredSortValue) {
            if (!is_numeric($documentId)) {
                continue;
            }
 
            try {
                $document = new ilTermsOfServiceDocument((int) $documentId);
                $document->setSorting(++$position);
                $document->store();
            } catch (ilException $e) {
                // Empty catch block
            }
        }
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('tos_saved_sorting'), true);
        $this->ctrl->redirect($this);
    }

References Vendor\Package\$e, ILIAS\Repository\ctrl(), error(), ILIAS\Repository\lng(), and showDocuments().

Here is the call graph for this function:

◆ saveEditDocumentForm()

ilTermsOfServiceDocumentGUI::saveEditDocumentForm ( )

protected

Definition at line 267 of file class.ilTermsOfServiceDocumentGUI.php.

                                             : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $form = $this->getDocumentForm($document);
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                $this->tpl->setOnScreenMessage('info', $form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            $this->tpl->setOnScreenMessage('failure', $form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References ILIAS\Repository\ctrl(), error(), getDocumentForm(), getDocumentsByServerRequest(), getFirstDocumentFromList(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ showAddDocumentForm()

ilTermsOfServiceDocumentGUI::showAddDocumentForm ( )

protected

Definition at line 245 of file class.ilTermsOfServiceDocumentGUI.php.

                                            : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $form = $this->getDocumentForm(new ilTermsOfServiceDocument());
        $this->tpl->setContent($form->getHTML());
    }

References error(), getDocumentForm(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ showAttachCriterionForm()

ilTermsOfServiceDocumentGUI::showAttachCriterionForm ( )

protected

Definition at line 498 of file class.ilTermsOfServiceDocumentGUI.php.

                                                : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $form = $this->getCriterionForm($document, new ilTermsOfServiceDocumentCriterionAssignment());
        $this->tpl->setContent($form->getHTML());
    }

References error(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ showChangeCriterionForm()

ilTermsOfServiceDocumentGUI::showChangeCriterionForm ( )

protected

Definition at line 510 of file class.ilTermsOfServiceDocumentGUI.php.

                                                : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $criterionId = $this->httpState->request()->getQueryParams()['crit_id'] ?? 0;
        if (!is_numeric($criterionId) || $criterionId < 1) {
            $this->showDocuments();
            return;
        }
 
        $criterionAssignment = array_values(array_filter(
            $document->criteria(),
            static function (ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment) use (
                $criterionId
            ): bool {
                return $criterionAssignment->getId() == $criterionId;
            }
        ))[0];
 
        $form = $this->getCriterionForm($document, $criterionAssignment);
        $this->tpl->setContent($form->getHTML());
    }

References ilTermsOfServiceDocument\criteria(), error(), function, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ showDocuments()

ilTermsOfServiceDocumentGUI::showDocuments ( )

protected

Definition at line 136 of file class.ilTermsOfServiceDocumentGUI.php.

                                      : void
    {
        if ($this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $addDocumentBtn = ilLinkButton::getInstance();
            $addDocumentBtn->setPrimary(true);
            $addDocumentBtn->setUrl($this->ctrl->getLinkTarget($this, 'showAddDocumentForm'));
            $addDocumentBtn->setCaption('tos_add_document_btn_label');
            $this->toolbar->addStickyItem($addDocumentBtn);
        }
 
        $documentTableGui = new ilTermsOfServiceDocumentTableGUI(
            $this,
            'showDocuments',
            $this->criterionTypeFactory,
            $this->uiFactory,
            $this->uiRenderer,
            $this->rbacsystem->checkAccess('write', $this->tos->getRefId())
        );
        $documentTableGui->setProvider($this->tableDataProviderFactory->getByContext(ilTermsOfServiceTableDataProviderFactory::CONTEXT_DOCUMENTS));
        $documentTableGui->populate();
 
        $this->tpl->setCurrentBlock('mess');
        $this->tpl->setVariable('MESSAGE', $this->getResetMessageBoxHtml());
        $this->tpl->parseCurrentBlock('mess');
        $this->tpl->setContent($documentTableGui->getHTML());
    }

References ilTermsOfServiceTableDataProviderFactory\CONTEXT_DOCUMENTS, ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), getResetMessageBoxHtml(), and ILIAS\Repository\toolbar().

Referenced by reset(), and saveDocumentSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showEditDocumentForm()

ilTermsOfServiceDocumentGUI::showEditDocumentForm ( )

protected

Definition at line 255 of file class.ilTermsOfServiceDocumentGUI.php.

                                             : void
    {
        if (!$this->rbacsystem->checkAccess('write', $this->tos->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
 
        $document = $this->getFirstDocumentFromList($this->getDocumentsByServerRequest());
 
        $form = $this->getDocumentForm($document);
        $this->tpl->setContent($form->getHTML());
    }

References error(), getDocumentForm(), getDocumentsByServerRequest(), getFirstDocumentFromList(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Field Documentation

◆ $criterionTypeFactory

ilTermsOfServiceCriterionTypeFactoryInterface ilTermsOfServiceDocumentGUI::$criterionTypeFactory

protected

Definition at line 49 of file class.ilTermsOfServiceDocumentGUI.php.

Referenced by __construct().

◆ $ctrl

ilCtrlInterface ilTermsOfServiceDocumentGUI::$ctrl

protected

Definition at line 37 of file class.ilTermsOfServiceDocumentGUI.php.

Referenced by __construct().

◆ $documentPurifier

ilHtmlPurifierInterface ilTermsOfServiceDocumentGUI::$documentPurifier

protected

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

Referenced by __construct().

◆ $error

ilErrorHandling ilTermsOfServiceDocumentGUI::$error

protected

Definition at line 40 of file class.ilTermsOfServiceDocumentGUI.php.

Referenced by __construct().

◆ $fileSystems

Filesystems ilTermsOfServiceDocumentGUI::$fileSystems

protected

Definition at line 48 of file class.ilTermsOfServiceDocumentGUI.php.

Referenced by __construct().

◆ $fileUpload

FileUpload ilTermsOfServiceDocumentGUI::$fileUpload

protected

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

Referenced by __construct().

◆ $httpState

ILIAS HTTP GlobalHttpState ilTermsOfServiceDocumentGUI::$httpState

protected

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

Referenced by __construct().

◆ $lng

ilLanguage ilTermsOfServiceDocumentGUI::$lng

protected

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

Referenced by __construct().

◆ $log

ilLogger ilTermsOfServiceDocumentGUI::$log

protected

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

Referenced by __construct().

◆ $rbacsystem

ilRbacSystem ilTermsOfServiceDocumentGUI::$rbacsystem

protected

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

Referenced by __construct().

◆ $refinery

Refinery ilTermsOfServiceDocumentGUI::$refinery

protected

Definition at line 51 of file class.ilTermsOfServiceDocumentGUI.php.

Referenced by __construct().

◆ $tableDataProviderFactory

ilTermsOfServiceTableDataProviderFactory ilTermsOfServiceDocumentGUI::$tableDataProviderFactory

protected

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

Referenced by __construct().

◆ $toolbar

ilToolbarGUI ilTermsOfServiceDocumentGUI::$toolbar

protected

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

Referenced by __construct().

◆ $tos

ilObjTermsOfService ilTermsOfServiceDocumentGUI::$tos

protected

Definition at line 35 of file class.ilTermsOfServiceDocumentGUI.php.

Referenced by __construct().

◆ $tpl

ilGlobalTemplateInterface ilTermsOfServiceDocumentGUI::$tpl

protected

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

Referenced by __construct().

◆ $uiFactory

Factory ilTermsOfServiceDocumentGUI::$uiFactory

protected

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

Referenced by __construct().

◆ $uiRenderer

Renderer ilTermsOfServiceDocumentGUI::$uiRenderer

protected

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

Referenced by __construct().

◆ $user

ilObjUser ilTermsOfServiceDocumentGUI::$user

protected

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

Referenced by __construct().

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

Services/TermsOfService/classes/Document/class.ilTermsOfServiceDocumentGUI.php

Protected Attributes
ilTermsOfServiceTableDataProviderFactory	$tableDataProviderFactory

ilObjTermsOfService	$tos

ilGlobalTemplateInterface	$tpl

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilRbacSystem	$rbacsystem

ilErrorHandling	$error

ilObjUser	$user

ilLogger	$log

Factory	$uiFactory

Renderer	$uiRenderer

ILIAS HTTP GlobalHttpState	$httpState

ilToolbarGUI	$toolbar

FileUpload	$fileUpload

Filesystems	$fileSystems

ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory

ilHtmlPurifierInterface	$documentPurifier

Refinery	$refinery

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ confirmReset()

◆ deleteDocument()

◆ detachCriterionAssignment()

◆ executeCommand()

◆ getCriterionForm()

◆ getDocumentForm()

◆ getDocumentsByServerRequest()

◆ getFirstDocumentFromList()

◆ getResetMessageBoxHtml()

◆ reset()

◆ saveAddDocumentForm()

◆ saveAttachCriterionForm()

◆ saveChangeCriterionForm()

◆ saveDocumentSorting()

◆ saveEditDocumentForm()

◆ showAddDocumentForm()

◆ showAttachCriterionForm()

◆ showChangeCriterionForm()

◆ showDocuments()

◆ showEditDocumentForm()

Field Documentation

◆ $criterionTypeFactory

◆ $ctrl

◆ $documentPurifier

◆ $error

◆ $fileSystems

◆ $fileUpload

◆ $httpState

◆ $lng

◆ $log

◆ $rbacsystem

◆ $refinery

◆ $tableDataProviderFactory

◆ $toolbar

◆ $tos

◆ $tpl

◆ $uiFactory

◆ $uiRenderer

◆ $user