Inheritance diagram for ILIAS\LegalDocuments\Wiring:

Collaboration diagram for ILIAS\LegalDocuments\Wiring:

Public Member Functions
	__construct (private readonly SlotConstructor $slot, Map $map=null)

	afterLogin (callable $after_login)

	showInFooter (callable $show)

	canWithdraw (WithdrawProcess $withdraw_process)

	showOnLoginPage (callable $show)

	hasPublicPage (callable $public_page, ?string $goto_name=null)

	hasAgreement (Agreement $on_login, ?string $goto_name=null)

	hasHistory ()

	onSelfRegistration (SelfRegistration $self_registration)

	hasOnlineStatusFilter (callable $only_visible_users)

	canReadInternalMails (Constraint $constraint)

	canUseSoapApi (Constraint $constraint)

	hasDocuments (array $content_as_component=[], ?SelectionMap $available_conditions=null)

	hasUserManagementFields (callable $field_value)

	hasPublicApi (PublicApi $api)

	map ()

Private Member Functions
	error (string $message)

	addTo (string $name, $id_or_value, $value=null)

	protect (Closure $to_be_protected, Closure $protector)
	A B More...

	path (string $class)

Private Attributes
readonly Map	$map

Detailed Description

Definition at line 44 of file Wiring.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LegalDocuments\Wiring::__construct	(	private readonly SlotConstructor	$slot,
		Map	$map = `null`
	)

