ILIAS\StaticURL\Shortlinks\Handler Class Reference

Inheritance diagram for ILIAS\StaticURL\Shortlinks\Handler:

Collaboration diagram for ILIAS\StaticURL\Shortlinks\Handler:

Public Member Functions
	__construct ()
	getNamespace ()
	getNamespaceAliasses ()
	canHandle (Request $request)
	handle (Request $request, Context $context, Factory $response_factory)
	getNamespaceAliasses ()
	__construct ()
	getNamespace ()
	canHandle (Request $request)
	handle (Request $request, Context $context, Factory $response_factory)

Data Fields
const string	SHORTLINK_NAMESPACE = self::NAMESPACE_ALTERNATIVE

Protected Member Functions
	mustShift (ServerRequestInterface $request)

Private Attributes
const string	NAMESPACE_SHORT = 's'
const string	NAMESPACE_LONG = 'shortlink'
const string	NAMESPACE_ALTERNATIVE = 'to'

Detailed Description

Author

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

Definition at line 37 of file Handler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\StaticURL\Shortlinks\Handler::__construct

(

)

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 44 of file Handler.php.

    {
    }

Member Function Documentation

canHandle()

ILIAS\StaticURL\Shortlinks\Handler::canHandle

(

Request

$request

)

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 61 of file Handler.php.

                                               : bool
    {
        if ($request->getNamespace() === $this->getNamespace()) {
            return true;
        }
        return in_array(
            $request->getNamespace(),
            $this->getNamespaceAliasses()
        );
    }

References ILIAS\StaticURL\Request\Request\getNamespace().

Here is the call graph for this function:

getNamespace()

ILIAS\StaticURL\Shortlinks\Handler::getNamespace

(

)

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 48 of file Handler.php.

                                  : string
    {
        return self::SHORTLINK_NAMESPACE;
    }

References ILIAS\StaticURL\Shortlinks\Handler\SHORTLINK_NAMESPACE.

Referenced by ILIAS\StaticURL\Shortlinks\Handler\getNamespaceAliasses().

Here is the caller graph for this function:

getNamespaceAliasses()

ILIAS\StaticURL\Shortlinks\Handler::getNamespaceAliasses

(

)

Implements ILIAS\StaticURL\Handler\AliasedHandler.

Definition at line 53 of file Handler.php.

                                          : array
    {
        return array_diff(
            [self::NAMESPACE_LONG, self::NAMESPACE_ALTERNATIVE, self::NAMESPACE_SHORT],
            [$this->getNamespace()]
        );
    }

References ILIAS\StaticURL\Shortlinks\Handler\getNamespace().

Here is the call graph for this function:

handle()

ILIAS\StaticURL\Shortlinks\Handler::handle	(	Request	$request,
		Context	$context,
		Factory	$response_factory
	)

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 72 of file Handler.php.

                                                                                         : Response
    {
        global $DIC;
        $repository = new RepositoryDB(
            $DIC->database(),
            new ILIASTypeDataResolver(
                $DIC->repositoryTree()
            )
        );
        $alias = $request->getAdditionalParameters()[0] ?? '';
        if (!$repository->has($alias)) {
            return $response_factory->cannot();
        }
 
        if (($shortlink = $repository->getByAlias($alias)) === null) {
            return $response_factory->cannot();
        };
 
        if (!$shortlink->isActive()) {
            return $response_factory->cannot();
        }
 
        $target_resolver = new TargetLinkResolver(
            $DIC['static_url']->builder(),
            $DIC[\ILIAS\Data\Factory::class]
        );
 
        $target = $target_resolver->resolve(
            $shortlink
        );
        if ($target instanceof URI) {
            $target = $target->getPath();
        }
 
        if (empty($target)) {
            return $response_factory->cannot();
        }
 
        $repository->increaseUsage(
            $shortlink
        );
 
        return $response_factory->can(
            $target,
            $this->mustShift($context->http()->request())
        );
    }

References $DIC, ILIAS\StaticURL\Response\Factory\can(), ILIAS\StaticURL\Response\Factory\cannot(), ILIAS\StaticURL\Request\Request\getAdditionalParameters(), ILIAS\StaticURL\Context\http(), and ILIAS\StaticURL\Shortlinks\Handler\mustShift().

Here is the call graph for this function:

mustShift()

ILIAS\StaticURL\Shortlinks\Handler::mustShift ( ServerRequestInterface  $request )

protected

Definition at line 120 of file Handler.php.

                                                                 : bool
    {
        $requested_uri = $request->getUri()->getPath();
 
        return !str_contains($requested_uri, StandardURIBuilder::SHORT)
            && !str_contains($requested_uri, StandardURIBuilder::LONG);
    }

References ILIAS\StaticURL\Builder\StandardURIBuilder\LONG, and ILIAS\StaticURL\Builder\StandardURIBuilder\SHORT.

Referenced by ILIAS\StaticURL\Shortlinks\Handler\handle().

Here is the caller graph for this function:

Field Documentation

NAMESPACE_ALTERNATIVE

const string ILIAS\StaticURL\Shortlinks\Handler::NAMESPACE_ALTERNATIVE = 'to'

private

Definition at line 42 of file Handler.php.

NAMESPACE_LONG

const string ILIAS\StaticURL\Shortlinks\Handler::NAMESPACE_LONG = 'shortlink'

private

Definition at line 41 of file Handler.php.

NAMESPACE_SHORT

const string ILIAS\StaticURL\Shortlinks\Handler::NAMESPACE_SHORT = 's'

private

Definition at line 40 of file Handler.php.

SHORTLINK_NAMESPACE

const string ILIAS\StaticURL\Shortlinks\Handler::SHORTLINK_NAMESPACE = self::NAMESPACE_ALTERNATIVE

Definition at line 39 of file Handler.php.

Referenced by ILIAS\StaticURL\Request\ShortlinkRequestBuilder\buildRequest(), and ILIAS\StaticURL\Shortlinks\Handler\getNamespace().

---

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

• components/ILIAS/StaticURL/src/Shortlinks/Handler.php