AdminUserCreateCommand.php

Go to the documentation of this file.

<?php
namespace Magento\Setup\Console\Command;

use Magento\Framework\Setup\ConsoleLogger;
use Magento\Setup\Model\AdminAccount;
use Magento\Setup\Model\InstallerFactory;
use Magento\User\Model\UserValidationRules;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;

class AdminUserCreateCommand extends AbstractSetupCommand
{
    private $installerFactory;

    private $validationRules;

    public function __construct(InstallerFactory $installerFactory, UserValidationRules $validationRules)
    {
        $this->installerFactory = $installerFactory;
        $this->validationRules = $validationRules;
        parent::__construct();
    }

    protected function configure()
    {
        $this->setName('admin:user:create')
            ->setDescription('Creates an administrator')
            ->setDefinition($this->getOptionsList());
        parent::configure();
    }

    protected function interact(InputInterface $input, OutputInterface $output)
    {
        $questionHelper = $this->getHelper('question');

        if (!$input->getOption(AdminAccount::KEY_USER)) {
            $question = new Question('<question>Admin user:</question> ', '');
            $this->addNotEmptyValidator($question);

            $input->setOption(
                AdminAccount::KEY_USER,
                $questionHelper->ask($input, $output, $question)
            );
        }

        if (!$input->getOption(AdminAccount::KEY_PASSWORD)) {
            $question = new Question('<question>Admin password:</question> ', '');
            $question->setHidden(true);

            $question->setValidator(function ($value) use ($output) {
                $user = new \Magento\Framework\DataObject();
                $user->setPassword($value);

                $validator = new \Magento\Framework\Validator\DataObject();
                $this->validationRules->addPasswordRules($validator);

                $validator->isValid($user);
                foreach ($validator->getMessages() as $message) {
                    throw new \Exception($message);
                }

                return $value;
            });

            $input->setOption(
                AdminAccount::KEY_PASSWORD,
                $questionHelper->ask($input, $output, $question)
            );
        }

        if (!$input->getOption(AdminAccount::KEY_EMAIL)) {
            $question = new Question('<question>Admin email:</question> ', '');
            $this->addNotEmptyValidator($question);

            $input->setOption(
                AdminAccount::KEY_EMAIL,
                $questionHelper->ask($input, $output, $question)
            );
        }

        if (!$input->getOption(AdminAccount::KEY_FIRST_NAME)) {
            $question = new Question('<question>Admin first name:</question> ', '');
            $this->addNotEmptyValidator($question);

            $input->setOption(
                AdminAccount::KEY_FIRST_NAME,
                $questionHelper->ask($input, $output, $question)
            );
        }

        if (!$input->getOption(AdminAccount::KEY_LAST_NAME)) {
            $question = new Question('<question>Admin last name:</question> ', '');
            $this->addNotEmptyValidator($question);

            $input->setOption(
                AdminAccount::KEY_LAST_NAME,
                $questionHelper->ask($input, $output, $question)
            );
        }
    }

    private function addNotEmptyValidator(Question $question)
    {
        $question->setValidator(function ($value) {
            if (trim($value) == '') {
                throw new \Exception('The value cannot be empty');
            }

            return $value;
        });
    }

    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $errors = $this->validate($input);
        if ($errors) {
            $output->writeln('<error>' . implode('</error>' . PHP_EOL . '<error>', $errors) . '</error>');
            // we must have an exit code higher than zero to indicate something was wrong
            return \Magento\Framework\Console\Cli::RETURN_FAILURE;
        }
        $installer = $this->installerFactory->create(new ConsoleLogger($output));
        $installer->installAdminUser($input->getOptions());
        $output->writeln(
            '<info>Created Magento administrator user named ' . $input->getOption(AdminAccount::KEY_USER) . '</info>'
        );
        return \Magento\Framework\Console\Cli::RETURN_SUCCESS;
    }

    public function getOptionsList($mode = InputOption::VALUE_REQUIRED)
    {
        $requiredStr = ($mode === InputOption::VALUE_REQUIRED ? '(Required) ' : '');

        return [
            new InputOption(
                AdminAccount::KEY_USER,
                null,
                $mode,
                $requiredStr . 'Admin user'
            ),
            new InputOption(
                AdminAccount::KEY_PASSWORD,
                null,
                $mode,
                $requiredStr . 'Admin password'
            ),
            new InputOption(
                AdminAccount::KEY_EMAIL,
                null,
                $mode,
                $requiredStr . 'Admin email'
            ),
            new InputOption(
                AdminAccount::KEY_FIRST_NAME,
                null,
                $mode,
                $requiredStr . 'Admin first name'
            ),
            new InputOption(
                AdminAccount::KEY_LAST_NAME,
                null,
                $mode,
                $requiredStr . 'Admin last name'
            ),
        ];
    }

    public function validate(InputInterface $input)
    {
        $errors = [];
        $user = new \Magento\Framework\DataObject();
        $user->setFirstname($input->getOption(AdminAccount::KEY_FIRST_NAME))
            ->setLastname($input->getOption(AdminAccount::KEY_LAST_NAME))
            ->setUsername($input->getOption(AdminAccount::KEY_USER))
            ->setEmail($input->getOption(AdminAccount::KEY_EMAIL))
            ->setPassword(
                $input->getOption(AdminAccount::KEY_PASSWORD) === null
                ? '' : $input->getOption(AdminAccount::KEY_PASSWORD)
            );

        $validator = new \Magento\Framework\Validator\DataObject();
        $this->validationRules->addUserInfoRules($validator);
        $this->validationRules->addPasswordRules($validator);

        if (!$validator->isValid($user)) {
            $errors = array_merge($errors, $validator->getMessages());
        }

        return $errors;
    }
}