ILIAS\LegalDocuments\Conductor Class Reference

Collaboration diagram for ILIAS\LegalDocuments\Conductor:

Public Member Functions
	__construct (private readonly Container $container, ?Internal $internal=null, Routing $routing=null)
	provide (string $id)
	onLogout (string $gui)
	loginPageHTML (string $id)
	logoutText ()
	modifyFooter (Footer $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)

Private Member Functions
	find (Closure $predicate, array $array)
	A More...
	any (Closure $predicate, array $array)
	A More...
	all (Closure $predicate, array $array)
	A More...
	byQueryParams (string $gui, string $cmd, string $key)
	renderPageFragment (string $gui, string $cmd)
	setMainTemplateContent (string $content)
	createInternal ()
	footerBridge (Footer $footer, array $collection)
	collectFooterItems (array $items)

Private Attributes
readonly Internal	$internal
readonly Routing	$routing

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 51 of file Conductor.php.

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

    {
        $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(...)
        );
    }

Here is the call graph for this function:

Member Function Documentation

afterLogin()

ILIAS\LegalDocuments\Conductor::afterLogin

(

)

Definition at line 158 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 109 of file Conductor.php.

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

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

Here is the call graph for this function:

agreeContent()

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

Definition at line 114 of file Conductor.php.

References ILIAS\LTI\ToolProvider\$key, ILIAS\LegalDocuments\Conductor\byQueryParams(), and ILIAS\LegalDocuments\Conductor\renderPageFragment().

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

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

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

A

Parameters

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

Definition at line 227 of file Conductor.php.

References ILIAS\LegalDocuments\Conductor\any().

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

Here is the call graph for this function:

any()

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

private

A

Parameters

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

Definition at line 217 of file Conductor.php.

References ILIAS\LegalDocuments\Conductor\find().

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

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

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 232 of file Conductor.php.

References Vendor\Package\$e, and $id.

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

                                                                         : Result
    {
        try {
            $id = $this->container->http()->wrapper()->query()->retrieve('id', $this->container->refinery()->to()->string());
        } catch (Exception $e) {
            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);
    }

Here is the caller graph for this function:

canUseSoapApi()

ILIAS\LegalDocuments\Conductor::canUseSoapApi

(

)

Definition at line 153 of file Conductor.php.

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

collectFooterItems()

ILIAS\LegalDocuments\Conductor::collectFooterItems ( array  $items )

private

Definition at line 302 of file Conductor.php.

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

                                                     : Closure
    {
        return function (...$args) use ($items) {
            if ($args === []) {
                return $items;
            }
            return $this->collectFooterItems(array_merge($items, [$args]));
        };
    }

Here is the caller graph for this function:

createInternal()

ILIAS\LegalDocuments\Conductor::createInternal ( )

private

Definition at line 267 of file Conductor.php.

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

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

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

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

A

Parameters

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

Returns

Result

Definition at line 201 of file Conductor.php.

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

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

findGotoLink()

ILIAS\LegalDocuments\Conductor::findGotoLink

(

string

$goto_target

)

Returns

Result<Target>

Definition at line 166 of file Conductor.php.

References ILIAS\LegalDocuments\Conductor\find().

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

Here is the call graph for this function:

footerBridge()

ILIAS\LegalDocuments\Conductor::footerBridge ( Footer  $footer, array  $collection  )

private

Definition at line 279 of file Conductor.php.

