Class ilTermsOfServiceDocumentGUI. More...

Inheritance diagram for ilTermsOfServiceDocumentGUI:

Collaboration diagram for ilTermsOfServiceDocumentGUI:

Public Member Functions
	__construct (\ilObjTermsOfService $tos, \ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory, \ilTemplate $tpl, \ilObjUser $user, \ilCtrl $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)
	ilTermsOfServiceDocumentGUI constructor. More...

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

	detachCriterionAssignment ()

	executeCommand ()
	The implemented class should be \ilCtrl 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 ()

Protected Attributes
	$tableDataProviderFactory

	$tos

	$tpl

	$ctrl

	$lng

	$rbacsystem

	$error

	$user

	$log

	$uiFactory

	$uiRenderer

	$httpState

	$toolbar

	$fileUpload

	$fileSystems

	$criterionTypeFactory

	$documentPurifier

Detailed Description

Class ilTermsOfServiceDocumentGUI.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilTermsOfServiceDocumentGUI::__construct	(	\ilObjTermsOfService	$tos,
		\ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory,
		\ilTemplate	$tpl,
		\ilObjUser	$user,
		\ilCtrl	$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
	)

ilTermsOfServiceDocumentGUI constructor.

Parameters

\ilObjTermsOfService	$tos
ilTermsOfServiceCriterionTypeFactoryInterface	$criterionTypeFactory
\ilTemplate	$tpl
\ilObjUser	$user
\ilCtrl	$ctrl
\ilLanguage	$lng
\ilRbacSystem	$rbacsystem
\ilErrorHandling	$error
\ilLogger	$log
\ilToolbarGUI	$toolbar
GlobalHttpState	$httpState
Factory	$uiFactory
Renderer	$uiRenderer
Filesystems	$fileSystems

param FileUpload $fileUpload

Parameters

\ilTermsOfServiceTableDataProviderFactory	$tableDataProviderFactory
\ilHtmlPurifierInterface	$documentPurifier

Definition at line 87 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;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ confirmReset()

ilTermsOfServiceDocumentGUI::confirmReset ( )

protected

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

    {
        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 error().

Here is the call graph for this function:

◆ deleteDocument()

ilTermsOfServiceDocumentGUI::deleteDocument ( )

protected

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

    {
        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 error(), getDocumentsByServerRequest(), and getFirstDocumentFromList().

Here is the call graph for this function:

◆ detachCriterionAssignment()

ilTermsOfServiceDocumentGUI::detachCriterionAssignment ( )

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

    {
        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(),
            function (\ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment) use ($criterionId) {
                return $criterionAssignment->getId() == $criterionId;
            }
        ))[0];
 
        $document->detachCriterion($criterionAssignment);
        $document->update();
 
        \ilUtil::sendSuccess($this->lng->txt('tos_doc_crit_detached'), true);
        $this->ctrl->redirect($this, 'showDocuments');
    }

References ilTermsOfServiceDocument\criteria(), ilTermsOfServiceDocument\detachCriterion(), error(), and ActiveRecord\update().

Here is the call graph for this function:

◆ executeCommand()

ilTermsOfServiceDocumentGUI::executeCommand ( )

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

Implements ilTermsOfServiceControllerEnabled.

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

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

References error().

Here is the call graph for this function:

◆ getCriterionForm()

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

protected

Parameters

\ilTermsOfServiceDocument	$document
\ilTermsOfServiceDocumentCriterionAssignment	$criterionAssignment

Returns: \ilTermsOfServiceCriterionFormGUI

Definition at line 523 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;
    }

◆ getDocumentForm()

ilTermsOfServiceDocumentGUI::getDocumentForm ( ilTermsOfServiceDocument $document )

protected

Parameters

\ilTermsOfServiceDocument $document

Returns: \ilTermsOfServiceDocumentFormGUI

Definition at line 249 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 $form, ilFormGUI\getFormAction(), and 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: array

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

                                                     : array
    {
        $documents = [];
 
        $documentIds = $this->httpState->request()->getParsedBody()['tos_id'] ?? [];
        if (!is_array($documentIds) || 0 === count($documentIds)) {
            $documentIds = $this->httpState->request()->getQueryParams()['tos_id'] ? [$this->httpState->request()->getQueryParams()['tos_id']] : [];
        }
 
        if (0 === count($documentIds)) {
            return $documents;
        }
 
        $documents = \ilTermsOfServiceDocument::where(
            ['id' => array_filter(array_map('intval', $documentIds))],
            ['id' => 'IN']
        )->getArray();
 
        return $documents;
    }

References 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

Parameters

array $documents

Returns: \ilTermsOfServiceDocument

Exceptions

UnexpectedValueException

Definition at line 383 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

