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,)

	table (object $gui, ?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)
	@template A More...

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

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

Detailed Description

Definition at line 45 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
	)

Parameters

array<string,Closure(CriterionContent) Component $content_as_component

Definition at line 53 of file ProvideDocument.php.

59 {

60 }

Member Function Documentation

◆ all()

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

private

@template A

Parameters

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

Definition at line 197 of file ProvideDocument.php.

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

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

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

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

@template A

Parameters

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

Definition at line 187 of file ProvideDocument.php.

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

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

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

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 83 of file ProvideDocument.php.

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

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

Here is the call graph for this function:

◆ conditionGroups()

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

Returns: SelectionMap<Group>

Definition at line 117 of file ProvideDocument.php.

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

References ILIAS\LegalDocuments\SelectionMap\choices(), and ILIAS\LegalDocuments\ConditionDefinition\formGroup().

Here is the call graph for this function:

◆ contentAsComponent()

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

Definition at line 145 of file ProvideDocument.php.

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

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

Here is the call graph for this function:

◆ documentMatches()

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

Definition at line 91 of file ProvideDocument.php.

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

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

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

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

@template A

Parameters

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

Returns: Result

Definition at line 171 of file ProvideDocument.php.

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

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

Here is the caller graph for this function:

◆ hash()

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

Definition at line 104 of file ProvideDocument.php.

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

◆ repository()

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

Definition at line 99 of file ProvideDocument.php.

                                : DocumentRepository
    {
        return $this->document_repository;
    }

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

Here is the caller graph for this function:

◆ table()

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

Definition at line 62 of file ProvideDocument.php.

                                                                     : DocumentTable
    {
        return 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(...)),
            $gui,
            $edit_links,
            $this->container->http()->request(),
            new Factory(),
            $this->container->ctrl(),
            $this->container->ui()->renderer(),
            $this->container->user()
        );
    }

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

Here is the call graph for this function:

◆ toCondition()

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

Definition at line 109 of file ProvideDocument.php.

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

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

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

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 150 of file ProvideDocument.php.

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

References Vendor\Package\$a, Vendor\Package\$b, and if.

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

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 136 of file ProvideDocument.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ CRITERION_ALREADY_EXISTS

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

Definition at line 47 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 48 of file ProvideDocument.php.

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

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

components/ILIAS/LegalDocuments/classes/Provide/ProvideDocument.php

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ all()

◆ any()

◆ chooseDocumentFor()

◆ conditionGroups()

◆ contentAsComponent()

◆ documentMatches()

◆ find()

◆ hash()

◆ repository()

◆ table()

◆ toCondition()

◆ validateAgainst()

◆ validateCriteriaContent()

Field Documentation

◆ CRITERION_ALREADY_EXISTS

◆ CRITERION_WOULD_NEVER_MATCH