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, ?WrapperFactory $http_wrapper=null, ?Factory $refinery=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 $document, string $cmd, string $method='getLinkTarget')

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

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

	withFormData (Form $form, Closure $then)

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

	currentDocument ()

	criterionForm (string $url, Document $document, ?CriterionContent $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)
	@template A More...

	exitWithJsonResponse ($value)

	requireEditable ()

	externalSettingsMessage (bool $enabled)

	isInvalidHTML (string $string)

	isValidHTML (string $string)

	canReadUserAdministration ()

Private Member Functions
	retrieveValueOrDefaultFromPost (string $key, Transformation $transformation, mixed $default=null)

	retrieveValueOrDefaultFromQuery (string $key, Transformation $transformation, mixed $default=null)

	canWriteUserAdministration ()

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

Private Attributes
readonly Closure	$confirmation

WrapperFactory	$http_wrapper

Factory	$refinery

Detailed Description

Definition at line 52 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`,
		?WrapperFactory	$http_wrapper = `null`,
		?Factory	$refinery = `null`
	)

Parameters

null|Closure() Confirmation $confirmation

Definition at line 62 of file Administration.php.

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

References ILIAS\LegalDocuments\Administration\$http_wrapper, ILIAS\UI\examples\MessageBox\Confirmation\confirmation(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ addDocumentButton()

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

Definition at line 379 of file Administration.php.

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

References ILIAS\Repository\ui().

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 558 of file Administration.php.

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

References $id.

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

Here is the caller graph for this function:

◆ canReadUserAdministration()

ILIAS\LegalDocuments\Administration::canReadUserAdministration ( )

Definition at line 548 of file Administration.php.

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

References USER_FOLDER_ID.

◆ canWriteUserAdministration()

ILIAS\LegalDocuments\Administration::canWriteUserAdministration ( )

private

Definition at line 553 of file Administration.php.

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

References USER_FOLDER_ID.

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

Here is the caller graph for this function:

◆ criterionForm()

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

Definition at line 317 of file Administration.php.

                                                                                                       : Form
    {
        $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]);
    }

References ILIAS\LegalDocuments\Value\Document\content(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ currentDocument()

ILIAS\LegalDocuments\Administration::currentDocument ( )

Returns: Result<Document>

Definition at line 295 of file Administration.php.

                                     : Result
    {
        $doc_id = $this->retrieveValueOrDefaultFromQuery(
            'doc_id',
            $this->refinery->kindlyTo()->int(),
        );
 
        if (!$doc_id) {
            //Try reading from UI-Table action
            $doc_id = $this->retrieveValueOrDefaultFromQuery(
                'legal_document_id',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                []
            );
            $doc_id = current($doc_id) ?: null;
        }
 
        $repo = $this->config->legalDocuments()->document()->repository();
 
        return $this->refinery->kindlyTo()->int()->applyTo(new Ok($doc_id))->then($repo->find(...));
    }

References ILIAS\Repository\refinery(), and ILIAS\LegalDocuments\Administration\retrieveValueOrDefaultFromQuery().

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

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 94 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 78 of file Administration.php.

                                                                                                                                    : 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
        );
    }

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

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 430 of file Administration.php.

                                                                                                           : Form
    {
        $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]);
    }

References ILIAS\Repository\ui().

Here is the call graph for this function:

◆ exitWithJsonResponse()

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

Definition at line 501 of file Administration.php.

                                                : void
    {
        // ... The content type cannot be set to application/json, because the components/ILIAS/UI/src/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();
    }

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

Here is the call graph for this function:

◆ externalSettingsMessage()

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

Definition at line 520 of file Administration.php.

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

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

Here is the call graph for this function:

◆ find()

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

@template A

Parameters

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

Returns: A|null

Definition at line 281 of file Administration.php.

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

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

Here is the caller graph for this function:

◆ idOrHash()

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

Parameters

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

Definition at line 204 of file Administration.php.

                                                        : 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();
 
    }

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

Here is the call graph for this function:

◆ isInvalidHTML()

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

Definition at line 538 of file Administration.php.

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

References ILIAS\LegalDocuments\Administration\isValidHTML().

Here is the call graph for this function:

◆ isValidHTML()

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

Definition at line 543 of file Administration.php.

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

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

Here is the caller graph for this function:

◆ render()

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

Parameters

list<Component>|Component|string $component

Definition at line 398 of file Administration.php.

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

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

Here is the caller graph for this function:

◆ requireDocumentHash()

ILIAS\LegalDocuments\Administration::requireDocumentHash ( )

Definition at line 336 of file Administration.php.

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

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

Here is the caller graph for this function:

◆ requireEditable()

ILIAS\LegalDocuments\Administration::requireEditable ( )

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

array<Button> $buttons

Definition at line 409 of file Administration.php.

                                                                                : 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);
    }

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

Here is the call graph for this function:

◆ resetButton()

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

Definition at line 418 of file Administration.php.

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

References ILIAS\Repository\ui().

Here is the call graph for this function:

◆ retrieveDocuments()

ILIAS\LegalDocuments\Administration::retrieveDocuments ( )

Returns: list<Document>

Definition at line 128 of file Administration.php.

                                       : 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;
    }

References ILIAS\LegalDocuments\Administration\retrieveIds().

Here is the call graph for this function:

◆ retrieveIds()

ILIAS\LegalDocuments\Administration::retrieveIds ( )

Returns: list<int>

Definition at line 142 of file Administration.php.

                                 : array
    {
        $ids = $this->retrieveValueOrDefaultFromPost(
            'ids',
            $this->container->refinery()->kindlyTo()->listOf(
                $this->container->refinery()->kindlyTo()->int()
            )
        );
 
        if (!$ids) {
            //Try reading from UI-Table action
            $ids = $this->retrieveValueOrDefaultFromQuery(
                'legal_document_id',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                []
            );
        }
 
        if (!$ids) {
            //Try reading from UI-Table "apply to all objects"
            $ids = $this->retrieveValueOrDefaultFromQuery(
                'legal_document_id',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->string()),
                []
            );
 
            if (current($ids) === 'ALL_OBJECTS') {
                $ids = [];
                foreach ($this->config->legalDocuments()->document()->repository()->all() as $document) {
                    $ids[] = $document->id();
                }
            }
        }
 
        return $ids ?: [];
    }

References ILIAS\Repository\refinery(), ILIAS\LegalDocuments\Administration\retrieveValueOrDefaultFromPost(), and ILIAS\LegalDocuments\Administration\retrieveValueOrDefaultFromQuery().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveValueOrDefaultFromPost()

ILIAS\LegalDocuments\Administration::retrieveValueOrDefaultFromPost	(	string	$key,
		Transformation	$transformation,
		mixed	$default = `null`
	)

private

Definition at line 179 of file Administration.php.

                                                                                                                       : mixed
    {
        return $this->container->http()->wrapper()->post()->retrieve(
            $key,
            $this->container->refinery()->byTrying([
                $transformation,
                $this->container->refinery()->always($default)
            ])
        );
    }

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

Here is the caller graph for this function:

◆ retrieveValueOrDefaultFromQuery()

ILIAS\LegalDocuments\Administration::retrieveValueOrDefaultFromQuery	(	string	$key,
		Transformation	$transformation,
		mixed	$default = `null`
	)

private

Definition at line 190 of file Administration.php.

                                                                                                                        : mixed
    {
        return $this->container->http()->wrapper()->query()->retrieve(
            $key,
            $this->container->refinery()->byTrying([
                $transformation,
                $this->container->refinery()->always($default)
            ])
        );
    }

Referenced by ILIAS\LegalDocuments\Administration\currentDocument(), and ILIAS\LegalDocuments\Administration\retrieveIds().

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 450 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|string $component

Definition at line 374 of file Administration.php.

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

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

Here is the call graph for this function:

◆ setVariable()

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

Parameters

list<Component>|Component $component

Definition at line 390 of file Administration.php.

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

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

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 345 of file Administration.php.

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

References ILIAS\LegalDocuments\Administration\addTab().

Here is the call graph for this function:

◆ targetWithDoc()

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

Definition at line 217 of file Administration.php.

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

References ILIAS\LegalDocuments\Value\Document\id(), and ILIAS\LegalDocuments\Administration\willLinkWith().

Here is the call graph for this function:

◆ targetWithDocAndCriterion()

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

Definition at line 223 of file Administration.php.

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

References ILIAS\LegalDocuments\Value\Criterion\id(), ILIAS\LegalDocuments\Value\Document\id(), and ILIAS\LegalDocuments\Administration\willLinkWith().

Here is the call graph for this function:

◆ uploadContent()

ILIAS\LegalDocuments\Administration::uploadContent ( )

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

string \| object	$gui
	array<int\|string,string>	$parameters

Returns: Closure(string, ?string?): string

Definition at line 238 of file Administration.php.

                                                              : Closure
    {
        $class = is_string($gui) ? $gui : $gui::class;
        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, (string) $key, $value);
            }
            $link = $this->container->ctrl()->$method($gui, $cmd);
            foreach ($parameters as $key => $_) {
                $this->container->ctrl()->setParameterByClass($class, (string) $key, $array[$key] ?? '');
            }
 
            return $link;
        };
    }

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

Here is the caller graph for this function:

◆ withDocumentAndCriterion()

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

Parameters

Closure(Document,Criterion) void $proc

Definition at line 105 of file Administration.php.

                                                           : 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);
    }

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

Here is the call graph for this function:

◆ withDocumentsAndOrder()

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

@template A

Parameters

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

Returns: A

Definition at line 469 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();
        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	$form,
		Closure	$then
	)

Parameters

Closure(array) void $then

Definition at line 259 of file Administration.php.

                                                           : Form
    {
        $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;
    }

References $data, ILIAS\UI\Component\Input\Container\Container\getData(), and ILIAS\UI\Component\Input\Container\Container\withRequest().

Here is the call graph for this function:

Field Documentation

◆ $confirmation

readonly Closure ILIAS\LegalDocuments\Administration::$confirmation

private

Definition at line 55 of file Administration.php.

◆ $http_wrapper

WrapperFactory ILIAS\LegalDocuments\Administration::$http_wrapper

private

Definition at line 56 of file Administration.php.

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

◆ $refinery

Factory ILIAS\LegalDocuments\Administration::$refinery

private

Definition at line 57 of file Administration.php.

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

components/ILIAS/LegalDocuments/classes/Administration.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDocumentButton()

◆ addTab()

◆ canReadUserAdministration()

◆ canWriteUserAdministration()

◆ criterionForm()

◆ currentDocument()

◆ deleteDocuments()

◆ deleteDocumentsConfirmation()

◆ documentForm()

◆ exitWithJsonResponse()

◆ externalSettingsMessage()

◆ find()

◆ idOrHash()

◆ isInvalidHTML()

◆ isValidHTML()

◆ render()

◆ requireDocumentHash()

◆ requireEditable()

◆ resetBox()

◆ resetButton()

◆ retrieveDocuments()

◆ retrieveIds()

◆ retrieveValueOrDefaultFromPost()

◆ retrieveValueOrDefaultFromQuery()

◆ saveDocumentOrder()

◆ setContent()

◆ setVariable()

◆ tabs()

◆ targetWithDoc()

◆ targetWithDocAndCriterion()

◆ uploadContent()

◆ willLinkWith()

◆ withDocumentAndCriterion()

◆ withDocumentsAndOrder()

◆ withFormData()

Field Documentation

◆ $confirmation

◆ $http_wrapper

◆ $refinery