ILIAS\StaticURL\Context Class Reference

Collaboration diagram for ILIAS\StaticURL\Context:

Public Member Functions
	__construct (private Container $container)
	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

Author

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

Definition at line 29 of file Context.php.

Constructor & Destructor Documentation

__construct()

ILIAS\StaticURL\Context::__construct

(

private Container

$container

)

Definition at line 31 of file Context.php.

    {
    }

Member Function Documentation

builder()

ILIAS\StaticURL\Context::builder

(

)

Definition at line 122 of file Context.php.

                             : URIBuilder
    {
        return $this->container['static_url']->builder();
    }

checkPermission()

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

Definition at line 65 of file Context.php.

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

References $ref_id.

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

Here is the caller graph for this function:

ctrl()

ILIAS\StaticURL\Context::ctrl

(

)

Definition at line 60 of file Context.php.

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

Referenced by ILIAS\User\StaticURLHandler\buildDeleteUsrUrl(), 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\StaticURL\Handler\LegacyGotoHandler\handle(), ilKSDocumentationGotoLink\handle(), and ILIAS\User\StaticURLHandler\handle().

Here is the caller graph for this function:

exists()

ILIAS\StaticURL\Context::exists

(

int

$ref_id

)

Definition at line 75 of file Context.php.

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

References $ref_id.

findFirstAccessibleParentRefId()

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

Definition at line 80 of file Context.php.

                                                                                            : ?int
    {
        $tree = $this->container->repositoryTree();
        if ($ref_id <= 0 || !$tree->isInTree($ref_id)) {
            return null;
        }
 
        $root_id = $tree->getRootId();
        $current = $ref_id;
        $visited = [];
        while (($parent = (int) $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 $ref_id, and ILIAS\StaticURL\Context\checkPermission().

Here is the call graph for this function:

getParentRefId()

ILIAS\StaticURL\Context::getParentRefId

(

int

$ref_id

)

Definition at line 70 of file Context.php.

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

References $ref_id.

getUserId()

ILIAS\StaticURL\Context::getUserId

(

)

Definition at line 107 of file Context.php.

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

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

Here is the caller graph for this function:

getUserLanguage()

ILIAS\StaticURL\Context::getUserLanguage

(

)

Definition at line 35 of file Context.php.

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

http()

ILIAS\StaticURL\Context::http

(

)

Definition at line 55 of file Context.php.

                          : Services
    {
        return $this->container->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 117 of file Context.php.

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

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

Here is the caller graph for this function:

isUserLoggedIn()

ILIAS\StaticURL\Context::isUserLoggedIn

(

)

Definition at line 112 of file Context.php.

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

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

Here is the caller graph for this function:

lng()

ILIAS\StaticURL\Context::lng

(

)

Definition at line 45 of file Context.php.

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

mainTemplate()

ILIAS\StaticURL\Context::mainTemplate

(

)

Definition at line 50 of file Context.php.

                                  : \ilGlobalTemplateInterface
    {
        return $this->container->ui()->mainTemplate();
    }

refinery()

ILIAS\StaticURL\Context::refinery

(

)

Definition at line 40 of file Context.php.

                              : Factory
    {
        return $this->container->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