AdminAccount Class Reference

Public Member Functions
	__construct (AdapterInterface $connection, EncryptorInterface $encryptor, array $data)
	save ()
	validateUserMatches ()

Data Fields
const	KEY_USER = 'admin-user'
const	KEY_PASSWORD = 'admin-password'
const	KEY_EMAIL = 'admin-email'
const	KEY_FIRST_NAME = 'admin-firstname'
const	KEY_LAST_NAME = 'admin-lastname'
const	KEY_PREFIX = 'db-prefix'

Protected Member Functions
	generatePassword ()

Detailed Description

Definition at line 15 of file AdminAccount.php.

Constructor & Destructor Documentation

__construct()

__construct	(	AdapterInterface	$connection,
		EncryptorInterface	$encryptor,
		array	$data
	)

Default Constructor

Parameters

AdapterInterface	$connection
EncryptorInterface	$encryptor
array	$data

Definition at line 54 of file AdminAccount.php.

      {
        $this->connection = $connection;
        $this->encryptor = $encryptor;
        $this->data = $data;
    }

Member Function Documentation

generatePassword()

generatePassword ( )

protected

Generate password string

Returns

string

Definition at line 69 of file AdminAccount.php.

    {
        return $this->encryptor->getHash($this->data[self::KEY_PASSWORD], true);
    }

save()

save

(

)

Save administrator account and user role to DB.

If the administrator account exists, update it.

Returns

void

Definition at line 81 of file AdminAccount.php.

    {
        $adminId = $this->saveAdminUser();
        $this->saveAdminUserRole($adminId);
    }

validateUserMatches()

validateUserMatches

(

)

Validates that the username and email both match the user, and that password exists and is different from user name.

Returns

void

Exceptions

Definition at line 164 of file AdminAccount.php.

    {
        if (empty($this->data[self::KEY_PASSWORD])) {
            throw new \Exception(
                '"Password" is required. Enter and try again.'
            );
        }

        if (strcasecmp($this->data[self::KEY_PASSWORD], $this->data[self::KEY_USER]) == 0) {
            throw new \Exception(
                'Password cannot be the same as the user name.'
            );
        }

        try {
            $result = $this->connection->fetchRow(
                "SELECT user_id, username, email FROM {$this->getTableName('admin_user')} "
                . "WHERE username = :username OR email = :email",
                ['username' => $this->data[self::KEY_USER], 'email' => $this->data[self::KEY_EMAIL]]
            );
        } catch (\Exception $e) {
            return; // New installation, no need to validate existing users.
        }

        $email = $result['email'];
        $username = $result['username'];

        if ((strcasecmp($email, $this->data[self::KEY_EMAIL]) == 0) &&
            (strcasecmp($username, $this->data[self::KEY_USER]) != 0)) {
            // email matched but username did not
            throw new \Exception(
                'An existing user has the given email but different username. '
                . 'Username and email both need to match an existing user or both be new.'
            );
        }
        if ((strcasecmp($username, $this->data[self::KEY_USER]) == 0) &&
            (strcasecmp($email, $this->data[self::KEY_EMAIL]) != 0)) {
            // username matched but email did not
            throw new \Exception(
                'An existing user has the given username but different email. '
                . 'Username and email both need to match an existing user or both be new.'
            );
        }
    }

Field Documentation

KEY_EMAIL

const KEY_EMAIL = 'admin-email'

Definition at line 22 of file AdminAccount.php.

KEY_FIRST_NAME

const KEY_FIRST_NAME = 'admin-firstname'

Definition at line 23 of file AdminAccount.php.

KEY_LAST_NAME

const KEY_LAST_NAME = 'admin-lastname'

Definition at line 24 of file AdminAccount.php.

KEY_PASSWORD

const KEY_PASSWORD = 'admin-password'

Definition at line 21 of file AdminAccount.php.

KEY_PREFIX

const KEY_PREFIX = 'db-prefix'

Definition at line 25 of file AdminAccount.php.

KEY_USER

const KEY_USER = 'admin-user'

#+ Data keys

Definition at line 20 of file AdminAccount.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/AdminAccount.php