Collaboration diagram for ILIAS\LegalDocuments\Conductor:

Public Member Functions
	__construct (private readonly Container $container, ?Internal $internal=null, ?Routing $routing=null)

	provide (string $id)

	loginPageHTML (string $id)

	logoutText ()

	logoutTarget (LogoutTarget $target)

	modifyFooter (Closure $footer)

	agree (string $gui, string $cmd)

	agreeContent (string $gui, string $cmd)

	withdraw (string $gui, string $cmd)

	usersWithHiddenOnlineStatus (array $users)

	userCanReadInternalMail ()

	canUseSoapApi ()

	afterLogin ()

	findGotoLink (string $goto_target)

	intercepting ()

	selfRegistration ()

	userManagementFields (ilObjUser $user)

	userManagementModals ()

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

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

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

	byQueryParams (string $gui, string $cmd, string $key)

	renderPageFragment (string $gui, string $cmd)

	setMainTemplateContent (string $content)

	createInternal ()

Private Attributes
readonly Internal	$internal

readonly Routing	$routing

array	$modals = []

Detailed Description

Definition at line 46 of file Conductor.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\LegalDocuments\Conductor::__construct	(	private readonly Container	$container,
		?Internal	$internal = `null`,
		?Routing	$routing = `null`
	)

Definition at line 54 of file Conductor.php.

      {
        $this->internal = $internal ?? $this->createInternal();
        $this->routing = $routing ?? new Routing(
            $this->container->ctrl(),
            new SelectSetting(new SessionStore(), new Marshal($this->container->refinery())),
            ilInitialisation::redirectToStartingPage(...),
            ilStartUpGUI::logoutUrl(...)
        );
    }

References ILIAS\LegalDocuments\Conductor\$routing, ILIAS\LegalDocuments\Conductor\createInternal(), ilStartUpGUI\logoutUrl(), and ilInitialisation\redirectToStartingPage().

Here is the call graph for this function:

Member Function Documentation

◆ afterLogin()

ILIAS\LegalDocuments\Conductor::afterLogin ( )

Definition at line 161 of file Conductor.php.

                                : void
    {
        array_map(fn($proc) => $proc(), $this->internal->all('after-login'));
    }

◆ agree()

ILIAS\LegalDocuments\Conductor::agree	(	string	$gui,
		string	$cmd
	)

Definition at line 112 of file Conductor.php.

                                                   : void
    {
        $this->setMainTemplateContent($this->agreeContent($gui, $cmd));
    }

References ILIAS\LegalDocuments\Conductor\agreeContent(), and ILIAS\LegalDocuments\Conductor\setMainTemplateContent().

Here is the call graph for this function:

◆ agreeContent()

ILIAS\LegalDocuments\Conductor::agreeContent	(	string	$gui,
		string	$cmd
	)

Definition at line 117 of file Conductor.php.

                                                          : string
    {
        $key = ilLegalDocumentsAgreementGUI::class === $gui ? 'agreement-form' : 'public-page';
        $result = $this->byQueryParams($gui, $cmd, $key)->then($this->renderPageFragment($gui, $cmd));
 
        if (!$result->isOk() && $result->error() === 'Not available.') {
            $this->routing->redirectToOriginalTarget();
        }
 
        return $result->value();
    }

References ILIAS\LegalDocuments\Conductor\byQueryParams(), and ILIAS\LegalDocuments\Conductor\renderPageFragment().

Referenced by ILIAS\LegalDocuments\Conductor\agree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ all()

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

private

@template A

Parameters

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

Definition at line 255 of file Conductor.php.

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

References ILIAS\LegalDocuments\Conductor\any().

Here is the call graph for this function:

◆ any()

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

private

@template A

Parameters

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

Definition at line 245 of file Conductor.php.

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

References ILIAS\LegalDocuments\Conductor\find().

Referenced by ILIAS\LegalDocuments\Conductor\all().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ byQueryParams()

ILIAS\LegalDocuments\Conductor::byQueryParams	(	string	$gui,
		string	$cmd,
		string	$key
	)

private

Definition at line 260 of file Conductor.php.

                                                                         : Result
    {
        try {
            $id = $this->container->http()->wrapper()->query()->retrieve('id', $this->container->refinery()->to()->string());
        } catch (Exception) {
            return new Error('No provider ID given.');
        }
 
        $this->container->ctrl()->setParameterByClass($gui, 'id', $id);
 
        $value = $this->internal->get($key, $id);
 
        if (null === $value) {
            return new Error('Field not defined.');
        }
 
        return new Ok($value);
    }

References $id.