References Vendor\Package\$f, $id, ILIAS\UI\Component\MainControls\Footer\getLinks(), ILIAS\UI\Component\MainControls\Footer\getModals(), ILIAS\UI\Component\MainControls\Footer\getPermanentURL(), ILIAS\UI\Component\MainControls\Footer\getText(), and ILIAS\UI\Component\MainControls\Footer\withAdditionalModalAndTrigger().

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

                                                                    : Footer
    {
        $new_links = [];
        $add_item = function (string $id, string $title, object $obj) use (&$footer, &$new_links): void {
            if ($obj instanceof Modal) {
                $footer = $footer->withAdditionalModalAndTrigger($obj, $this->container->ui()->factory()->button()->shy($title, ''));
            } else {
                $new_links[] = $this->container->ui()->factory()->link()->standard($title, (string) $obj);
            }
        };

        foreach ($collection as $args) {
            $add_item(...$args);
        }

        $old_links = $footer->getLinks();
        $modals = $footer->getModals();
        $new_footer = $this->container->ui()->factory()->mainControls()->footer(array_merge($old_links, $new_links), $footer->getText());
        $new_footer = $footer->getPermanentURL() ? $new_footer->withPermanentURL($footer->getPermanentURL()) : $new_footer;

        return array_reduce($modals, static fn(Footer $f, array $m) => $f->withAdditionalModalAndTrigger(...$m), $new_footer);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

intercepting()

ILIAS\LegalDocuments\Conductor::intercepting

(

)

Definition at line 174 of file Conductor.php.

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

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

Here is the caller graph for this function:

loginPageHTML()

ILIAS\LegalDocuments\Conductor::loginPageHTML

(

string

$id

)

Definition at line 82 of file Conductor.php.

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

logoutText()

ILIAS\LegalDocuments\Conductor::logoutText

(

)

Definition at line 91 of file Conductor.php.

References Vendor\Package\$e, and $id.

                                : string
    {
        try {
            $id = $this->container->http()->wrapper()->query()->retrieve('withdraw_from', $this->container->refinery()->to()->string());
        } catch (Exception $e) {
            return '';
        }

        $logout_text = $this->internal->get('logout-text', $id);

        return null === $logout_text ? '' : $this->container->ui()->renderer()->render($logout_text());
    }

modifyFooter()

ILIAS\LegalDocuments\Conductor::modifyFooter

(

Footer

$footer

)

Definition at line 104 of file Conductor.php.

References ILIAS\LegalDocuments\Conductor\collectFooterItems(), and ILIAS\LegalDocuments\Conductor\footerBridge().

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

Here is the call graph for this function:

onLogout()

ILIAS\LegalDocuments\Conductor::onLogout

(

string

$gui

)

Definition at line 67 of file Conductor.php.

References Vendor\Package\$e, and $id.

                                         : void
    {
        try {
            $id = $this->container->http()->wrapper()->query()->retrieve('withdraw_consent', $this->container->refinery()->to()->string());
        } catch (Exception $e) {
            return;
        }

        $logout = $this->internal->get('logout', $id);
        if (null !== $logout) {
            $this->container->ctrl()->setParameterByClass($gui, 'withdraw_from', $id);
            $logout();
        }
    }

provide()

ILIAS\LegalDocuments\Conductor::provide

(

string

$id

)

Definition at line 62 of file Conductor.php.

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

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

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 254 of file Conductor.php.

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

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

Here is the caller graph for this function:

selfRegistration()

ILIAS\LegalDocuments\Conductor::selfRegistration

(

)

Definition at line 179 of file Conductor.php.

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

setMainTemplateContent()

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

private

Definition at line 262 of file Conductor.php.

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

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

Here is the caller graph for this function:

userCanReadInternalMail()

ILIAS\LegalDocuments\Conductor::userCanReadInternalMail

(

)

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

)

Definition at line 184 of file Conductor.php.

References Vendor\Package\$f.

                                                         : array
    {
        return array_reduce(
            $this->internal->all('user-management-fields'),
            static fn(array $prev, callable $f): array => [...$prev, ...$f($user)],
            []
        );
    }

usersWithHiddenOnlineStatus()

ILIAS\LegalDocuments\Conductor::usersWithHiddenOnlineStatus

(

array

$users

)

Parameters

list<int>

$users

Returns

list<int>

Definition at line 135 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 126 of file Conductor.php.

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

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

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.

$routing

readonly Routing ILIAS\LegalDocuments\Conductor::$routing

private

Definition at line 49 of file Conductor.php.

---

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

• Services/LegalDocuments/classes/Conductor.php