Collaboration diagram for ILIAS\LegalDocuments\Provide\ProvideDocument:

Public Member Functions
	__construct (private readonly string $id, private readonly DocumentRepository $document_repository, private readonly SelectionMap $conditions, private readonly array $content_as_component, private readonly Container $container, ?Closure $create_table_gui=null)

	table (object $gui, string $command, ?EditLinks $edit_links=null)

	chooseDocumentFor (ilObjUser $user)

	documentMatches (Document $document, ilObjUser $user)

	repository ()

	hash ()

	toCondition (CriterionContent $content)

	conditionGroups (?CriterionContent $criterion=null)

	validateCriteriaContent (array $criteria, CriterionContent $content)

	contentAsComponent (DocumentContent $content)

Data Fields
const	CRITERION_ALREADY_EXISTS = 'Criterion already exists.'

const	CRITERION_WOULD_NEVER_MATCH = 'Criterion would never match.'

Private Member Functions
	validateAgainst (Result $b, Criterion $a)

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

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

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

Private Attributes
readonly Closure	$create_table_gui

Detailed Description

Definition at line 50 of file ProvideDocument.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LegalDocuments\Provide\ProvideDocument::__construct	(	private readonly string	$id,
		private readonly DocumentRepository	$document_repository,
		private readonly SelectionMap	$conditions,
		private readonly array	$content_as_component,
		private readonly Container	$container,
		?Closure	$create_table_gui = `null`
	)

Parameters

null\|Closure(object,string,TableInterface)	Table $create_table_gui
array<ConditionDefinition>	$conditions
array<string,Closure(CriterionContent)	Component $content_as_component

Definition at line 63 of file ProvideDocument.php.

       {
         $this->create_table_gui = $create_table_gui ?? fn($gui, $command, $t) => new Table($gui, $command, $t);
     }

Member Function Documentation

◆ all()

ILIAS\LegalDocuments\Provide\ProvideDocument::all	(	Closure	$predicate,
		array	$array
	)

private

A

Parameters

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

