ILIAS\StaticURL\Context Class Reference

What a {. More...

Collaboration diagram for ILIAS\StaticURL\Context:

Public Member Functions
	__construct (private readonly GlobalHttpState $http, private readonly Factory $refinery, private readonly Access $access, private readonly URIBuilder $builder, private readonly UserProxy $user, private readonly RepositoryTreeProxy $tree, private readonly LanguageProxy $language, private readonly MainTemplateProxy $main_template, private readonly CtrlProxy $ctrl, private readonly SettingsProxy $settings,)
	getUserLanguage ()
	refinery ()
	lng ()
	mainTemplate ()
	http ()
	ctrl ()
	checkPermission (string $permission, int $ref_id)
	getParentRefId (int $ref_id)
	exists (int $ref_id)
	findFirstAccessibleParentRefId (int $ref_id, string $permission='read')
	getUserId ()
	isUserLoggedIn ()
	isPublicSectionActive ()
	builder ()

Detailed Description

What a {.

See also

\ILIAS\StaticURL\Handler\Handler} may reach out to while it resolves a static URL.

Services that are wired through the component bootstrap are injected as themselves. Everything else still lives in the legacy container and is named by a dedicated proxy, so this class states its dependencies instead of holding a container that can produce anything.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 43 of file Context.php.

Constructor & Destructor Documentation

__construct()

ILIAS\StaticURL\Context::__construct	(	private readonly GlobalHttpState	$http,
		private readonly Factory	$refinery,
		private readonly Access	$access,
		private readonly URIBuilder	$builder,
		private readonly UserProxy	$user,
		private readonly RepositoryTreeProxy	$tree,
		private readonly LanguageProxy	$language,
		private readonly MainTemplateProxy	$main_template,
		private readonly CtrlProxy	$ctrl,
		private readonly SettingsProxy	$settings
	)

Definition at line 45 of file Context.php.

      {
    }

Member Function Documentation

builder()

ILIAS\StaticURL\Context::builder

(

)

Definition at line 145 of file Context.php.

                             : URIBuilder
    {
        return $this->builder;
    }

checkPermission()

ILIAS\StaticURL\Context::checkPermission	(	string	$permission,
		int	$ref_id
	)

Definition at line 89 of file Context.php.

                                                                    : bool
    {
        return $this->access->checkAccess($permission, '', $ref_id);
    }

References ILIAS\Repository\access().

Referenced by ILIAS\StaticURL\Context\findFirstAccessibleParentRefId(), ILIAS\Exercise\PermanentLink\StaticURLHandler\handle(), and ILIAS\Export\ExportHandler\StaticUrlHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

ctrl()

ILIAS\StaticURL\Context::ctrl

(

)

Definition at line 84 of file Context.php.

                          : \ilCtrlInterface
    {
        return $this->ctrl->get();
    }

References ILIAS\StaticURL\Context\ctrl().

Referenced by ILIAS\User\StaticURLHandler\buildDeleteUsrUrl(), ILIAS\StaticURL\Context\ctrl(), ILIAS\Badge\URL\StaticUrlHandler\handle(), ILIAS\Calendar\URL\CalendarStaticURLHandler\handle(), ILIAS\Certificate\StaticUrlHandler\handle(), ILIAS\Contact\URL\StaticUrlHandler\handle(), ILIAS\Exercise\PermanentLink\StaticURLHandler\handle(), ILIAS\Export\ExportHandler\StaticUrlHandler\handle(), ILIAS\Init\URL\StaticUrlHandler\handle(), ILIAS\PersonalWorkspace\PermanentLink\StaticUrlHandler\handle(), ILIAS\Registration\URL\StaticUrlHandler\handle(), ILIAS\StaticURL\Handler\LegacyGotoHandler\handle(), ilKSDocumentationGotoLink\handle(), and ILIAS\User\StaticURLHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

exists()

ILIAS\StaticURL\Context::exists

(

int

$ref_id

)

Definition at line 99 of file Context.php.

                                       : bool
    {
        return $this->tree->isInTree($ref_id);
    }

Referenced by ILIAS\Exercise\PermanentLink\StaticURLHandler\handle().

Here is the caller graph for this function:

findFirstAccessibleParentRefId()

ILIAS\StaticURL\Context::findFirstAccessibleParentRefId	(	int	$ref_id,
		string	$permission = 'read'
	)

Definition at line 104 of file Context.php.

                                                                                            : ?int
    {
        if ($ref_id <= 0 || !$this->tree->isInTree($ref_id)) {
            return null;
        }
 
        $root_id = $this->tree->getRootId();
        $current = $ref_id;
        $visited = [];
        while (($parent = (int) $this->tree->getParentId($current)) > 0) {
            if (isset($visited[$parent])) {
                return null;
            }
            $visited[$parent] = true;
            if ($this->checkPermission($permission, $parent)) {
                return $parent;
            }
            if ($parent === $root_id) {
                return null;
            }
            $current = $parent;
        }
 
        return null;
    }

References ILIAS\StaticURL\Context\checkPermission().

Here is the call graph for this function:

getParentRefId()

ILIAS\StaticURL\Context::getParentRefId

(

int

$ref_id

)

Definition at line 94 of file Context.php.

                                               : ?int
    {
        return $this->tree->getParentId($ref_id);
    }

getUserId()

ILIAS\StaticURL\Context::getUserId

(

)

Definition at line 130 of file Context.php.

                               : int
    {
        return $this->user->getId();
    }

References ILIAS\Repository\user().

Referenced by ILIAS\Export\ExportHandler\StaticUrlHandler\handle(), and ILIAS\StaticURL\Handler\LegacyGotoHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

getUserLanguage()

ILIAS\StaticURL\Context::getUserLanguage

(

)

Definition at line 59 of file Context.php.

                                     : string
    {
        return $this->user->getCurrentLanguage();
    }

References ILIAS\Repository\user().

Here is the call graph for this function:

http()

ILIAS\StaticURL\Context::http

(

)

Definition at line 79 of file Context.php.

                          : GlobalHttpState
    {
        return $this->http;
    }

References ILIAS\BookingManager\Common\Table\$http.

Referenced by ILIAS\StaticURL\Handler\HandlerService\appendUnknownParameters(), ilFileStaticURLHandler\handle(), and ILIAS\StaticURL\Shortlinks\Handler\handle().

Here is the caller graph for this function:

isPublicSectionActive()

ILIAS\StaticURL\Context::isPublicSectionActive

(

)

Definition at line 140 of file Context.php.

                                           : bool
    {
        return (bool) $this->settings->get('pub_section');
    }

References ILIAS\Repository\settings().

Referenced by ILIAS\Export\ExportHandler\StaticUrlHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

isUserLoggedIn()

ILIAS\StaticURL\Context::isUserLoggedIn

(

)

Definition at line 135 of file Context.php.

                                    : bool
    {
        return !$this->user->isAnonymous() && $this->user->getId() !== 0;
    }

References ILIAS\Repository\user().

Referenced by ILIAS\Badge\URL\StaticUrlHandler\handle(), ILIAS\Certificate\StaticUrlHandler\handle(), ILIAS\Contact\URL\StaticUrlHandler\handle(), ILIAS\Exercise\PermanentLink\StaticURLHandler\handle(), ILIAS\Export\ExportHandler\StaticUrlHandler\handle(), and ILIAS\User\StaticURLHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

lng()

ILIAS\StaticURL\Context::lng

(

)

Definition at line 69 of file Context.php.

                         : \ilLanguage
    {
        return $this->language->get();
    }

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

mainTemplate()

ILIAS\StaticURL\Context::mainTemplate

(

)

Definition at line 74 of file Context.php.

                                  : \ilGlobalTemplateInterface
    {
        return $this->main_template->get();
    }

References ILIAS\UICore\GlobalTemplate\get().

Here is the call graph for this function:

refinery()

ILIAS\StaticURL\Context::refinery

(

)

Definition at line 64 of file Context.php.

                              : Factory
    {
        return $this->refinery;
    }

References ILIAS\UI\examples\Layout\Page\Mail\$refinery.

Referenced by ILIAS\StaticURL\Handler\HandlerService\appendUnknownParameters().

Here is the caller graph for this function:

---

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

• components/ILIAS/StaticURL/src/Context.php