ILIAS\User\Profile\ChangeMailTokenDBRepository Class Reference

Inheritance diagram for ILIAS\User\Profile\ChangeMailTokenDBRepository:

Collaboration diagram for ILIAS\User\Profile\ChangeMailTokenDBRepository:

Public Member Functions
	__construct (private readonly \ilDBInterface $db, private readonly \ilSetting $settings)
	getNewTokenForUser (\ilObjUser $user, string $new_email, int $now)
	hasUserValidEmailConfirmationToken (\ilObjUser $user)
	getTokenForTokenString (string $token_string, \ilObjUser $user)
	This Function will check if the token is actually valid for the given user before returning the new email. More...
	moveToNextStep (ChangeMailToken $token, int $now)
	deleteEntryByToken (string $token)
	deleteExpiredEntries ()

Data Fields
const	TABLE_NAME = 'usr_change_email_token'

Private Member Functions
	storeChangeMailToken (ChangeMailToken $token)

Detailed Description

Definition at line 23 of file ChangeMailTokenDBRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\ChangeMailTokenDBRepository::__construct	(	private readonly \ilDBInterface	$db,
		private readonly \ilSetting	$settings
	)

Definition at line 27 of file ChangeMailTokenDBRepository.php.

      {
    }

Member Function Documentation

deleteEntryByToken()

ILIAS\User\Profile\ChangeMailTokenDBRepository::deleteEntryByToken

(

string

$token

)

Implements ILIAS\User\Profile\ChangeMailTokenRepository.

Definition at line 121 of file ChangeMailTokenDBRepository.php.

References ilDBConstants\T_TEXT.

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

                                                     : void
    {
        $query = 'DELETE FROM `' . self::TABLE_NAME . '` WHERE `token` = %s';
        $this->db->manipulateF($query, [\ilDBConstants::T_TEXT], [$token]);
    }

Here is the caller graph for this function:

deleteExpiredEntries()

ILIAS\User\Profile\ChangeMailTokenDBRepository::deleteExpiredEntries

(

)

Implements ILIAS\User\Profile\ChangeMailTokenRepository.

Definition at line 127 of file ChangeMailTokenDBRepository.php.

References ILIAS\Repository\settings(), and ilDBConstants\T_INTEGER.

                                          : void
    {
        $validity = max(
            ChangeMailStatus::Login->getValidity($this->settings),
            ChangeMailStatus::EmailConfirmation->getValidity($this->settings)
        );
        $query = 'DELETE FROM `' . self::TABLE_NAME . '` WHERE `created_ts` < %s';
        $this->db->manipulateF($query, [\ilDBConstants::T_INTEGER], [time() - $validity]);
    }

Here is the call graph for this function:

getNewTokenForUser()

ILIAS\User\Profile\ChangeMailTokenDBRepository::getNewTokenForUser	(	\ilObjUser	$user,
		string	$new_email,
		int	$now
	)

Implements ILIAS\User\Profile\ChangeMailTokenRepository.

Definition at line 33 of file ChangeMailTokenDBRepository.php.

References $token, ilObjUser\getEmail(), ilObject\getId(), and ILIAS\User\Profile\ChangeMailTokenDBRepository\storeChangeMailToken().

     : ChangeMailToken {
        $token = new ChangeMailToken(
            $user->getId(),
            $user->getEmail(),
            $new_email,
            $now
        );

        $this->storeChangeMailToken($token);
        return $token;
    }

Here is the call graph for this function:

getTokenForTokenString()

ILIAS\User\Profile\ChangeMailTokenDBRepository::getTokenForTokenString	(	string	$token_string,
		\ilObjUser	$user
	)

This Function will check if the token is actually valid for the given user before returning the new email.

Returns

string The new email a user wishes to be used or an empty string if validation failed or there is no usable entry.

Implements ILIAS\User\Profile\ChangeMailTokenRepository.

Definition at line 77 of file ChangeMailTokenDBRepository.php.