Returns: string

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

                                                : string
    {
        if ($this->tos->getLastResetDate() && $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, 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 168 of file class.ilTermsOfServiceDocumentGUI.php.

    {
        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() . ']');
        \ilUtil::sendSuccess($this->lng->txt('tos_reset_successful'));
 
        $this->showDocuments();
    }

References error(), showDocuments(), and user().

Here is the call graph for this function:

◆ saveAddDocumentForm()

ilTermsOfServiceDocumentGUI::saveAddDocumentForm ( )

protected

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

    {
        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()) {
            \ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                \ilUtil::sendInfo($form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            \ilUtil::sendFailure($form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References $form, error(), getDocumentForm(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ saveAttachCriterionForm()

ilTermsOfServiceDocumentGUI::saveAttachCriterionForm ( )

protected

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

    {
        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()) {
            \ilUtil::sendSuccess($this->lng->txt('tos_doc_crit_attached'), true);
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            \ilUtil::sendFailure($form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References $form, error(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ saveChangeCriterionForm()

ilTermsOfServiceDocumentGUI::saveChangeCriterionForm ( )

protected

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

    {
        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(),
            function (\ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment) use ($criterionId) {
                return $criterionAssignment->getId() == $criterionId;
            }
        ))[0];
 
        $form = $this->getCriterionForm($document, $criterionAssignment);
        if ($form->saveObject()) {
            \ilUtil::sendSuccess($this->lng->txt('tos_doc_crit_changed'), true);
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            \ilUtil::sendFailure($form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References $form, ilTermsOfServiceDocument\criteria(), error(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ saveDocumentSorting()

ilTermsOfServiceDocumentGUI::saveDocumentSorting ( )

protected

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

    {
        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
            }
        }
 
        \ilUtil::sendSuccess($this->lng->txt('tos_saved_sorting'), true);
        $this->ctrl->redirect($this);
    }

References error(), and showDocuments().

Here is the call graph for this function:

◆ saveEditDocumentForm()

ilTermsOfServiceDocumentGUI::saveEditDocumentForm ( )

protected

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

    {
        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()) {
            \ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
            if ($form->hasTranslatedInfo()) {
                \ilUtil::sendInfo($form->getTranslatedInfo(), true);
            }
            $this->ctrl->redirect($this, 'showDocuments');
        } elseif ($form->hasTranslatedError()) {
            \ilUtil::sendFailure($form->getTranslatedError());
        }
 
        $this->tpl->setContent($form->getHTML());
    }

References $form, error(), getDocumentForm(), getDocumentsByServerRequest(), getFirstDocumentFromList(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ showAddDocumentForm()

ilTermsOfServiceDocumentGUI::showAddDocumentForm ( )

protected

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

    {
        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 $form, error(), and getDocumentForm().

Here is the call graph for this function:

◆ showAttachCriterionForm()

ilTermsOfServiceDocumentGUI::showAttachCriterionForm ( )

protected

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

    {
        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 $form, and error().

Here is the call graph for this function:

◆ showChangeCriterionForm()

ilTermsOfServiceDocumentGUI::showChangeCriterionForm ( )

protected

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

    {
        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(),
            function (\ilTermsOfServiceDocumentCriterionAssignment $criterionAssignment) use ($criterionId) {
                return $criterionAssignment->getId() == $criterionId;
            }
        ))[0];
 
        $form = $this->getCriterionForm($document, $criterionAssignment);
        $this->tpl->setContent($form->getHTML());
    }

References $form, ilTermsOfServiceDocument\criteria(), and error().

Here is the call graph for this function:

◆ showDocuments()

ilTermsOfServiceDocumentGUI::showDocuments ( )

protected

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

    {
        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, ilLinkButton\getInstance(), and getResetMessageBoxHtml().

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 317 of file class.ilTermsOfServiceDocumentGUI.php.

    {
        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 $form, error(), getDocumentForm(), getDocumentsByServerRequest(), and getFirstDocumentFromList().

Here is the call graph for this function:

Field Documentation

◆ $criterionTypeFactory

ilTermsOfServiceDocumentGUI::$criterionTypeFactory

protected

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

Referenced by __construct().

◆ $ctrl

ilTermsOfServiceDocumentGUI::$ctrl

protected

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

Referenced by __construct().

◆ $documentPurifier

ilTermsOfServiceDocumentGUI::$documentPurifier

protected

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

Referenced by __construct().

◆ $error

ilTermsOfServiceDocumentGUI::$error

protected

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

Referenced by __construct().

◆ $fileSystems

ilTermsOfServiceDocumentGUI::$fileSystems

protected

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

Referenced by __construct().

◆ $fileUpload

ilTermsOfServiceDocumentGUI::$fileUpload

protected

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

Referenced by __construct().

◆ $httpState

ilTermsOfServiceDocumentGUI::$httpState

protected

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

Referenced by __construct().

◆ $lng

ilTermsOfServiceDocumentGUI::$lng

protected

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

Referenced by __construct().

◆ $log

ilTermsOfServiceDocumentGUI::$log

protected

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

Referenced by __construct().

◆ $rbacsystem

ilTermsOfServiceDocumentGUI::$rbacsystem

protected

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

Referenced by __construct().

◆ $tableDataProviderFactory

ilTermsOfServiceDocumentGUI::$tableDataProviderFactory

protected

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

Referenced by __construct().

◆ $toolbar

ilTermsOfServiceDocumentGUI::$toolbar

protected

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

Referenced by __construct().

◆ $tos

ilTermsOfServiceDocumentGUI::$tos

protected

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

Referenced by __construct().

◆ $tpl

ilTermsOfServiceDocumentGUI::$tpl

protected

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

Referenced by __construct().

◆ $uiFactory

ilTermsOfServiceDocumentGUI::$uiFactory

protected

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

Referenced by __construct().

◆ $uiRenderer

ilTermsOfServiceDocumentGUI::$uiRenderer

protected

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

Referenced by __construct().

◆ $user

ilTermsOfServiceDocumentGUI::$user

protected

Definition at line 38 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

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

◆ $tableDataProviderFactory

◆ $toolbar

◆ $tos

◆ $tpl

◆ $uiFactory

◆ $uiRenderer

◆ $user