Referenced by ILIAS\LegalDocuments\Conductor\agreeContent(), and ILIAS\LegalDocuments\Conductor\withdraw().

Here is the caller graph for this function:

◆ canUseSoapApi()

ILIAS\LegalDocuments\Conductor::canUseSoapApi ( )

Definition at line 156 of file Conductor.php.

                                   : Transformation
    {
        return $this->container->refinery()->in()->series(array_values($this->internal->all('use-soap-api')));
    }

◆ createInternal()

ILIAS\LegalDocuments\Conductor::createInternal ( )

private

Definition at line 295 of file Conductor.php.

                                     : Internal
    {
        $clock = (new DataFactory())->clock()->system();
        $action = new UserAction($this->container->user(), $clock);
 
        return new Internal($this->provide(...), fn(string $id) => new Wiring(new SlotConstructor(
            $id,
            $this->container,
            $action
        )));
    }

References $id, and ILIAS\LegalDocuments\Conductor\provide().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ find()

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

private

@template A

Parameters

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

Returns: Result

Definition at line 229 of file Conductor.php.

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

Referenced by ILIAS\LegalDocuments\Conductor\any(), ILIAS\LegalDocuments\Conductor\findGotoLink(), and ILIAS\LegalDocuments\Conductor\userManagementFields().

Here is the caller graph for this function:

◆ findGotoLink()

ILIAS\LegalDocuments\Conductor::findGotoLink ( string $goto_target )

Returns: Result<Target>

Definition at line 169 of file Conductor.php.

                                                     : Result
    {
        return $this->find(
            fn($goto_link) => $goto_link->name() === $goto_target,
            $this->internal->all('goto')
        )->map(fn($goto_link) => $goto_link->target());
    }

References ILIAS\LegalDocuments\Conductor\find().

Here is the call graph for this function:

◆ intercepting()

ILIAS\LegalDocuments\Conductor::intercepting ( )

Returns: list<Intercept>

Definition at line 180 of file Conductor.php.

                                  : array
    {
        return $this->internal->all('intercept');
    }

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

Here is the caller graph for this function:

◆ loginPageHTML()

ILIAS\LegalDocuments\Conductor::loginPageHTML ( string $id )

Definition at line 73 of file Conductor.php.

                                             : string
    {
        $create = $this->internal->get('show-on-login-page', $id);
        if (!$create) {
            return '';
        }
        return $this->container->ui()->renderer()->render($create());
    }

◆ logoutTarget()

ILIAS\LegalDocuments\Conductor::logoutTarget ( LogoutTarget $target )

Definition at line 98 of file Conductor.php.

                                                      : LogoutTarget
    {
        return new WithdrawalAcknowledgementLogoutTarget(
            $target,
            $this->container->http()->wrapper()->query()->has('withdraw_consent'),
            $this->container->ctrl()
        );
    }

◆ logoutText()

ILIAS\LegalDocuments\Conductor::logoutText ( )

Definition at line 82 of file Conductor.php.

                                : string
    {
        try {
            $id = $this->container->http()->wrapper()->query()->retrieve(
                'withdraw_consent',
                $this->container->refinery()->to()->string()
            );
        } catch (Exception) {
            return '';
        }
 
        $logout_text = $this->internal->get('logout-text', $id);
 
        return null === $logout_text ? '' : $this->container->ui()->renderer()->render($logout_text());
    }

References $id.

◆ modifyFooter()

ILIAS\LegalDocuments\Conductor::modifyFooter ( Closure $footer )

Definition at line 107 of file Conductor.php.

                                                 : Closure
    {
        return array_reduce($this->internal->all('footer'), fn(Closure $footer, Closure $proc) => $proc($footer), $footer);
    }

◆ provide()

ILIAS\LegalDocuments\Conductor::provide ( string $id )

Definition at line 68 of file Conductor.php.

                                       : Provide
    {
        return new Provide($id, $this->internal, $this->container);
    }

References $id.

Referenced by ILIAS\LegalDocuments\Conductor\createInternal().

Here is the caller graph for this function:

◆ renderPageFragment()

ILIAS\LegalDocuments\Conductor::renderPageFragment	(	string	$gui,
		string	$cmd
	)

private

Returns: Closure(Closure(string, string): Result<PageFragment>): Result<string>

Definition at line 282 of file Conductor.php.

                                                                 : Closure
    {
        return fn(Closure $proc) => $proc($gui, $cmd)->map(fn($fragment) => $fragment->render(
            $this->container->ui()->mainTemplate(),
            $this->container->ui()->renderer()
        ));
    }

Referenced by ILIAS\LegalDocuments\Conductor\agreeContent(), and ILIAS\LegalDocuments\Conductor\withdraw().