Definition at line 48 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\map().

     {
         $this->map = $map ?? new Map();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addTo()

ILIAS\LegalDocuments\Wiring::addTo	(	string	$name,
			$id_or_value,
			$value = `null`
	)

private

Definition at line 156 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\$map, and ILIAS\LegalDocuments\Wiring\map().

                                                                      : self
     {
         $map = $this->map;
         if ($value !== null) {
             if ($this->map->has($name, $id_or_value)) {
                 throw new Exception('Duplicated entry. Key ' . $id_or_value . ' already exists for ' . $name);
             }
             $map = $map->set($name, $id_or_value, $value);
         } else {
             $map = $map->add($name, $id_or_value);
         }
 
         return new self($this->slot, $map);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterLogin()

ILIAS\LegalDocuments\Wiring::afterLogin ( callable $after_login )

Parameters

callable() void $after_login

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 53 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                      : self
     {
         return $this->addTo('after-login', Closure::fromCallable($after_login));
     }

Here is the call graph for this function:

◆ canReadInternalMails()

ILIAS\LegalDocuments\Wiring::canReadInternalMails ( Constraint $constraint )

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 116 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                                 : self
     {
         return $this->addTo('constrain-internal-mail', $constraint);
     }

Here is the call graph for this function:

◆ canUseSoapApi()

ILIAS\LegalDocuments\Wiring::canUseSoapApi ( Constraint $constraint )

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 121 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                          : self
     {
         return $this->addTo('use-soap-api', $constraint);
     }

Here is the call graph for this function:

◆ canWithdraw()

ILIAS\LegalDocuments\Wiring::canWithdraw ( WithdrawProcess $withdraw_process )

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 63 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo(), ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess\isOnGoing(), ILIAS\LegalDocuments\Wiring\path(), ILIAS\LegalDocuments\Wiring\protect(), ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess\showValidatePasswordMessage(), ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess\showWithdraw(), and ILIAS\LegalDocuments\ConsumerSlots\WithdrawProcess\withdrawalFinished().

                                                                   : self
     {
         $withdraw = $this->protect($withdraw_process->showWithdraw(...), $withdraw_process->isOnGoing(...));
 
         return $this->addTo('withdraw', $this->slot->id(), $withdraw)
                     ->addTo('intercept', new ConditionalIntercept($withdraw_process->isOnGoing(...), $this->slot->id(), new Target($this->path(ilLegalDocumentsWithdrawalGUI::class))))
                     ->addTo('logout-text', $this->slot->id(), $withdraw_process->showValidatePasswordMessage(...))
                     ->addTo('show-on-login-page', $this->slot->withdrawalFinished($withdraw_process->withdrawalFinished(...)));
     }

Here is the call graph for this function:

◆ error()

ILIAS\LegalDocuments\Wiring::error ( string $message )

private

Definition at line 151 of file Wiring.php.

Referenced by ILIAS\LegalDocuments\Wiring\hasHistory().

                                            : void
     {
         throw new Exception($message);
     }

Here is the caller graph for this function:

◆ hasAgreement()

ILIAS\LegalDocuments\Wiring::hasAgreement	(	Agreement	$on_login,
		?string	$goto_name = `null`
	)

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 86 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo(), ILIAS\LegalDocuments\ConsumerSlots\Agreement\needsToAgree(), ILIAS\LegalDocuments\Wiring\path(), ILIAS\LegalDocuments\Wiring\protect(), ILIAS\LegalDocuments\ConsumerSlots\Agreement\showAgreement(), and ILIAS\LegalDocuments\ConsumerSlots\Agreement\showAgreementForm().

                                                                                 : self
     {
         $public_target = new Target(ilStartUpGUI::class, 'showLegalDocuments', ['id' => $this->slot->id()]);
         $agreement_target = new Target($this->path(ilLegalDocumentsAgreementGUI::class), '', ['id' => $this->slot->id()]);
 
         $wiring = $this->addTo('public-page', $this->slot->id(), fn(...$args) => new Ok($on_login->showAgreement(...$args)))
                        ->addTo('agreement-form', $this->slot->id(), $this->protect($on_login->showAgreementForm(...), $on_login->needsToAgree(...)))
                        ->addTo('intercept', new ConditionalIntercept($on_login->needsToAgree(...), $this->slot->id(), $agreement_target));
 
         return null === $goto_name ?
                     $wiring :
                     $wiring->addTo('goto', new ConditionalGotoLink($goto_name, fn() => $on_login->needsToAgree() ? $agreement_target : $public_target));
     }

Here is the call graph for this function:

◆ hasDocuments()

ILIAS\LegalDocuments\Wiring::hasDocuments	(	array	$content_as_component = `[]`,
		?SelectionMap	$available_conditions = `null`
	)

Parameters

array<string,callable(DocumentContent)	Component> $content_as_component
null\|SelectionMap<ConditionDefinition>	$available_conditions

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 126 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                                                                               : self
     {
         $available_conditions ??= new SelectionMap();
         $repository = $this->slot->documentRepository();
         $document = $this->slot->document($this->slot->readOnlyDocuments($repository), $available_conditions, $content_as_component);
 
         return $this->addTo('document', $this->slot->id(), $document)
                     ->addTo('writable-document', $this->slot->id(), $this->slot->document($repository, $available_conditions, $content_as_component));
     }

Here is the call graph for this function:

◆ hasHistory()

ILIAS\LegalDocuments\Wiring::hasHistory ( )

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 100 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo(), ILIAS\LegalDocuments\Wiring\error(), and ILIAS\LegalDocuments\Wiring\map().

                                 : self
     {
         $document = $this->map->value()['document'][$this->slot->id()] ?? $this->error('Cannot have a history without documents.');
         return $this->addTo('history', $this->slot->id(), $this->slot->history($document));
     }

Here is the call graph for this function:

◆ hasOnlineStatusFilter()

ILIAS\LegalDocuments\Wiring::hasOnlineStatusFilter ( callable $only_visible_users )

Parameters

callable(int[]) int[] $only_visible_users

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 111 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                                        : self
     {
         return $this->addTo('filter-online-users', $only_visible_users);
     }

Here is the call graph for this function:

◆ hasPublicApi()

ILIAS\LegalDocuments\Wiring::hasPublicApi ( PublicApi $api )

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 141 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                 : self
     {
         return $this->addTo('public-api', $this->slot->id(), $api);
     }

Here is the call graph for this function:

◆ hasPublicPage()

ILIAS\LegalDocuments\Wiring::hasPublicPage	(	callable	$public_page,
		?string	$goto_name = `null`
	)

Parameters

callable(string,string) PageFragment $public_page

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 78 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                                                    : self
     {
         $wiring = $this->addTo('public-page', $this->slot->id(), fn(...$args) => new Ok($public_page(...$args)));
         return null === $goto_name ?
             $wiring :
             $wiring->addTo('goto', new ConditionalGotoLink($goto_name, fn() => new Target(ilStartUpGUI::class, 'showLegalDocuments', ['id' => $this->slot->id()])));
     }

Here is the call graph for this function:

◆ hasUserManagementFields()

ILIAS\LegalDocuments\Wiring::hasUserManagementFields ( callable $fields )

Parameters

callable(ilObjUser) array<string, string|ilNonEditableValueGUI> $fields

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 136 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                                   : self
     {
         return $this->addTo('user-management-fields', $this->slot->id(), $field_value);
     }

Here is the call graph for this function:

◆ map()

ILIAS\LegalDocuments\Wiring::map ( )

Definition at line 146 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\$map.

Referenced by ILIAS\LegalDocuments\Wiring\__construct(), ILIAS\LegalDocuments\Wiring\addTo(), and ILIAS\LegalDocuments\Wiring\hasHistory().

                          : Map
     {
         return $this->map;
     }

Here is the caller graph for this function:

◆ onSelfRegistration()

ILIAS\LegalDocuments\Wiring::onSelfRegistration ( SelfRegistration $self_registration )

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 106 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                                            : self
     {
         return $this->addTo('self-registration', $self_registration);
     }

Here is the call graph for this function:

◆ path()

ILIAS\LegalDocuments\Wiring::path ( string $class )

private

Returns: string[]

Definition at line 187 of file Wiring.php.

Referenced by ILIAS\LegalDocuments\Wiring\canWithdraw(), and ILIAS\LegalDocuments\Wiring\hasAgreement().

                                         : array
     {
         return [ilDashboardGUI::class, ilPersonalProfileGUI::class, $class];
     }

Here is the caller graph for this function:

◆ protect()

ILIAS\LegalDocuments\Wiring::protect	(	Closure	$to_be_protected,
		Closure	$protector
	)

private

A B

Parameters

Closure(A	...): B $to_be_protected
Closure()	bool $protector

Returns: Closure(A ...): Result

Definition at line 179 of file Wiring.php.

Referenced by ILIAS\LegalDocuments\Wiring\canWithdraw(), and ILIAS\LegalDocuments\Wiring\hasAgreement().

                                                                           : Closure
     {
         return static fn(...$args): Result => $protector() ? new Ok($to_be_protected(...$args)) : new Error('Not available.');
     }

Here is the caller graph for this function:

◆ showInFooter()

ILIAS\LegalDocuments\Wiring::showInFooter ( callable $show )

Parameters

callable(Footer) Footer $show

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 58 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                 : self
     {
         return $this->addTo('footer', $this->slot->id(), Closure::fromCallable($show));
     }

Here is the call graph for this function:

◆ showOnLoginPage()

ILIAS\LegalDocuments\Wiring::showOnLoginPage ( callable $show )

Parameters

callable() string $show

Implements ILIAS\LegalDocuments\UseSlot.

Definition at line 73 of file Wiring.php.

References ILIAS\LegalDocuments\Wiring\addTo().

                                                    : self
     {
         return $this->addTo('show-on-login-page', $this->slot->id(), Closure::fromCallable($show));
     }

Here is the call graph for this function:

Field Documentation

◆ $map

readonly Map ILIAS\LegalDocuments\Wiring::$map

private

Definition at line 46 of file Wiring.php.

Referenced by ILIAS\LegalDocuments\Wiring\addTo(), and ILIAS\LegalDocuments\Wiring\map().

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

components/ILIAS/LegalDocuments/classes/Wiring.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addTo()

◆ afterLogin()

◆ canReadInternalMails()

◆ canUseSoapApi()

◆ canWithdraw()

◆ error()

◆ hasAgreement()

◆ hasDocuments()

◆ hasHistory()

◆ hasOnlineStatusFilter()

◆ hasPublicApi()

◆ hasPublicPage()

◆ hasUserManagementFields()

◆ map()

◆ onSelfRegistration()

◆ path()

◆ protect()

◆ showInFooter()

◆ showOnLoginPage()

Field Documentation

◆ $map