ILIAS\User\StaticURLHandler Class Reference

Inheritance diagram for ILIAS\User\StaticURLHandler:

Collaboration diagram for ILIAS\User\StaticURLHandler:

Public Member Functions
	__construct ()
	getNamespace ()
	handle (Request $request, Context $context, Factory $response_factory)
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)

Data Fields
const	NAMESPACE = 'usr'
const	CHANGE_EMAIL_OPERATION = 'email'
const	REGISTRATION_OPERATION = 'registration'
const	USERNAME_ASSIST_OPERATION = 'nameassist'
const	PASSWORD_ASSIST_OPERATION = 'pwassist'
const	DEL_OWN_ACCOUNT_OPERATION = 'delown'
const	CONTACT_APPROVE_OPERATION = '_contact_approved'
const	CONTACT_IGNORE_OPERATION = '_contact_ignored'

Private Member Functions
	buildChangeEmailUrl (string $token, \ilCtrl $ctrl)
	getLoginUrl (Request $request, Context $context)
	buildDeleteUsrUrl (Context $context)
	getRedirectToOtherComponentsOrProfile (\ilCtrl $ctrl, ?ReferenceId $target_user_id, string $cmd)
	buildProfileUrl (\ilCtrl $ctrl, ?ReferenceId $target_user_id, string $cmd)

Private Attributes
readonly LegalDocumentsConductor	$legal_documents
readonly ilObjUser	$user
readonly StartingPointRepository	$starting_point_repository

Detailed Description

Definition at line 40 of file StaticURLHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\StaticURLHandler::__construct

(

)

Reimplemented from ILIAS\StaticURL\Handler\BaseHandler.

Definition at line 55 of file StaticURLHandler.php.

    {
        global $DIC;
        $this->legal_documents = $DIC['legalDocuments'];
        $this->user = $DIC['ilUser'];
        $this->starting_point_repository = LocalDIC::dic()[StartingPointRepository::class];
    }

