Generatates and reads Goto Links. More...

Inheritance diagram for ilKSDocumentationGotoLink:

Collaboration diagram for ilKSDocumentationGotoLink:

Public Member Functions
	getNamespace ()

	handle (Request $request, Context $context, Factory $response_factory)

	generateGotoLink (string $node_id, string $skin_id, string $style_id)

	generateRedirectURL (ilCtrl $ctrl, int $ref_id, string $node_id, string $skin_id, string $style_id,)

	redirectWithGotoLink (string $ref_id, array $params, ilCtrl $ctrl)

Public Member Functions inherited from ILIAS\StaticURL\Handler\BaseHandler
	__construct ()

	canHandle (Request $request)

Public Member Functions inherited from ILIAS\StaticURL\Handler\Handler
	__construct ()

	getNamespace ()

	canHandle (Request $request)

	handle (Request $request, Context $context, Factory $response_factory)

Detailed Description

Generatates and reads Goto Links.

Definition at line 30 of file class.ilKSDocumentationGotoLink.php.

Member Function Documentation

◆ generateGotoLink()

ilKSDocumentationGotoLink::generateGotoLink	(	string	$node_id,
		string	$skin_id,
		string	$style_id
	)

Definition at line 50 of file class.ilKSDocumentationGotoLink.php.

                                                                                        : string
    {
        return implode('/', [$node_id, $skin_id, $style_id]);
    }

◆ generateRedirectURL()

ilKSDocumentationGotoLink::generateRedirectURL	(	ilCtrl	$ctrl,
		int	$ref_id,
		string	$node_id,
		string	$skin_id,
		string	$style_id
	)

Definition at line 55 of file class.ilKSDocumentationGotoLink.php.

     : string {
        $ctrl->setParameterByClass(ilSystemStyleDocumentationGUI::class, 'skin_id', $skin_id);
        $ctrl->setParameterByClass(
            ilSystemStyleDocumentationGUI::class,
            'style_id',
            $style_id
        );
        $ctrl->setParameterByClass(ilSystemStyleDocumentationGUI::class, 'node_id', $node_id);
        $ctrl->setParameterByClass(ilSystemStyleDocumentationGUI::class, 'ref_id', $ref_id);
 
        $cmd_classes = [
            ilAdministrationGUI::class,
            ilObjStyleSettingsGUI::class,
            ilSystemStyleMainGUI::class,
            ilSystemStyleDocumentationGUI::class
        ];
 
        $ctrl->setTargetScript('ilias.php');
 
        return $ctrl->getLinkTargetByClass($cmd_classes, 'entries');
    }

Referenced by handle().

Here is the caller graph for this function:

◆ getNamespace()

ilKSDocumentationGotoLink::getNamespace ( )

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 32 of file class.ilKSDocumentationGotoLink.php.

                                  : string
    {
        return 'stys';
    }

◆ handle()

ilKSDocumentationGotoLink::handle	(	Request	$request,
		Context	$context,
		Factory	$response_factory
	)

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 37 of file class.ilKSDocumentationGotoLink.php.

                                                                                         : Response
    {
        return $response_factory->can(
            $this->generateRedirectURL(
                $context->ctrl(),
                $request->getReferenceId()?->toInt() ?? 0,
                $request->getAdditionalParameters()[0] ?? '',
                $request->getAdditionalParameters()[1] ?? '',
                $request->getAdditionalParameters()[2] ?? ''
            )
        );
    }

References ILIAS\StaticURL\Response\Factory\can(), ILIAS\StaticURL\Context\ctrl(), generateRedirectURL(), ILIAS\StaticURL\Request\Request\getAdditionalParameters(), and ILIAS\StaticURL\Request\Request\getReferenceId().

Here is the call graph for this function:

◆ redirectWithGotoLink()

ilKSDocumentationGotoLink::redirectWithGotoLink	(	string	$ref_id,
		array	$params,
		ilCtrl	$ctrl
	)

Deprecated:: this is only present for backwards compatibility and the testcase.

Definition at line 86 of file class.ilKSDocumentationGotoLink.php.

                                                                                     : void
    {
        $ref_id = (int) $ref_id;
        $node_id = $params[2] ?? '';
        $skin_id = $params[3] ?? '';
        $style_id = $params[4] ?? '';
 
        $ctrl->redirectToURL(
            $this->generateRedirectURL(
                $ctrl,
                $ref_id,
                $node_id,
                $skin_id,
                $style_id
            )
        );
    }

References $params, $ref_id, ILIAS\Repository\int(), and ilCtrl\redirectToURL().