Definition at line 206 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Provide\ProvideDocument\any().

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\documentMatches().

                                                           : bool
     {
         return !$this->any(static fn($x) => !$predicate($x), $array);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ any()

ILIAS\LegalDocuments\Provide\ProvideDocument::any	(	Closure	$predicate,
		array	$array
	)

private

A

Parameters

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

Definition at line 196 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Provide\ProvideDocument\find().

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\all().

                                                           : bool
     {
         return $this->find($predicate, $array)->isOk();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ chooseDocumentFor()

ILIAS\LegalDocuments\Provide\ProvideDocument::chooseDocumentFor ( ilObjUser $user )

Definition at line 92 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Provide\ProvideDocument\documentMatches(), and ILIAS\LegalDocuments\Provide\ProvideDocument\find().

Referenced by ILIAS\LegalDocuments\test\Provide\ProvideDocumentTest\testChooseDocumentFor().

                                                       : Result
     {
         return $this->find(
             fn(Document $document): bool => $this->documentMatches($document, $user),
             $this->document_repository->all()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ conditionGroups()

ILIAS\LegalDocuments\Provide\ProvideDocument::conditionGroups ( ?CriterionContent $criterion = null )

Returns: SelectionMap<Group>

Definition at line 126 of file ProvideDocument.php.

References ILIAS\LTI\ToolProvider\$key, ILIAS\LegalDocuments\SelectionMap\choices(), and ILIAS\LegalDocuments\ConditionDefinition\formGroup().

                                                                         : SelectionMap
     {
         $selected = $criterion ? [
             $criterion->type() => $criterion->arguments()
         ] : [];
 
         $choices = $this->conditions->choices();
         $groups = array_combine(array_keys($choices), array_map(
             fn(ConditionDefinition $condition, string $key) => $condition->formGroup($selected[$key] ?? []),
             array_values($choices),
             array_keys($choices)
         ));
 
         return new SelectionMap($groups, $this->conditions->defaultSelection());
     }

Here is the call graph for this function:

◆ contentAsComponent()

ILIAS\LegalDocuments\Provide\ProvideDocument::contentAsComponent ( DocumentContent $content )

Definition at line 154 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Value\DocumentContent\type().

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\table().

                                                                 : Component
     {
         return $this->content_as_component[$content->type()]($content);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ documentMatches()

ILIAS\LegalDocuments\Provide\ProvideDocument::documentMatches	(	Document	$document,
		ilObjUser	$user
	)

Definition at line 100 of file ProvideDocument.php.

References Vendor\Package\$c, ILIAS\LegalDocuments\Provide\ProvideDocument\all(), ILIAS\LegalDocuments\Value\Document\criteria(), and ILIAS\LegalDocuments\Provide\ProvideDocument\toCondition().

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\chooseDocumentFor().

                                                                         : bool
     {
         return $this->all(
             fn($c) => $this->toCondition($c->content())->eval($user),
             $document->criteria()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ find()

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

private

A

Parameters

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

Returns: Result

Definition at line 180 of file ProvideDocument.php.

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\any(), and ILIAS\LegalDocuments\Provide\ProvideDocument\chooseDocumentFor().

                                                            : Result
     {
         foreach ($array as $x) {
             if ($predicate($x)) {
                 return new Ok($x);
             }
         }
 
         return new Error('Not found.');
     }

Here is the caller graph for this function:

◆ hash()

ILIAS\LegalDocuments\Provide\ProvideDocument::hash ( )

Definition at line 113 of file ProvideDocument.php.

                           : string
     {
         return bin2hex(openssl_random_pseudo_bytes((int) floor(255 / 2)));
     }

◆ repository()

ILIAS\LegalDocuments\Provide\ProvideDocument::repository ( )

Definition at line 108 of file ProvideDocument.php.

Referenced by ILIAS\LegalDocuments\SlotConstructor\history().

                                 : DocumentRepository
     {
         return $this->document_repository;
     }

Here is the caller graph for this function:

◆ table()

ILIAS\LegalDocuments\Provide\ProvideDocument::table	(	object	$gui,
		string	$command,
		?EditLinks	$edit_links = `null`
	)

Definition at line 74 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Provide\ProvideDocument\$create_table_gui, ILIAS\LegalDocuments\Provide\ProvideDocument\contentAsComponent(), and ILIAS\LegalDocuments\Provide\ProvideDocument\toCondition().

                                                                                       : Component
     {
         $t = new DocumentTable(
             fn($criterion) => $this->toCondition($criterion)->asComponent(),
             $this->document_repository,
             new UI($this->id, $this->container->ui(), $this->container->language()),
             new DocumentModal($this->container->ui(), $this->contentAsComponent(...))
         );
 
         if ($edit_links !== null) {
             $t = new EditableDocumentTable($t, $edit_links);
         }
 
         $table = ($this->create_table_gui)($gui, $command, $t);
 
         return $this->container->ui()->factory()->legacy($table->getHTML());
     }

Here is the call graph for this function:

◆ toCondition()

ILIAS\LegalDocuments\Provide\ProvideDocument::toCondition ( CriterionContent $content )

Definition at line 118 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Value\CriterionContent\type().

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\documentMatches(), ILIAS\LegalDocuments\Provide\ProvideDocument\table(), and ILIAS\LegalDocuments\Provide\ProvideDocument\validateAgainst().

                                                           : Condition
     {
         return $this->conditions->choices()[$content->type()]->withCriterion($content);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateAgainst()

ILIAS\LegalDocuments\Provide\ProvideDocument::validateAgainst	(	Result	$b,
		Criterion	$a
	)

private

Definition at line 159 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Value\Criterion\content(), ILIAS\Data\Result\then(), and ILIAS\LegalDocuments\Provide\ProvideDocument\toCondition().

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\validateCriteriaContent().

                                                              : Result
     {
         return $b->then(function (CriterionContent $b) use ($a) {
             $a = $a->content();
             if ($a->equals($b)) {
                 return new Error(self::CRITERION_ALREADY_EXISTS);
             }
             $a = $this->toCondition($a);
             if ($a->knownToNeverMatchWith($this->toCondition($b))) {
                 return new Error(self::CRITERION_WOULD_NEVER_MATCH);
             }
             return new Ok($b);
         });
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateCriteriaContent()

ILIAS\LegalDocuments\Provide\ProvideDocument::validateCriteriaContent	(	array	$criteria,
		CriterionContent	$content
	)

Parameters

list<Criterion> $criteria

Definition at line 145 of file ProvideDocument.php.

References ILIAS\LegalDocuments\Provide\ProvideDocument\validateAgainst().

                                                                                        : Result
     {
         return array_reduce(
             $criteria,
             $this->validateAgainst(...),
             new Ok($content)
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $create_table_gui

readonly Closure ILIAS\LegalDocuments\Provide\ProvideDocument::$create_table_gui

private

Definition at line 56 of file ProvideDocument.php.

Referenced by ILIAS\LegalDocuments\Provide\ProvideDocument\table().

◆ CRITERION_ALREADY_EXISTS

const ILIAS\LegalDocuments\Provide\ProvideDocument::CRITERION_ALREADY_EXISTS = 'Criterion already exists.'

Definition at line 52 of file ProvideDocument.php.

Referenced by ILIAS\LegalDocuments\test\Provide\ProvideDocumentTest\testDuplicateCriteriaContent().

◆ CRITERION_WOULD_NEVER_MATCH

const ILIAS\LegalDocuments\Provide\ProvideDocument::CRITERION_WOULD_NEVER_MATCH = 'Criterion would never match.'

Definition at line 53 of file ProvideDocument.php.

Referenced by ILIAS\LegalDocuments\test\Provide\ProvideDocumentTest\testNeverMatchingCriteriaContent().

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

Services/LegalDocuments/classes/Provide/ProvideDocument.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ all()

◆ any()

◆ chooseDocumentFor()

◆ conditionGroups()

◆ contentAsComponent()

◆ documentMatches()

◆ find()

◆ hash()

◆ repository()

◆ table()

◆ toCondition()

◆ validateAgainst()

◆ validateCriteriaContent()

Field Documentation

◆ $create_table_gui

◆ CRITERION_ALREADY_EXISTS

◆ CRITERION_WOULD_NEVER_MATCH