References $token, ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), ilObjUser\getEmail(), ilObject\getId(), and ilDBConstants\T_TEXT.

                                                                                  : ?ChangeMailToken
    {
        $query = $this->db->queryF(
            'SELECT * FROM `' . self::TABLE_NAME . '` WHERE `token` = %s',
            [\ilDBConstants::T_TEXT],
            [$token_string]
        );

        $result = $this->db->fetchObject($query);

        if ($result === null) {
            return null;
        }

        $token = new ChangeMailToken(
            $user->getId(),
            $user->getEmail(),
            $result->new_email,
            $result->created_ts,
            ChangeMailStatus::from($result->status),
            $result->token
        );

        if (!$token->isTokenValidForCurrentStatus($this->settings)) {
            return null;
        }

        return $token;
    }

Here is the call graph for this function:

hasUserValidEmailConfirmationToken()

ILIAS\User\Profile\ChangeMailTokenDBRepository::hasUserValidEmailConfirmationToken

(

\ilObjUser

$user

)

Implements ILIAS\User\Profile\ChangeMailTokenRepository.

Definition at line 49 of file ChangeMailTokenDBRepository.php.

References ilObject\getId(), ILIAS\Repository\settings(), and ilDBConstants\T_INTEGER.

                                                                        : bool
    {
        $query = $this->db->queryF(
            'SELECT count(*) as cnt FROM `' . self::TABLE_NAME . '`' . PHP_EOL
                . 'WHERE `usr_id` = %s' . PHP_EOL
                . 'AND `status` = %s' . PHP_EOL
                . 'AND `created_ts` >= %s',
            [
                \ilDBConstants::T_INTEGER,
                \ilDBConstants::T_INTEGER,
                \ilDBConstants::T_INTEGER
            ],
            [
                $user->getId(),
                ChangeMailStatus::EmailConfirmation->value,
                time() - ChangeMailStatus::EmailConfirmation->getValidity($this->settings)
            ]
        );

        $result = $this->db->fetchObject($query);

        if ($result->cnt > 0) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

moveToNextStep()

ILIAS\User\Profile\ChangeMailTokenDBRepository::moveToNextStep	(	ChangeMailToken	$token,
		int	$now
	)

Implements ILIAS\User\Profile\ChangeMailTokenRepository.

Definition at line 107 of file ChangeMailTokenDBRepository.php.

References ILIAS\User\Profile\ChangeMailTokenDBRepository\deleteEntryByToken(), ILIAS\User\Profile\ChangeMailToken\getCurrentEmail(), ILIAS\User\Profile\ChangeMailToken\getNewEmail(), ILIAS\User\Profile\ChangeMailToken\getStatus(), ILIAS\User\Profile\ChangeMailToken\getToken(), ILIAS\User\Profile\ChangeMailToken\getUserId(), and ILIAS\User\Profile\ChangeMailTokenDBRepository\storeChangeMailToken().

                                                                    : ChangeMailToken
    {
        $new_token = new ChangeMailToken(
            $token->getUserId(),
            $token->getCurrentEmail(),
            $token->getNewEmail(),
            $now,
            $token->getStatus()->next()
        );
        $this->deleteEntryByToken($token->getToken());
        $this->storeChangeMailToken($new_token);
        return $new_token;
    }

Here is the call graph for this function:

storeChangeMailToken()

ILIAS\User\Profile\ChangeMailTokenDBRepository::storeChangeMailToken ( ChangeMailToken  $token )

private

Definition at line 137 of file ChangeMailTokenDBRepository.php.

References ILIAS\User\Profile\ChangeMailToken\getCreatedTimestamp(), ILIAS\User\Profile\ChangeMailToken\getNewEmail(), ILIAS\User\Profile\ChangeMailToken\getStatus(), ILIAS\User\Profile\ChangeMailToken\getToken(), ILIAS\User\Profile\ChangeMailToken\getUserId(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

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

                                                                 : void
    {
        $this->db->replace(
            self::TABLE_NAME,
            [
                'token' => ['text', $token->getToken()]
            ],
            [
                'usr_id' => [\ilDBConstants::T_TEXT, $token->getUserId()],
                'new_email' => [\ilDBConstants::T_TEXT, $token->getNewEmail()],
                'status' => [\ilDBConstants::T_INTEGER, $token->getStatus()->value],
                'created_ts' => [\ilDBConstants::T_INTEGER, $token->getCreatedTimestamp()]
            ]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

TABLE_NAME

const ILIAS\User\Profile\ChangeMailTokenDBRepository::TABLE_NAME = 'usr_change_email_token'

Definition at line 25 of file ChangeMailTokenDBRepository.php.

---

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

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