Collaboration diagram for ILIAS\LegalDocuments\Administration:

Public Member Functions
	__construct (private readonly Config $config, private readonly Container $container, private readonly UI $ui, ?Closure $confirmation=null)

	deleteDocumentsConfirmation (string $form_link, string $submit_command, string $cancel_command, array $documents)

	deleteDocuments (array $documents)

	withDocumentAndCriterion (Closure $proc)

	retrieveDocuments ()

	retrieveIds ()

	idOrHash (object $gui, Closure $then)

	targetWithDoc (object $gui, $document, string $cmd, string $method='getLinkTarget')

	targetWithDocAndCriterion (object $gui, $document, $criterion, string $cmd, string $method='getLinkTarget')

	willLinkWith ($gui, array $parameters=[])

	withFormData ($form, Closure $then)

	find (Closure $predicate, array $array)
	A More...

	currentDocument ()

	criterionForm (string $url, Document $document, $criterion=null)

	requireDocumentHash ()

	tabs (array $tabs, array $run_after=[])

	uploadContent ()

	setContent ($component)

	addDocumentButton (string $add_document_link)

	setVariable (string $variable, $component)

	render ($component)

	resetBox (DateTimeImmutable $reset_date, array $buttons=[])

	resetButton (string $confirm_reset_link)

	documentForm (Closure $link, string $title, Closure $document_content, bool $may_be_new)

	saveDocumentOrder (array $documents, array $order_by_document)

	withDocumentsAndOrder (Closure $proc)

	exitWithJsonResponse ($value)

	requireEditable ()

	externalSettingsMessage (bool $enabled)

	isInvalidHTML (string $string)

	isValidHTML (string $string)

	canReadUserAdministration ()

Private Member Functions
	addTab (string $id, string $text, string $link, bool $can_access=true)

Private Attributes
readonly Closure	$confirmation

Detailed Description

Definition at line 48 of file Administration.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LegalDocuments\Administration::__construct	(	private readonly Config	$config,
		private readonly Container	$container,
		private readonly UI	$ui,
		?Closure	$confirmation = `null`
	)

Parameters

null|Closure() Confirmation $confirmation

Definition at line 56 of file Administration.php.

References ILIAS\UI\examples\MessageBox\Confirmation\confirmation().

       {
         $this->confirmation = $confirmation ?? fn() => new Confirmation($this->container->language());
     }

Here is the call graph for this function:

Member Function Documentation

◆ addDocumentButton()

ILIAS\LegalDocuments\Administration::addDocumentButton ( string $add_document_link )

Definition at line 296 of file Administration.php.

References ILIAS\Repository\ui().

                                                                 : Component
     {
         return $this->ui->create()->button()->primary(
             $this->ui->txt('add_document_btn_label'),
             $add_document_link
         );
     }

Here is the call graph for this function:

◆ addTab()

ILIAS\LegalDocuments\Administration::addTab	(	string	$id,
		string	$text,
		string	$link,
		bool	$can_access = `true`
	)

private

Definition at line 461 of file Administration.php.

Referenced by ILIAS\LegalDocuments\Administration\tabs().

                                                                                             : void
     {
         if ($can_access) {
             $this->container->tabs()->addTab($id, $text, $link);
         }
     }

Here is the caller graph for this function:

◆ canReadUserAdministration()

ILIAS\LegalDocuments\Administration::canReadUserAdministration ( )

Definition at line 456 of file Administration.php.

References USER_FOLDER_ID.

                                                : bool
     {
         return $this->container->rbac()->system()->checkAccess('read', USER_FOLDER_ID);
     }

◆ criterionForm()

ILIAS\LegalDocuments\Administration::criterionForm	(	string	$url,
		Document	$document,
			$criterion = `null`
	)

Definition at line 234 of file Administration.php.

