ILIAS\User\Profile\ProfileChangeMailTokenDBRepository Class Reference

Inheritance diagram for ILIAS\User\Profile\ProfileChangeMailTokenDBRepository:

Collaboration diagram for ILIAS\User\Profile\ProfileChangeMailTokenDBRepository:

Public Member Functions
	__construct (private \ilDBInterface $db)
	getNewTokenForUser (\ilObjUser $user, string $new_email)
	getNewEmailForUser (\ilObjUser $user, string $received_token)
	This Function will check if the token is actually valid for the given user before returning the new email. More...
	deleteEntryByToken (string $token)

Private Member Functions
	deleteExpiredEntries ()

Private Attributes
const	TABLE_NAME = 'usr_change_email_token'
const	VALIDITY = 300

Detailed Description

Definition at line 23 of file ProfileChangeMailTokenDBRepository.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Profile\ProfileChangeMailTokenDBRepository::__construct

(

private \ilDBInterface

$db

)

Definition at line 28 of file ProfileChangeMailTokenDBRepository.php.

References ILIAS\User\Profile\ProfileChangeMailTokenDBRepository\deleteExpiredEntries().

      {
        $this->deleteExpiredEntries();
    }

Here is the call graph for this function:

Member Function Documentation

deleteEntryByToken()

ILIAS\User\Profile\ProfileChangeMailTokenDBRepository::deleteEntryByToken

(

string

$token

)

Implements ILIAS\User\Profile\ProfileChangeMailTokenRepository.

Definition at line 76 of file ProfileChangeMailTokenDBRepository.php.

References ilDBConstants\T_TEXT.

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

deleteExpiredEntries()

ILIAS\User\Profile\ProfileChangeMailTokenDBRepository::deleteExpiredEntries ( )

private

Definition at line 82 of file ProfileChangeMailTokenDBRepository.php.

References ilDBConstants\T_INTEGER.

Referenced by ILIAS\User\Profile\ProfileChangeMailTokenDBRepository\__construct().

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

Here is the caller graph for this function:

getNewEmailForUser()

ILIAS\User\Profile\ProfileChangeMailTokenDBRepository::getNewEmailForUser	(	\ilObjUser	$user,
		string	$token
	)

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\ProfileChangeMailTokenRepository.

Definition at line 55 of file ProfileChangeMailTokenDBRepository.php.

References ilObjUser\getEmail(), ilObject\getId(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                                                : string
    {
        if (hash('md5', $user->getId() . '-' . $user->getEmail()) !== $received_token) {
            return '';
        }

        $query = $this->db->queryF(
            'SELECT `new_email` FROM `' . self::TABLE_NAME . '` WHERE `token` = %s AND `valid_until` >= %s',
            [\ilDBConstants::T_TEXT, \ilDBConstants::T_INTEGER],
            [$received_token, time()]
        );

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

        if ($result !== null) {
            return $result->new_email;
        }

        return '';
    }

Here is the call graph for this function:

getNewTokenForUser()

ILIAS\User\Profile\ProfileChangeMailTokenDBRepository::getNewTokenForUser	(	\ilObjUser	$user,
		string	$new_email
	)

Implements ILIAS\User\Profile\ProfileChangeMailTokenRepository.

Definition at line 34 of file ProfileChangeMailTokenDBRepository.php.

References $token, ilObjUser\getEmail(), ilObject\getId(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                                           : string
    {
        $token = hash('md5', $user->getId() . '-' . $user->getEmail());
        $result = $this->db->replace(
            self::TABLE_NAME,
            [
                'token' => ['text', $token]
            ],
            [
                'new_email' => [\ilDBConstants::T_TEXT, $new_email],
                'valid_until' => [\ilDBConstants::T_INTEGER, time() + self::VALIDITY]
            ]
        );

        if ($result === 1) {
            return $token;
        }

        return '';
    }

Here is the call graph for this function:

Field Documentation

TABLE_NAME

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

private

Definition at line 25 of file ProfileChangeMailTokenDBRepository.php.

VALIDITY

const ILIAS\User\Profile\ProfileChangeMailTokenDBRepository::VALIDITY = 300

private

Definition at line 26 of file ProfileChangeMailTokenDBRepository.php.

---

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

• Services/User/classes/Profile/ProfileChangeMailTokenDBRepository.php