Here is the caller graph for this function:

◆ selfRegistration()

ILIAS\LegalDocuments\Conductor::selfRegistration ( )

Definition at line 185 of file Conductor.php.

                                      : SelfRegistration
    {
        return new Bundle($this->internal->all('self-registration'));
    }

◆ setMainTemplateContent()

ILIAS\LegalDocuments\Conductor::setMainTemplateContent ( string $content )

private

Definition at line 290 of file Conductor.php.

                                                            : void
    {
        $this->container->ui()->mainTemplate()->setContent($content);
    }

Referenced by ILIAS\LegalDocuments\Conductor\agree(), and ILIAS\LegalDocuments\Conductor\withdraw().

Here is the caller graph for this function:

◆ userCanReadInternalMail()

ILIAS\LegalDocuments\Conductor::userCanReadInternalMail ( )

Definition at line 151 of file Conductor.php.

                                             : Transformation
    {
        return $this->container->refinery()->in()->series(array_values($this->internal->all('constrain-internal-mail')));
    }

◆ userManagementFields()

ILIAS\LegalDocuments\Conductor::userManagementFields ( ilObjUser $user )

Returns: array<string|int, string>

Definition at line 193 of file Conductor.php.

                                                         : array
    {
        $this->modals = [];
        return array_reduce(
            $this->internal->all('user-management-fields'),
            fn(array $prev, callable $f): array => [
                ...$prev,
                ...array_map(function ($val) {
                    if (is_array($val)) {
                        $this->find(fn($x) => $x instanceof Modal, $val)
                             ->map(fn($modal) => array_push($this->modals, $modal));
                        return $this->find(fn($x) => $x instanceof ilNonEditableValueGUI, $val)->value();
                    }
                    return $val;
                }, $f($user))
            ],
            []
        );
    }

References Vendor\Package\$f, and ILIAS\LegalDocuments\Conductor\find().

Here is the call graph for this function:

◆ userManagementModals()

ILIAS\LegalDocuments\Conductor::userManagementModals ( )

Definition at line 213 of file Conductor.php.

                                          : string
    {
        $string = $this->container->ui()->renderer()->render($this->modals);
        $this->modals = [];
 
        return $string;
    }

◆ usersWithHiddenOnlineStatus()

ILIAS\LegalDocuments\Conductor::usersWithHiddenOnlineStatus ( array $users )

Parameters

list<int> $users

Returns: list<int>

Definition at line 138 of file Conductor.php.

                                                             : array
    {
        $filters = $this->internal->all('filter-online-users');
 
        $visible_users = array_reduce(
            $filters,
            fn($users, $only_visible_users) => $only_visible_users($users),
            $users,
        );
 
        return array_values(array_diff($users, $visible_users));
    }

◆ withdraw()

ILIAS\LegalDocuments\Conductor::withdraw	(	string	$gui,
		string	$cmd
	)

Definition at line 129 of file Conductor.php.

                                                      : void
    {
        $this->setMainTemplateContent($this->byQueryParams($gui, $cmd, 'withdraw')->then($this->renderPageFragment($gui, $cmd))->value());
    }

References ILIAS\LegalDocuments\Conductor\byQueryParams(), ILIAS\LegalDocuments\Conductor\renderPageFragment(), and ILIAS\LegalDocuments\Conductor\setMainTemplateContent().

Here is the call graph for this function:

Field Documentation

◆ $internal

readonly Internal ILIAS\LegalDocuments\Conductor::$internal

private

Definition at line 48 of file Conductor.php.

◆ $modals

array ILIAS\LegalDocuments\Conductor::$modals = []

private

Definition at line 52 of file Conductor.php.

◆ $routing

readonly Routing ILIAS\LegalDocuments\Conductor::$routing

private

Definition at line 49 of file Conductor.php.

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

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

components/ILIAS/LegalDocuments/classes/Conductor.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ afterLogin()

◆ agree()

◆ agreeContent()

◆ all()

◆ any()

◆ byQueryParams()

◆ canUseSoapApi()

◆ createInternal()

◆ find()

◆ findGotoLink()

◆ intercepting()

◆ loginPageHTML()

◆ logoutTarget()

◆ logoutText()

◆ modifyFooter()

◆ provide()

◆ renderPageFragment()

◆ selfRegistration()

◆ setMainTemplateContent()

◆ userCanReadInternalMail()

◆ userManagementFields()

◆ userManagementModals()

◆ usersWithHiddenOnlineStatus()

◆ withdraw()

Field Documentation

◆ $internal

◆ $modals

◆ $routing