References ILIAS\LegalDocuments\Value\Document\content(), ILIAS\Repository\ui(), and ILIAS\UI\Implementation\Component\Input\withValue().

     {
         $groups = $this->config->legalDocuments()->document()->conditionGroups($criterion);
         $group = $this->ui->create()->input()->field()->switchableGroup($groups->choices(), $this->ui->txt('form_criterion'));
         $value = $criterion ? $criterion->type() : $groups->defaultSelection();
         if ($value) {
             $group = $group->withValue($value);
         }
 
         $title = $this->ui->create()->input()->field()->text($this->ui->txt('form_document'))->withValue($document->content()->title())->withDisabled(true);
 
         $section = $this->ui->create()->input()->field()->section([
             $title,
             'content' => $group,
         ], $this->ui->txt($criterion ? 'form_edit_criterion_head' : 'form_attach_criterion_head'));
 
         return $this->ui->create()->input()->container()->form()->standard($url, [$section]);
     }

Here is the call graph for this function:

◆ currentDocument()

ILIAS\LegalDocuments\Administration::currentDocument ( )

Returns: Result<Document>

Definition at line 227 of file Administration.php.

References ILIAS\Data\Result\then().

Referenced by ILIAS\LegalDocuments\Administration\idOrHash(), and ILIAS\LegalDocuments\Administration\withDocumentAndCriterion().

                                      : Result
     {
         $repo = $this->config->legalDocuments()->document()->repository();
         $doc_id = $this->container->http()->request()->getQueryParams()['doc_id'] ?? null;
         return $this->container->refinery()->kindlyTo()->int()->applyTo(new Ok($doc_id))->then($repo->find(...));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteDocuments()

ILIAS\LegalDocuments\Administration::deleteDocuments ( array $documents )

Parameters

list<Document> $documents

Definition at line 84 of file Administration.php.

                                                      : void
     {
         array_map(
             $this->config->legalDocuments()->document()->repository()->deleteDocument(...),
             $documents
         );
     }

◆ deleteDocumentsConfirmation()

ILIAS\LegalDocuments\Administration::deleteDocumentsConfirmation	(	string	$form_link,
		string	$submit_command,
		string	$cancel_command,
		array	$documents
	)

Parameters

list<Document> $documents

Definition at line 68 of file Administration.php.

References ILIAS\UI\examples\MessageBox\Confirmation\confirmation(), and ILIAS\Repository\ui().

                                                                                                                                     : string
     {
         $items = array_column(array_map(fn($x) => [$x->id(), $x->content()->title()], $documents), 1, 0);
 
         return (($this->confirmation)())->render(
             $form_link,
             $submit_command,
             $cancel_command,
             $this->ui->txt('sure_delete_documents_p'),
             $items
         );
     }

Here is the call graph for this function:

◆ documentForm()

ILIAS\LegalDocuments\Administration::documentForm	(	Closure	$link,
		string	$title,
		Closure	$document_content,
		bool	$may_be_new
	)

Parameters

Closure(string)	string $link
Closure()	Result<DocumentContent> $document_content

Definition at line 347 of file Administration.php.

References ILIAS\Repository\ui().

                                                                                                            : Component
     {
         $edit_link = $link('editDocument');
         $content_title = $may_be_new ? 'form_document' : 'form_document_new';
 
         $section = $this->ui->create()->input()->field()->section([
             'title' => $this->ui->create()->input()->field()->text($this->ui->txt('title'))->withRequired(true)->withValue($title),
             'content' => $this->ui->create()->input()->field()->file(new UploadHandler($link, $document_content, $this->ui->txt(...)), $this->ui->txt($content_title))->withAcceptedMimeTypes([
                 'text/html',
                 'text/plain',
             ])->withRequired($may_be_new),
         ], $this->ui->txt($may_be_new ? 'form_new_doc_head' : 'form_edit_doc_head'));
 
         return $this->ui->create()->input()->container()->form()->standard($edit_link, [$section]);
     }

Here is the call graph for this function:

◆ exitWithJsonResponse()

ILIAS\LegalDocuments\Administration::exitWithJsonResponse ( $value )

Definition at line 415 of file Administration.php.

References ILIAS\Filesystem\Stream\Streams\ofString().

                                                 : void
     {
         // ... The content type cannot be set to application/json, because the src/UI/templates/js/Input/Field/file.js:392
         //     does not expect that the content type is correct and parses it again ...
         $this->container->http()->saveResponse($this->container->http()->response()/* ->withHeader('Content-Type', 'application/json') */->withBody(
             Streams::ofString(json_encode($value))
         ));
 
         $this->container->http()->sendResponse();
         $this->container->http()->close();
     }

Here is the call graph for this function:

◆ externalSettingsMessage()

ILIAS\LegalDocuments\Administration::externalSettingsMessage ( bool $enabled )

Definition at line 434 of file Administration.php.

References ILIAS\Repository\ui(), USER_FOLDER_ID, and ILIAS\LegalDocuments\Administration\willLinkWith().

                                                           : Component
     {
         return $this->ui->create()->messageBox()->info(
             $this->ui->txt('withdrawal_usr_deletion') . ': ' . $this->ui->txt($enabled ? 'enabled' : 'disabled')
         )->withLinks([
             $this->ui->create()->link()->standard(
                 $this->ui->txt('adm_external_setting_edit'),
                 $this->willLinkWith(ilObjUserFolderGUI::class, ['ref_id' => USER_FOLDER_ID])('generalSettings')
             )
         ]);
     }

Here is the call graph for this function:

◆ find()

ILIAS\LegalDocuments\Administration::find	(	Closure	$predicate,
		array	$array
	)

A

Parameters

Closure(A)	bool $predicate
list<A>	$array

Returns: A|null

Definition at line 213 of file Administration.php.

Referenced by ILIAS\LegalDocuments\Administration\withDocumentAndCriterion().

     {
         foreach ($array as $value) {
             if ($predicate($value)) {
                 return $value;
             }
         }
 
         return null;
     }

Here is the caller graph for this function:

◆ idOrHash()

ILIAS\LegalDocuments\Administration::idOrHash	(	object	$gui,
		Closure	$then
	)

Parameters

Closure(Closure(string) string, DocumentId, bool): void $then

Definition at line 138 of file Administration.php.

References ILIAS\LegalDocuments\Administration\currentDocument(), ILIAS\LegalDocuments\Administration\requireDocumentHash(), and ILIAS\LegalDocuments\Administration\willLinkWith().

                                                         : void
     {
         $with_doc_id = fn($document) => $then($this->willLinkWith($gui, ['doc_id' => $document->id()]), $document->content()->title(), new NumberId($document), false);
         $with_hash = fn(string $hash) => $then($this->willLinkWith($gui, ['hash' => $hash]), '', new HashId($hash), true);
         $try_hash = fn() => new Ok($with_hash($this->requireDocumentHash()));
 
         $this->currentDocument()
              ->map($with_doc_id)
              ->except($try_hash)
              ->value();
 
     }

Here is the call graph for this function:

◆ isInvalidHTML()

ILIAS\LegalDocuments\Administration::isInvalidHTML ( string $string )

Definition at line 446 of file Administration.php.

References ILIAS\LegalDocuments\Administration\isValidHTML().

                                                  : bool
     {
         return !$this->isValidHTML($string);
     }

Here is the call graph for this function:

◆ isValidHTML()

ILIAS\LegalDocuments\Administration::isValidHTML ( string $string )

Definition at line 451 of file Administration.php.

Referenced by ILIAS\LegalDocuments\Administration\isInvalidHTML().

                                                : bool
     {
         return (new ValidHTML())->isTrue($string);
     }

Here is the caller graph for this function:

◆ render()

ILIAS\LegalDocuments\Administration::render ( $component )

Parameters

list<Component>|Component|string $component

Definition at line 315 of file Administration.php.

Referenced by ILIAS\LegalDocuments\Administration\setContent(), and ILIAS\LegalDocuments\Administration\setVariable().

                                       : string
     {
         if (is_string($component)) {
             return $component;
         }
         return $this->container->ui()->renderer()->render($component);
     }

Here is the caller graph for this function:

◆ requireDocumentHash()

ILIAS\LegalDocuments\Administration::requireDocumentHash ( )

Definition at line 253 of file Administration.php.

Referenced by ILIAS\LegalDocuments\Administration\idOrHash().

                                          : string
     {
         return $this->container->http()->wrapper()->query()->retrieve('hash', $this->container->refinery()->to()->string());
     }

Here is the caller graph for this function:

◆ requireEditable()

ILIAS\LegalDocuments\Administration::requireEditable ( )

Definition at line 427 of file Administration.php.

                                      : void
     {
         if (!$this->config->editable()) {
             $this->container['ilErr']->raiseError($this->container->language()->txt('permission_denied'), $this->container['ilErr']->WARNING);
         }
     }

◆ resetBox()

ILIAS\LegalDocuments\Administration::resetBox	(	DateTimeImmutable	$reset_date,
		array	$buttons = `[]`
	)

Parameters

list<Button> $buttons

Definition at line 326 of file Administration.php.

References ilDatePresentation\formatDate(), IL_CAL_UNIX, and ILIAS\Repository\ui().

                                                                                 : Component
     {
         $reset_date = new ilDateTime($reset_date->getTimeStamp(), IL_CAL_UNIX);
         return $this->ui->create()
                                ->messageBox()
                                ->info(sprintf($this->ui->txt('last_reset_date'), ilDatePresentation::formatDate($reset_date)))
                                ->withButtons($buttons);
     }

Here is the call graph for this function:

◆ resetButton()

ILIAS\LegalDocuments\Administration::resetButton ( string $confirm_reset_link )

Definition at line 335 of file Administration.php.

References ILIAS\Repository\ui().

                                                            : Component
     {
         return $this->ui->create()->button()->standard(
             $this->ui->txt('reset_for_all_users'),
             $confirm_reset_link
         );
     }

Here is the call graph for this function:

◆ retrieveDocuments()

ILIAS\LegalDocuments\Administration::retrieveDocuments ( )

Definition at line 115 of file Administration.php.

References ILIAS\LegalDocuments\Administration\retrieveIds().

                                        : array
     {
         $ids = $this->retrieveIds();
         $documents = $this->config->legalDocuments()->document()->repository()->select($ids);
         if (count($documents) !== count($ids)) {
             throw new InvalidArgumentException('List contains invalid documents.');
         }
 
         return $documents;
     }

Here is the call graph for this function:

◆ retrieveIds()

ILIAS\LegalDocuments\Administration::retrieveIds ( )

Definition at line 126 of file Administration.php.

References $r.

Referenced by ILIAS\LegalDocuments\Administration\retrieveDocuments().

                                  : array
     {
         $r = $this->container->refinery();
         return $this->container->http()->wrapper()->post()->retrieve('ids', $this->container->refinery()->byTrying([
             $r->in()->series([$r->null(), $r->always([])]),
             $r->to()->listOf($r->kindlyTo()->int())
         ]));
     }

Here is the caller graph for this function:

◆ saveDocumentOrder()

ILIAS\LegalDocuments\Administration::saveDocumentOrder	(	array	$documents,
		array	$order_by_document
	)

Parameters

list<Document>	$documents
array<int,int>	$order_by_document

Definition at line 367 of file Administration.php.

                                                                                  : void
     {
         $update = $this->config->legalDocuments()->document()->repository()->updateDocumentOrder(...);
 
         usort($documents, fn($document, $other) => $order_by_document[$document->id()] - $order_by_document[$other->id()]);
 
         array_map(
             fn($document, int $order) => $update(new NumberId($document), $order),
             $documents,
             range(10, 10 * count($documents), 10)
         );
     }

◆ setContent()

ILIAS\LegalDocuments\Administration::setContent ( $component )

Parameters

list<Component>|Component $component

Definition at line 291 of file Administration.php.

References ILIAS\LegalDocuments\Administration\render(), and ILIAS\Repository\ui().

                                           : void
     {
         $this->ui->mainTemplate()->setContent($this->render($component));
     }

Here is the call graph for this function:

◆ setVariable()

ILIAS\LegalDocuments\Administration::setVariable	(	string	$variable,
			$component
	)

Parameters

list<Component>|Component $component

Definition at line 307 of file Administration.php.

References ILIAS\LegalDocuments\Administration\render(), and ILIAS\Repository\ui().

                                                              : void
     {
         $this->ui->mainTemplate()->setVariable($variable, $this->render($component));
     }

Here is the call graph for this function:

◆ tabs()

ILIAS\LegalDocuments\Administration::tabs	(	array	$tabs,
		array	$run_after = `[]`
	)

Parameters

list<array{0	string, 1: string, 2: string}> $tabs
array<string,Closure()	void> $run_after

Definition at line 262 of file Administration.php.

References ILIAS\LegalDocuments\Administration\addTab().

                                                             : void
     {
         foreach ($tabs as $tab) {
             $this->addTab(...$tab);
             if (isset($run_after[$tab[0]])) {
                 $run_after[$tab[0]]();
             }
         }
     }

Here is the call graph for this function:

◆ targetWithDoc()

ILIAS\LegalDocuments\Administration::targetWithDoc	(	object	$gui,
			$document,
		string	$cmd,
		string	$method = `'getLinkTarget'`
	)

Definition at line 151 of file Administration.php.

References ILIAS\LegalDocuments\Administration\willLinkWith().

                                                                                                         : string
     {
         $link = $this->willLinkWith($gui, ['doc_id' => (string) $document->id()]);
         return $link($cmd, $method);
     }

Here is the call graph for this function:

◆ targetWithDocAndCriterion()

ILIAS\LegalDocuments\Administration::targetWithDocAndCriterion	(	object	$gui,
			$document,
			$criterion,
		string	$cmd,
		string	$method = `'getLinkTarget'`
	)

Definition at line 157 of file Administration.php.

References ILIAS\LegalDocuments\Administration\willLinkWith().

     {
         $link = $this->willLinkWith($gui, [
             'doc_id' => (string) $document->id(),
             'criterion_id' => (string) $criterion->id(),
         ]);
 
         return $link($cmd, $method);
     }

Here is the call graph for this function:

◆ uploadContent()

ILIAS\LegalDocuments\Administration::uploadContent ( )

Definition at line 272 of file Administration.php.

                                    : string
     {
         $value = null;
         $upload = $this->container->upload();
         $upload->register(new PreProcessor(function (string $content) use (&$value): void {
             $value = $content;
         }));
         $upload->process();
         $result_array = $upload->getResults();
         if (count($result_array) !== 1 || !current($result_array)->isOk()) {
             throw new Exception('Unexpected upload result.');
         }
 
         return $value;
     }

◆ willLinkWith()

ILIAS\LegalDocuments\Administration::willLinkWith	(		$gui,
		array	$parameters = `[]`
	)

Parameters

array<string,string> $parameters

Definition at line 170 of file Administration.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by ILIAS\LegalDocuments\Administration\externalSettingsMessage(), ILIAS\LegalDocuments\Administration\idOrHash(), ILIAS\LegalDocuments\Administration\targetWithDoc(), and ILIAS\LegalDocuments\Administration\targetWithDocAndCriterion().

                                                               : Closure
     {
         $class = is_string($gui) ? $gui : get_class($gui);
         return function (string $cmd, ?string $method = null) use ($gui, $class, $parameters): string {
             $method ??= $class === $gui ? 'getLinkTargetByClass' : 'getLinkTarget';
             $array = $this->container->ctrl()->getParameterArrayByClass($class);
             foreach ($parameters as $key => $value) {
                 $this->container->ctrl()->setParameterByClass($class, $key, $value);
             }
             $link = $this->container->ctrl()->$method($gui, $cmd);
             foreach ($parameters as $key => $_) {
                 $this->container->ctrl()->setParameterByClass($class, $key, $array[$key] ?? '');
             }
 
             return $link;
         };
     }

Here is the caller graph for this function:

◆ withDocumentAndCriterion()

ILIAS\LegalDocuments\Administration::withDocumentAndCriterion ( Closure $proc )

Parameters

Closure(Document,Criterion) void $proc

Definition at line 95 of file Administration.php.

References ILIAS\LegalDocuments\Administration\currentDocument(), ILIAS\LegalDocuments\Administration\find(), and ILIAS\Repository\int().

                                                            : void
     {
         $document = $this->currentDocument()->value();
         $criterion_id = ($this->container->http()->request()->getQueryParams()['criterion_id'] ?? null);
         if (null === $criterion_id) {
             throw new InvalidArgumentException('Missing query parameter criterion_id.');
         }
         $criterion_id = (int) $criterion_id;
 
         $criterion = $this->find(
             fn($criterion) => $criterion->id() === $criterion_id,
             $document->criteria()
         );
         if (!$criterion) {
             throw new InvalidArgumentException('Invalid criterion_id given.');
         }
 
         $proc($document, $criterion);
     }

Here is the call graph for this function:

◆ withDocumentsAndOrder()

ILIAS\LegalDocuments\Administration::withDocumentsAndOrder ( Closure $proc )

Parameters

Closure(list<Document>,array<int,int>) $proc

Definition at line 383 of file Administration.php.

     {
         // kindlyTo->int() does not accept numbers of the form "01".
         $to_int = $this->container->refinery()->byTrying([
             $this->container->refinery()->kindlyTo()->int(),
             $this->container->refinery()->in()->series([
                 $this->container->refinery()->to()->string(),
                 $this->container->refinery()->custom()->transformation(fn($s) => ltrim($s, '0') ?: '0'),
                 $this->container->refinery()->kindlyTo()->int(),
             ]),
         ]);
 
         $order = $this->container->http()->request()->getParsedBody()['order'] ?? null;
         if (!is_array($order)) {
             throw new InvalidArgumentException('Invalid order given. List of numbers expected.');
         }
 
         $order = array_map($to_int, $order);
         $document_ids = array_map($to_int, array_keys($order));
         $order = array_combine($document_ids, array_values($order));
 
         $documents = $this->config->legalDocuments()->document()->repository()->all();
 
         foreach ($documents as $document) {
             if (!isset($order[$document->id()])) {
                 $order[$document->id()] = $document->meta()->sorting();
             }
         }
 
         return $proc($documents, $order);
     }

◆ withFormData()

ILIAS\LegalDocuments\Administration::withFormData	(		$form,
		Closure	$then
	)

Parameters

Closure(array) void $then

Definition at line 191 of file Administration.php.

References $data.

     {
         $request = $this->container->http()->request();
         if ($request->getMethod() !== 'POST') {
             return $form;
         }
         $form = $form->withRequest($request);
         $data = $form->getData();
 
         if ($data !== null) {
             $then($data);
         }
 
         return $form;
     }

Field Documentation

◆ $confirmation

readonly Closure ILIAS\LegalDocuments\Administration::$confirmation

private

Definition at line 51 of file Administration.php.

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

Services/LegalDocuments/classes/Administration.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDocumentButton()

◆ addTab()

◆ canReadUserAdministration()

◆ criterionForm()

◆ currentDocument()

◆ deleteDocuments()

◆ deleteDocumentsConfirmation()

◆ documentForm()

◆ exitWithJsonResponse()

◆ externalSettingsMessage()

◆ find()

◆ idOrHash()

◆ isInvalidHTML()

◆ isValidHTML()

◆ render()

◆ requireDocumentHash()

◆ requireEditable()

◆ resetBox()

◆ resetButton()

◆ retrieveDocuments()

◆ retrieveIds()

◆ saveDocumentOrder()

◆ setContent()

◆ setVariable()

◆ tabs()

◆ targetWithDoc()

◆ targetWithDocAndCriterion()

◆ uploadContent()

◆ willLinkWith()

◆ withDocumentAndCriterion()

◆ withDocumentsAndOrder()

◆ withFormData()

Field Documentation

◆ $confirmation