Collaboration diagram for ilLegalDocumentsAdministrationGUI:

Public Member Functions
	__construct (private readonly string $parent_class, private readonly Config $config, private readonly Closure $after_document_deletion, ?Container $container=null)

	executeCommand ()

	history ()

	searchUser ()

	historyResetFilter ()

	addDocument ()

	addCriterion ()

	editCriterion ()

	deleteCriterion ()

	upload ()

	documents ()

	deleteDocuments ()

	deleteDocument ()

	deleteConfirmed ()

	editDocument ()

	saveOrder ()

	tabs (array $run_after=[])

	admin ()

Private Member Functions
	tab (string $cmd, string $label, bool $can_access=true)

	ctrlTo (string $method,... $args)

	isCommand (string $cmd)

	deleteDocumentsConfirmation (array $documents)

	criterionErrorMessage ($error)

	returnWithMessage (string $message, string $command)

	returnWithResult (Result $result, string $success_message, string $target)

Private Attributes
readonly Container	$container

readonly UI	$ui

readonly Administration	$admin

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLegalDocumentsAdministrationGUI::__construct	(	private readonly string	$parent_class,
		private readonly Config	$config,
		private readonly Closure	$after_document_deletion,
		?Container	$container = `null`
	)

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

References $GLOBALS, admin(), and ILIAS\Repository\ui().

       {
         $this->container = $container ?? $GLOBALS['DIC'];
         $this->container->language()->loadLanguageModule('ldoc');
         $this->ui = new UI(
             $this->config->legalDocuments()->id(),
             $this->container->ui(),
             $this->container->language()
         );
         $this->admin = new Administration($this->config, $this->container, $this->ui);
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCriterion()

ilLegalDocumentsAdministrationGUI::addCriterion ( )

Definition at line 123 of file class.ilLegalDocumentsAdministrationGUI.php.

References $url, admin(), ctrlTo(), and returnWithResult().

                                   : void
     {
         $this->admin->requireEditable();
         $this->container->tabs()->clearTargets();
         $this->container->tabs()->setBackTarget($this->container->language()->txt('back'), $this->ctrlTo('getLinkTargetByClass', 'documents'));
 
         $document = $this->admin->currentDocument()->value();
 
         $this->container->language()->loadLanguageModule('meta');
 
         $url = $this->admin->targetWithDoc($this, $document, 'addCriterion', 'getFormAction');
         $form = $this->admin->criterionForm($url, $document);
 
         $form = $this->admin->withFormData($form, function (array $x) use ($document) {
             $content = new CriterionContent(...$x[0]['content']);
             $this->returnWithResult($this->config->legalDocuments()->document()->validateCriteriaContent($document->criteria(), $content)->map(
                 fn() => $this->config->legalDocuments()->document()->repository()->createCriterion($document, $content)
             ), 'doc_crit_attached', 'documents');
         });
 
         $this->admin->setContent($form);
     }

Here is the call graph for this function:

◆ addDocument()

ilLegalDocumentsAdministrationGUI::addDocument ( )

Definition at line 116 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin(), and ctrlTo().

                                  : void
     {
         $this->admin->requireEditable();
         $this->ctrlTo('setParameterByClass', 'hash', $this->config->legalDocuments()->document()->hash());
         $this->ctrlTo('redirectByClass', 'editDocument');
     }

Here is the call graph for this function:

◆ admin()

ilLegalDocumentsAdministrationGUI::admin ( )

Definition at line 280 of file class.ilLegalDocumentsAdministrationGUI.php.

References $admin.

Referenced by __construct(), addCriterion(), addDocument(), deleteConfirmed(), deleteCriterion(), deleteDocument(), deleteDocuments(), deleteDocumentsConfirmation(), documents(), editCriterion(), editDocument(), history(), saveOrder(), tabs(), and upload().

                            : Administration
     {
         return $this->admin;
     }

Here is the caller graph for this function:

◆ criterionErrorMessage()

ilLegalDocumentsAdministrationGUI::criterionErrorMessage ( $error )

private

Parameters

string | Exception $error

Definition at line 321 of file class.ilLegalDocumentsAdministrationGUI.php.

References ILIAS\Repository\ui().

Referenced by returnWithResult().

                                                   : string
     {
         if (!is_string($error)) {
             throw $error;
         }
 
         return match ($error) {
             ProvideDocument::CRITERION_ALREADY_EXISTS => $this->ui->txt('criterion_assignment_must_be_unique'),
             ProvideDocument::CRITERION_WOULD_NEVER_MATCH => $this->ui->txt('criterion_assignment_cannot_match'),
             default => $error,
         };
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ctrlTo()

ilLegalDocumentsAdministrationGUI::ctrlTo	(	string	$method,
			$args
	)

private

Definition at line 285 of file class.ilLegalDocumentsAdministrationGUI.php.

References $path.

Referenced by addCriterion(), addDocument(), deleteDocuments(), editCriterion(), editDocument(), returnWithMessage(), returnWithResult(), saveOrder(), and tab().

     {
         $path = [$this->parent_class, self::class];
         if ($method === 'setParameterByClass') {
             $path = self::class;
         }
         return $this->container->ctrl()->$method($path, ...$args);
     }

Here is the caller graph for this function:

◆ deleteConfirmed()

ilLegalDocumentsAdministrationGUI::deleteConfirmed ( )

Definition at line 221 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin(), and returnWithMessage().

                                      : void
     {
         $this->admin->requireEditable();
         $docs = $this->admin->retrieveDocuments();
         $this->admin->deleteDocuments($docs);
         ($this->after_document_deletion)();
         $this->returnWithMessage(count($docs) === 1 ? 'deleted_documents_s' : 'deleted_documents_p', 'documents');
     }

Here is the call graph for this function:

◆ deleteCriterion()

ilLegalDocumentsAdministrationGUI::deleteCriterion ( )

Definition at line 169 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin(), ILIAS\LegalDocuments\Value\Criterion\id(), and returnWithMessage().

                                      : void
     {
         $this->admin->requireEditable();
         $this->admin->withDocumentAndCriterion(function (Document $document, Criterion $criterion) {
             $this->config->legalDocuments()->document()->repository()->deleteCriterion($criterion->id());
             $this->returnWithMessage('doc_crit_detached', 'documents');
         });
     }

Here is the call graph for this function:

◆ deleteDocument()

ilLegalDocumentsAdministrationGUI::deleteDocument ( )

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

References admin(), and deleteDocumentsConfirmation().

                                     : void
     {
         $this->deleteDocumentsConfirmation([$this->admin->currentDocument()->value()]);
     }

Here is the call graph for this function:

◆ deleteDocuments()

ilLegalDocumentsAdministrationGUI::deleteDocuments ( )

Definition at line 206 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin(), ctrlTo(), deleteDocumentsConfirmation(), and ILIAS\Repository\ui().

                                      : void
     {
         $documents = $this->admin->retrieveDocuments();
         if ($documents === []) {
             $this->ui->mainTemplate()->setOnScreenMessage('failure', $this->ui->txt('select_at_least_one_object'), true);
             $this->ctrlTo('redirectByClass', 'documents');
         }
         $this->deleteDocumentsConfirmation($documents);
     }

Here is the call graph for this function:

◆ deleteDocumentsConfirmation()

ilLegalDocumentsAdministrationGUI::deleteDocumentsConfirmation ( array $documents )

private

Parameters

list<Document> $documents

Definition at line 306 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin().

Referenced by deleteDocument(), and deleteDocuments().

                                                                   : void
     {
         $this->admin->requireEditable();
         $this->container->tabs()->activateTab('documents');
         $this->admin->setContent($this->admin->deleteDocumentsConfirmation(
             $this->ctrlTo('getFormActionByClass', 'ignored'),
             'deleteConfirmed',
             'documents',
             $documents
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ documents()

ilLegalDocumentsAdministrationGUI::documents ( )

Definition at line 193 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin().

                                : void
     {
         $this->container->language()->loadLanguageModule('meta');
         $this->container->tabs()->activateTab('documents');
 
         if ($this->config->editable()) {
             $this->container->toolbar()->addStickyItem($this->admin->addDocumentButton($this->ctrlTo('getLinkTargetByClass', 'addDocument')));
         }
 
         $edit_links = $this->config->editable() ? new AdministrationEditLinks($this, $this->admin) : null;
         $this->admin->setContent($this->config->legalDocuments()->document()->table($this, __FUNCTION__, $edit_links));
     }

Here is the call graph for this function:

◆ editCriterion()

ilLegalDocumentsAdministrationGUI::editCriterion ( )

Definition at line 146 of file class.ilLegalDocumentsAdministrationGUI.php.

References $data, $url, admin(), ILIAS\LegalDocuments\Value\Criterion\content(), ILIAS\LegalDocuments\Value\Document\content(), ILIAS\LegalDocuments\Value\Document\criteria(), ctrlTo(), ILIAS\LegalDocuments\Value\Criterion\id(), and returnWithResult().

                                    : void
     {
         $this->admin->requireEditable();
         $this->admin->withDocumentAndCriterion(function (Document $document, Criterion $criterion) {
             $this->container->language()->loadLanguageModule('meta');
             $url = $this->admin->targetWithDocAndCriterion($this, $document, $criterion, 'editCriterion', 'getFormAction');
             $form = $this->admin->criterionForm($url, $document, $criterion->content());
             $form = $this->admin->withFormData($form, function (array $data) use ($document, $criterion) {
                 $content = new CriterionContent(...$data[0]['content']);
                 $criteria = array_filter($document->criteria(), fn(Criterion $other) => $other->id() !== $criterion->id());
                 $this->returnWithResult($this->config->legalDocuments()->document()->validateCriteriaContent($criteria, $content)->map(
                     fn() => $this->config->legalDocuments()->document()->repository()->updateCriterionContent($criterion->id(), $content)
                 ), 'doc_crit_changed', 'documents');
             });
 
             $this->container->tabs()->clearTargets();
             $this->container->tabs()->setBackTarget($this->container->language()->txt('back'), $this->ctrlTo('getLinkTargetByClass', 'documents'));
             $condition = $this->config->legalDocuments()->document()->toCondition($criterion->content());
             $this->container->ui()->mainTemplate()->setTitle(join(' - ', [$document->content()->title(), $condition->definition()->translatedType()]));
             $this->admin->setContent($form);
         });
     }

Here is the call graph for this function:

◆ editDocument()

ilLegalDocumentsAdministrationGUI::editDocument ( )

Definition at line 230 of file class.ilLegalDocumentsAdministrationGUI.php.

References Vendor\Package\$d, $data, $id, admin(), ctrlTo(), and returnWithMessage().

                                   : void
     {
         $this->admin->requireEditable();
         $this->container->tabs()->clearTargets();
         $this->admin->idOrHash($this, function (Closure $link, string $title, DocumentId $id, bool $may_be_new) {
             $content = fn() => $this->config->legalDocuments()->document()->repository()->findId($id)->map(fn($d) => $d->content());
             $form = $this->admin->documentForm($link, $title, $content, $may_be_new);
             $form = $this->admin->withFormData($form, function ($data) use (/* $edit_link, */$id) {
                 $this->config->legalDocuments()->document()->repository()->updateDocumentTitle($id, $data[0]['title']);
                 $this->returnWithMessage('saved_successfully', 'documents');
             });
 
             $this->container->tabs()->setBackTarget($this->container->language()->txt('back'), $this->ctrlTo('getLinkTargetByClass', 'documents'));
             $this->container->tabs()->activateTab('documents');
             $this->admin->setContent($form);
         });
     }

Here is the call graph for this function:

◆ executeCommand()

ilLegalDocumentsAdministrationGUI::executeCommand ( )

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

References isCommand().

                                     : void
     {
         $cmd = $this->container->ctrl()->getCmd('documents');
         if (!$this->isCommand($cmd)) {
             throw new Exception('Unknown command: ' . $cmd);
         }
         $this->$cmd();
     }

Here is the call graph for this function:

◆ history()

ilLegalDocumentsAdministrationGUI::history ( )

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

References admin().

Referenced by historyResetFilter().

                              : void
     {
         if (!$this->admin->canReadUserAdministration()) {
             $this->container['ilErr']->raiseError($this->container->language()->txt('permission_denied'), $this->container['ilErr']->WARNING);
         }
         $this->container->tabs()->activateTab('history');
         $this->admin->setContent($this->config->legalDocuments()->history()->table(
             $this,
             'history',
             'historyResetFilter',
             'searchUser'
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ historyResetFilter()

ilLegalDocumentsAdministrationGUI::historyResetFilter ( )

Definition at line 111 of file class.ilLegalDocumentsAdministrationGUI.php.

References history().

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

Here is the call graph for this function:

◆ isCommand()

ilLegalDocumentsAdministrationGUI::isCommand ( string $cmd )

private

Definition at line 294 of file class.ilLegalDocumentsAdministrationGUI.php.

Referenced by executeCommand().

                                            : bool
     {
         $reflection = new ReflectionClass($this);
         return $reflection->hasMethod($cmd)
             && $reflection->getMethod($cmd)->isPublic()
             && (string) $reflection->getMethod($cmd)->getReturnType() === 'void'
             && $reflection->getMethod($cmd)->getNumberOfParameters() === 0;
     }

Here is the caller graph for this function:

◆ returnWithMessage()

ilLegalDocumentsAdministrationGUI::returnWithMessage	(	string	$message,
		string	$command
	)

private

Definition at line 334 of file class.ilLegalDocumentsAdministrationGUI.php.

References ctrlTo(), and ILIAS\Repository\ui().

Referenced by deleteConfirmed(), deleteCriterion(), editDocument(), and saveOrder().

                                                                         : void
     {
         $this->ui->mainTemplate()->setOnScreenMessage('success', $this->ui->txt($message), true);
         $this->ctrlTo('redirectByClass', $command);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ returnWithResult()

ilLegalDocumentsAdministrationGUI::returnWithResult	(	Result	$result,
		string	$success_message,
		string	$target
	)

private

Definition at line 340 of file class.ilLegalDocumentsAdministrationGUI.php.

References criterionErrorMessage(), ctrlTo(), ILIAS\Data\Result\error(), and ILIAS\Repository\ui().

Referenced by addCriterion(), and editCriterion().

                                                                                               : void
     {
         if ($result->isOk()) {
             $this->ui->mainTemplate()->setOnScreenMessage('success', $this->ui->txt($success_message), true);
         } else {
             $this->ui->mainTemplate()->setOnScreenMessage('failure', $this->criterionErrorMessage($result->error()), true);
         }
 
         $this->ctrlTo('redirectByClass', $target);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveOrder()

ilLegalDocumentsAdministrationGUI::saveOrder ( )

Definition at line 248 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin(), ctrlTo(), returnWithMessage(), and ILIAS\Repository\ui().

                                : void
     {
         $this->admin->requireEditable();
         try {
             $this->admin->withDocumentsAndOrder($this->admin->saveDocumentOrder(...));
             $this->returnWithMessage('saved_successfully', 'documents');
         } catch (ConstraintViolationException) {
             $this->ui->mainTemplate()->setOnScreenMessage('failure', $this->ui->txt('ldoc_order_invalid'), true);
             $this->ctrlTo('redirectByClass', 'documents');
         }
 
     }

Here is the call graph for this function:

◆ searchUser()

ilLegalDocumentsAdministrationGUI::searchUser ( )

Definition at line 85 of file class.ilLegalDocumentsAdministrationGUI.php.

References $response, ilUserAutoComplete\MAX_ENTRIES, and ilUtil\stripSlashes().

                                 : void
     {
         $auto = new ilUserAutoComplete();
         $auto->setSearchFields(['login', 'firstname', 'lastname', 'email']);
         $auto->enableFieldSearchableCheck(false);
         $auto->setMoreLinkAvailable(true);
 
         if ($this->container->http()->wrapper()->query()->has('fetchall')) {
             $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
         }
 
         if ($this->container->http()->wrapper()->query()->has('term')) {
             $query = ilUtil::stripSlashes(
                 $this->container->http()->wrapper()->query()->retrieve('term', $this->container->refinery()->kindlyTo()->string())
             );
             $response = $this->container->http()
                                         ->response()
                                         ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
                                         ->withBody(Streams::ofString($auto->getList($query)));
             $this->container->http()->saveResponse($response);
         }
 
         $this->container->http()->sendResponse();
         $this->container->http()->close();
     }

Here is the call graph for this function:

◆ tab()

ilLegalDocumentsAdministrationGUI::tab	(	string	$cmd,
		string	$label,
		bool	$can_access = `true`
	)

private

Returns: array{0: string, 1: string, 2: string, 3: bool}

Definition at line 275 of file class.ilLegalDocumentsAdministrationGUI.php.

References ctrlTo().

Referenced by tabs().

                                                                              : array
     {
         return [$cmd, $label, $this->ctrlTo('getLinkTargetByClass', $cmd), $can_access];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tabs()

ilLegalDocumentsAdministrationGUI::tabs ( array $run_after = [] )

Parameters

array<string,Closure() void> $run_after

Definition at line 264 of file class.ilLegalDocumentsAdministrationGUI.php.

References admin(), tab(), and ILIAS\Repository\ui().

                                                : void
     {
         $this->admin->tabs([
             $this->tab('documents', $this->ui->txt('agreement_documents_tab_label')),
             $this->tab('history', $this->ui->txt('acceptance_history'), $this->admin->canReadUserAdministration()),
         ], $run_after);
     }

Here is the call graph for this function:

◆ upload()

ilLegalDocumentsAdministrationGUI::upload ( )

Definition at line 178 of file class.ilLegalDocumentsAdministrationGUI.php.

References $id, and admin().

                             : void
     {
         $this->admin->requireEditable();
         $this->admin->idOrHash($this, function (Closure $link, string $title, DocumentId $id) {
             $raw_content = $this->admin->uploadContent();
             $sanitised_value = trim((new HTMLPurifier())->purify($raw_content));
             if ($this->admin->isInvalidHTML($sanitised_value)) {
                 $sanitised_value = nl2br($sanitised_value);
             }
 
             $this->config->legalDocuments()->document()->repository()->updateDocumentContent($id, new DocumentContent('html', $title, $sanitised_value));
             $this->admin->exitWithJsonResponse(['status' => 1]);
         });
     }

Here is the call graph for this function:

Field Documentation

◆ $admin

readonly Administration ilLegalDocumentsAdministrationGUI::$admin

private

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

Referenced by admin().

◆ $container

readonly Container ilLegalDocumentsAdministrationGUI::$container

private

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

◆ $ui

readonly UI ilLegalDocumentsAdministrationGUI::$ui

private

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

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

components/ILIAS/LegalDocuments/classes/class.ilLegalDocumentsAdministrationGUI.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCriterion()

◆ addDocument()

◆ admin()

◆ criterionErrorMessage()

◆ ctrlTo()

◆ deleteConfirmed()

◆ deleteCriterion()

◆ deleteDocument()

◆ deleteDocuments()

◆ deleteDocumentsConfirmation()

◆ documents()

◆ editCriterion()

◆ editDocument()

◆ executeCommand()

◆ history()

◆ historyResetFilter()

◆ isCommand()

◆ returnWithMessage()

◆ returnWithResult()

◆ saveOrder()

◆ searchUser()

◆ tab()

◆ tabs()

◆ upload()

Field Documentation

◆ $admin

◆ $container

◆ $ui