References $DIC, ILIAS\User\LocalDIC\dic(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

buildChangeEmailUrl()

ILIAS\User\StaticURLHandler::buildChangeEmailUrl ( string  $token, \ilCtrl  $ctrl  )

private

Definition at line 113 of file StaticURLHandler.php.

                                                                      : string
    {
        $ctrl->setParameterByClass(PersonalProfileGUI::class, 'token', $token);
        $link = $ctrl->getLinkTargetByClass([\ilDashboardGUI::class, PersonalProfileGUI::class], PersonalProfileGUI::CHANGE_EMAIL_CMD);
        $ctrl->clearParameterByClass(PersonalProfileGUI::class, 'token');
        return $link;
    }

References $token, ILIAS\User\Profile\PersonalProfileGUI\CHANGE_EMAIL_CMD, ilCtrl\clearParameterByClass(), ilCtrl\getLinkTargetByClass(), and ilCtrl\setParameterByClass().

Referenced by ILIAS\User\StaticURLHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

buildDeleteUsrUrl()

ILIAS\User\StaticURLHandler::buildDeleteUsrUrl ( Context  $context )

private

Definition at line 137 of file StaticURLHandler.php.

     : string {
        if ($context->getUserId() !== ANONYMOUS_USER_ID
            && $this->user->hasDeletionFlag()) {
            $context->ctrl()->setTargetScript('ilias.php');
            return $context->ctrl()->getLinkTargetByClass(
                [\ilDashboardGUI::class, PersonalSettingsGUI::class, DeleteAccountGUI::class],
                'deleteOwnAccountStep2'
            );
        }
 
        $context->mainTemplate()->setOnScreenMessage(
            'failure',
            $context->lng()->txt('account_not_flagged_for_deletion'),
            true
        );
        return $this->starting_point_repository->getValidAndAccessibleStartingPointAsUrl();
    }

References ILIAS\StaticURL\Context\ctrl().

Referenced by ILIAS\User\StaticURLHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

buildProfileUrl()

ILIAS\User\StaticURLHandler::buildProfileUrl ( \ilCtrl  $ctrl, ?ReferenceId  $target_user_id, string  $cmd  )

private

Definition at line 189 of file StaticURLHandler.php.

     : string {
        if ($target_user_id === null) {
            return $ctrl->getLinkTargetByClass(
                [\ilDashboardGUI::class],
                'jumpToProfile'
            );
        }
        $ctrl->setParameterByClass(PublicProfileGUI::class, 'user_id', $target_user_id->toInt());
        return $ctrl->getLinkTargetByClass([\ilPublicProfileBaseClassGUI::class, PublicProfileGUI::class], $cmd);
    }

References ilCtrl\getLinkTargetByClass().

Referenced by ILIAS\User\StaticURLHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

getLoginUrl()

ILIAS\User\StaticURLHandler::getLoginUrl ( Request  $request, Context  $context  )

private

Definition at line 121 of file StaticURLHandler.php.

     : string {
        $target = (new StandardURIBuilder(new StaticURLConfig()))->buildTarget(
            $request->getNamespace(),
            $request->getReferenceId(),
            $request->getAdditionalParameters()
        );
 
        return '/login.php?target='
            . str_replace('/', '_', rtrim($target, '/'))
            . '&cmd=force_login&lang=' . $context->getUserLanguage();
 
    }

Referenced by ILIAS\User\StaticURLHandler\handle().

Here is the caller graph for this function:

getNamespace()

ILIAS\User\StaticURLHandler::getNamespace

(

)

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 63 of file StaticURLHandler.php.

                                  : string
    {
        return self::NAMESPACE;
    }

References ILIAS\User\StaticURLHandler\NAMESPACE.

getRedirectToOtherComponentsOrProfile()

ILIAS\User\StaticURLHandler::getRedirectToOtherComponentsOrProfile ( \ilCtrl  $ctrl, ?ReferenceId  $target_user_id, string  $cmd  )

private

Definition at line 157 of file StaticURLHandler.php.

     : string {
        if (str_starts_with($cmd, '_bdg')) {
            return $ctrl->getLinkTargetByClass(\ilDashboardGUI::class, 'jumpToBadges');
        }
 
        $legal_documents_target = $this->legal_documents->findGotoLink($cmd);
        if ($legal_documents_target->isOK()) {
            $ctrl->setTargetScript('ilias.php');
            foreach ($legal_documents_target->value()->queryParams() as $key => $value) {
                $ctrl->setParameterByClass(
                    $legal_documents_target->value()->guiName(),
                    (string) $key,
                    $value
                );
            }
            return $ctrl->getLinkTargetByClass(
                $legal_documents_target->value()->guiPath(),
                $legal_documents_target->value()->command()
            );
        }
 
        return $this->buildProfileUrl(
            $ctrl,
            $target_user_id,
            PublicProfileGUI::DEFAULT_CMD
        );
    }

References ilCtrl\getLinkTargetByClass().

Referenced by ILIAS\User\StaticURLHandler\handle().

Here is the call graph for this function:

Here is the caller graph for this function:

handle()

ILIAS\User\StaticURLHandler::handle	(	Request	$request,
		Context	$context,
		Factory	$response_factory
	)

Implements ILIAS\StaticURL\Handler\Handler.

Definition at line 68 of file StaticURLHandler.php.

     : Response {
        $additional_params = $request->getAdditionalParameters();
        $cmd = $additional_params[0] ?? '';
 
        $uri = match ($cmd) {
            self::CHANGE_EMAIL_OPERATION => $context->isUserLoggedIn()
                    ? $this->buildChangeEmailUrl($additional_params[1], $context->ctrl())
                    : $this->getLoginUrl($request, $context),
            self::REGISTRATION_OPERATION => $context->ctrl()->redirectByClass(
                [\ilStartUpGUI::class, \ilAccountRegistrationGUI::class],
                ''
            ),
            self::USERNAME_ASSIST_OPERATION => $context->ctrl()->redirectByClass(
                [\ilStartUpGUI::class, \ilPasswordAssistanceGUI::class],
                'showUsernameAssistanceForm'
            ),
            self::PASSWORD_ASSIST_OPERATION => $context->ctrl()->redirectByClass(
                [\ilStartUpGUI::class, \ilPasswordAssistanceGUI::class],
                ''
            ),
            self::CONTACT_APPROVE_OPERATION => $this->buildProfileUrl(
                $context->ctrl(),
                $request->getReferenceId(),
                'approveContactRequest'
            ),
            self::CONTACT_IGNORE_OPERATION => $this->buildProfileUrl(
                $context->ctrl(),
                $request->getReferenceId(),
                'ignoreContactRequest'
            ),
            self::DEL_OWN_ACCOUNT_OPERATION => $this->buildDeleteUsrUrl($context),
            default => $this->getRedirectToOtherComponentsOrProfile(
                $context->ctrl(),
                $request->getReferenceId(),
                $cmd
            )
        };
 
        return $response_factory->can($uri);
    }

References ILIAS\User\StaticURLHandler\buildChangeEmailUrl(), ILIAS\User\StaticURLHandler\buildDeleteUsrUrl(), ILIAS\User\StaticURLHandler\buildProfileUrl(), ILIAS\StaticURL\Context\ctrl(), ILIAS\User\StaticURLHandler\getLoginUrl(), ILIAS\User\StaticURLHandler\getRedirectToOtherComponentsOrProfile(), ILIAS\StaticURL\Request\Request\getReferenceId(), and ILIAS\StaticURL\Context\isUserLoggedIn().

Here is the call graph for this function:

Field Documentation

$legal_documents

readonly LegalDocumentsConductor ILIAS\User\StaticURLHandler::$legal_documents

private

Definition at line 51 of file StaticURLHandler.php.

$starting_point_repository

readonly StartingPointRepository ILIAS\User\StaticURLHandler::$starting_point_repository

private

Definition at line 53 of file StaticURLHandler.php.

$user

readonly ilObjUser ILIAS\User\StaticURLHandler::$user

private

Definition at line 52 of file StaticURLHandler.php.

CHANGE_EMAIL_OPERATION

const ILIAS\User\StaticURLHandler::CHANGE_EMAIL_OPERATION = 'email'

Definition at line 43 of file StaticURLHandler.php.

CONTACT_APPROVE_OPERATION

const ILIAS\User\StaticURLHandler::CONTACT_APPROVE_OPERATION = '_contact_approved'

Definition at line 48 of file StaticURLHandler.php.

CONTACT_IGNORE_OPERATION

const ILIAS\User\StaticURLHandler::CONTACT_IGNORE_OPERATION = '_contact_ignored'

Definition at line 49 of file StaticURLHandler.php.

DEL_OWN_ACCOUNT_OPERATION

const ILIAS\User\StaticURLHandler::DEL_OWN_ACCOUNT_OPERATION = 'delown'

Definition at line 47 of file StaticURLHandler.php.

Referenced by ILIAS\User\Account\DeleteAccountGUI\deleteOwnAccountLogout().

NAMESPACE

const ILIAS\User\StaticURLHandler::NAMESPACE = 'usr'

Definition at line 42 of file StaticURLHandler.php.

Referenced by ILIAS\User\StaticURLHandler\getNamespace(), and ILIAS\User\Profile\ChangeMail\Token\getUriForStatus().

PASSWORD_ASSIST_OPERATION

const ILIAS\User\StaticURLHandler::PASSWORD_ASSIST_OPERATION = 'pwassist'

Definition at line 46 of file StaticURLHandler.php.

REGISTRATION_OPERATION

const ILIAS\User\StaticURLHandler::REGISTRATION_OPERATION = 'registration'

Definition at line 44 of file StaticURLHandler.php.

USERNAME_ASSIST_OPERATION

const ILIAS\User\StaticURLHandler::USERNAME_ASSIST_OPERATION = 'nameassist'

Definition at line 45 of file StaticURLHandler.php.

---

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

• components/ILIAS/User/src/StaticURLHandler.php