ILIAS\User\Profile\ChangeMailToken Class Reference

Collaboration diagram for ILIAS\User\Profile\ChangeMailToken:

Public Member Functions
	__construct (private readonly int $user_id, private readonly string $current_email, private readonly string $new_email, private readonly int $created_timestamp, private readonly ChangeMailStatus $status=ChangeMailStatus::Login, private ?string $token=null)
	getToken ()
	getUserId ()
	getCurrentEmail ()
	getNewEmail ()
	getCreatedTimestamp ()
	getStatus ()
	isTokenValidForCurrentStatus (\ilSetting $settings)
	getUriForStatus (URIBuilder $uri_builder)

Private Member Functions
	buildValidToken ()

Detailed Description

Definition at line 27 of file ChangeMailToken.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\ChangeMailToken::__construct	(	private readonly int	$user_id,
		private readonly string	$current_email,
		private readonly string	$new_email,
		private readonly int	$created_timestamp,
		private readonly ChangeMailStatus	$status = ChangeMailStatus::Login,
		private ?string	$token = null
	)

Definition at line 29 of file ChangeMailToken.php.

References ILIAS\User\Profile\ChangeMailToken\buildValidToken().

      {
        $this->token ??= $this->buildValidToken();
    }

Here is the call graph for this function:

Member Function Documentation

buildValidToken()

ILIAS\User\Profile\ChangeMailToken::buildValidToken ( )

private

Definition at line 88 of file ChangeMailToken.php.

Referenced by ILIAS\User\Profile\ChangeMailToken\__construct(), and ILIAS\User\Profile\ChangeMailToken\isTokenValidForCurrentStatus().

                                      : string
    {
        return hash('md5', "{$this->created_timestamp}-{$this->user_id}-{$this->current_email}-{$this->status->value}");
    }

Here is the caller graph for this function:

getCreatedTimestamp()

ILIAS\User\Profile\ChangeMailToken::getCreatedTimestamp

(

)

Definition at line 60 of file ChangeMailToken.php.

Referenced by ILIAS\User\Profile\ChangeMailTokenDBRepository\storeChangeMailToken().

                                         : int
    {
        return $this->created_timestamp;
    }

Here is the caller graph for this function:

getCurrentEmail()

ILIAS\User\Profile\ChangeMailToken::getCurrentEmail

(

)

Definition at line 50 of file ChangeMailToken.php.

Referenced by ILIAS\User\Profile\ChangeMailTokenDBRepository\moveToNextStep().

                                     : string
    {
        return $this->current_email;
    }

Here is the caller graph for this function:

getNewEmail()

ILIAS\User\Profile\ChangeMailToken::getNewEmail

(

)

Definition at line 55 of file ChangeMailToken.php.

Referenced by ILIAS\User\Profile\ChangeMailTokenDBRepository\moveToNextStep(), and ILIAS\User\Profile\ChangeMailTokenDBRepository\storeChangeMailToken().

                                 : string
    {
        return $this->new_email;
    }

Here is the caller graph for this function:

getStatus()

ILIAS\User\Profile\ChangeMailToken::getStatus

(

)

Definition at line 65 of file ChangeMailToken.php.

Referenced by ILIAS\User\Profile\ChangeMailTokenDBRepository\moveToNextStep(), and ILIAS\User\Profile\ChangeMailTokenDBRepository\storeChangeMailToken().

                               : ChangeMailStatus
    {
        return $this->status;
    }

Here is the caller graph for this function:

getToken()

ILIAS\User\Profile\ChangeMailToken::getToken

(

)

Definition at line 40 of file ChangeMailToken.php.

References $token.

Referenced by ILIAS\User\Profile\ChangeMailTokenDBRepository\moveToNextStep(), and ILIAS\User\Profile\ChangeMailTokenDBRepository\storeChangeMailToken().

                              : string
    {
        return $this->token;
    }

Here is the caller graph for this function:

getUriForStatus()

ILIAS\User\Profile\ChangeMailToken::getUriForStatus

(

URIBuilder

$uri_builder

)

Definition at line 79 of file ChangeMailToken.php.

References ILIAS\StaticURL\Builder\URIBuilder\build(), ILIAS\User\StaticURLHandler\NAMESPACE, and null.

                                                            : URI
    {
        return $uri_builder->build(
            StaticURLHandler::NAMESPACE,
            null,
            [StaticUrlHandler::CHANGE_EMAIL_OPERATIONS, $this->token]
        );
    }

Here is the call graph for this function:

getUserId()

ILIAS\User\Profile\ChangeMailToken::getUserId

(

)

Definition at line 45 of file ChangeMailToken.php.

References $user_id.

Referenced by ILIAS\User\Profile\ChangeMailTokenDBRepository\moveToNextStep(), and ILIAS\User\Profile\ChangeMailTokenDBRepository\storeChangeMailToken().

                               : int
    {
        return $this->user_id;
    }

Here is the caller graph for this function:

isTokenValidForCurrentStatus()

ILIAS\User\Profile\ChangeMailToken::isTokenValidForCurrentStatus

(

\ilSetting

$settings

)

Definition at line 70 of file ChangeMailToken.php.

References ILIAS\User\Profile\ChangeMailToken\buildValidToken().

                                                                      : bool
    {
        if ($this->buildValidToken() === $this->token
            && time() < $this->created_timestamp + $this->status->getValidity($settings)) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

---

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

• components/ILIAS/User/src/Profile/ChangeMailToken.php