Installer Class Reference

Public Member Functions
	__construct (FilePermissions $filePermissions, Writer $deploymentConfigWriter, Reader $deploymentConfigReader, \Magento\Framework\App\DeploymentConfig $deploymentConfig, ModuleListInterface $moduleList, ModuleLoader $moduleLoader, AdminAccountFactory $adminAccountFactory, LoggerInterface $log, ConnectionFactory $connectionFactory, MaintenanceMode $maintenanceMode, Filesystem $filesystem, ObjectManagerProvider $objectManagerProvider, Context $context, SetupConfigModel $setupConfigModel, CleanupFiles $cleanupFiles, DbValidator $dbValidator, SetupFactory $setupFactory, DataSetupFactory $dataSetupFactory, \Magento\Framework\Setup\SampleData\State $sampleDataState, ComponentRegistrar $componentRegistrar, PhpReadinessCheck $phpReadinessCheck)
	install ($request)
	checkInstallationFilePermissions ()
	checkExtensions ()
	checkApplicationFilePermissions ()
	installDeploymentConfig ($data)
	declarativeInstallSchema (array $request)
	checkFilePermissionsForDbUpgrade ()
	installAdminUser ($data)
	updateModulesSequence ($keepGeneratedFiles=false)
	uninstall ()
	getInstallInfo ()
	cleanupDb ()

Data Fields
const	ENABLE_MODULES = 'enable-modules'
const	DISABLE_MODULES = 'disable-modules'
const	PROGRESS_LOG_RENDER = '[Progress: %d / %d]'
const	PROGRESS_LOG_REGEX = '/\[Progress: (\d+) \/ (\d+)\]/s'
const	SCHEMA_INSTALL = \Magento\Framework\Setup\InstallSchemaInterface::class
const	SCHEMA_UPGRADE = \Magento\Framework\Setup\UpgradeSchemaInterface::class
const	DATA_INSTALL = \Magento\Framework\Setup\InstallDataInterface::class
const	DATA_UPGRADE = \Magento\Framework\Setup\UpgradeDataInterface::class
const	INFO_MESSAGE = 'message'
const	MYSQL_VERSION_REQUIRED = '5.6.0'

Protected Member Functions
	createSchemaDataHandler ($className, $interfaceName)

Protected Attributes
	$sampleDataState

Detailed Description

Class Installer contains the logic to install Magento application.

@SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.TooManyFields) @SuppressWarnings(PHPMD.ExcessiveClassComplexity)

Definition at line 54 of file Installer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	FilePermissions	$filePermissions,
		Writer	$deploymentConfigWriter,
		Reader	$deploymentConfigReader,
		\Magento\Framework\App\DeploymentConfig	$deploymentConfig,
		ModuleListInterface	$moduleList,
		ModuleLoader	$moduleLoader,
		AdminAccountFactory	$adminAccountFactory,
		LoggerInterface	$log,
		ConnectionFactory	$connectionFactory,
		MaintenanceMode	$maintenanceMode,
		Filesystem	$filesystem,
		ObjectManagerProvider	$objectManagerProvider,
		Context	$context,
		SetupConfigModel	$setupConfigModel,
		CleanupFiles	$cleanupFiles,
		DbValidator	$dbValidator,
		SetupFactory	$setupFactory,
		DataSetupFactory	$dataSetupFactory,
		\Magento\Framework\Setup\SampleData\State	$sampleDataState,
		ComponentRegistrar	$componentRegistrar,
		PhpReadinessCheck	$phpReadinessCheck
	)

Constructor

Parameters

FilePermissions	$filePermissions
Writer	$deploymentConfigWriter
Reader	$deploymentConfigReader
\Magento\Framework\App\DeploymentConfig	$deploymentConfig
ModuleListInterface	$moduleList
ModuleLoader	$moduleLoader
AdminAccountFactory	$adminAccountFactory
LoggerInterface	$log
ConnectionFactory	$connectionFactory
MaintenanceMode	$maintenanceMode
Filesystem	$filesystem
ObjectManagerProvider	$objectManagerProvider
Context	$context
SetupConfigModel	$setupConfigModel
CleanupFiles	$cleanupFiles
DbValidator	$dbValidator
SetupFactory	$setupFactory
DataSetupFactory	$dataSetupFactory
\Magento\Framework\Setup\SampleData\State	$sampleDataState
ComponentRegistrar	$componentRegistrar
PhpReadinessCheck	$phpReadinessCheck

Exceptions

Definition at line 273 of file Installer.php.

      {
        $this->filePermissions = $filePermissions;
        $this->deploymentConfigWriter = $deploymentConfigWriter;
        $this->deploymentConfigReader = $deploymentConfigReader;
        $this->moduleList = $moduleList;
        $this->moduleLoader = $moduleLoader;
        $this->adminAccountFactory = $adminAccountFactory;
        $this->log = $log;
        $this->connectionFactory = $connectionFactory;
        $this->maintenanceMode = $maintenanceMode;
        $this->filesystem = $filesystem;
        $this->installInfo[self::INFO_MESSAGE] = [];
        $this->deploymentConfig = $deploymentConfig;
        $this->objectManagerProvider = $objectManagerProvider;
        $this->context = $context;
        $this->setupConfigModel = $setupConfigModel;
        $this->cleanupFiles = $cleanupFiles;
        $this->dbValidator = $dbValidator;
        $this->setupFactory = $setupFactory;
        $this->dataSetupFactory = $dataSetupFactory;
        $this->sampleDataState = $sampleDataState;
        $this->componentRegistrar = $componentRegistrar;
        $this->phpReadinessCheck = $phpReadinessCheck;
        $this->schemaPersistor = $this->objectManagerProvider->get()->get(SchemaPersistor::class);
    }

Member Function Documentation

checkApplicationFilePermissions()

checkApplicationFilePermissions

(

)

Check permissions of directories that are expected to be non-writable for application

Returns

void

Definition at line 528 of file Installer.php.

    {
        $results = $this->filePermissions->getUnnecessaryWritableDirectoriesForApplication();
        if ($results) {
            $errorMsg = "For security, remove write permissions from these directories: '"
                . implode("' '", $results) . "'";
            $this->log->log($errorMsg);
            $this->installInfo[self::INFO_MESSAGE][] = $errorMsg;
        }
    }

checkExtensions()

checkExtensions

(

)

Check required extensions for installation

Returns

void

Exceptions

Definition at line 511 of file Installer.php.

    {
        $phpExtensionsCheckResult = $this->phpReadinessCheck->checkPhpExtensions();
        if ($phpExtensionsCheckResult['responseType'] === ResponseTypeInterface::RESPONSE_TYPE_ERROR
            && isset($phpExtensionsCheckResult['data']['missing'])
        ) {
            $errorMsg = "Missing following extensions: '"
                . implode("' '", $phpExtensionsCheckResult['data']['missing']) . "'";
            throw new \Exception($errorMsg);
        }
    }

checkFilePermissionsForDbUpgrade()

checkFilePermissionsForDbUpgrade

(

)

Check permissions of directories that are expected to be writable for database upgrade

Returns

void

Exceptions

Definition at line 885 of file Installer.php.

    {
        $this->throwExceptionForNotWritablePaths(
            $this->filePermissions->getMissingWritableDirectoriesForDbUpgrade()
        );
    }

checkInstallationFilePermissions()

checkInstallationFilePermissions

(

)

Check permissions of directories that are expected to be writable for installation

Returns

void

Exceptions

Definition at line 498 of file Installer.php.

    {
        $this->throwExceptionForNotWritablePaths(
            $this->filePermissions->getMissingWritablePathsForInstallation()
        );
    }

cleanupDb()

cleanupDb

(

)

Deletes the database and creates it again

Returns

void

Definition at line 1294 of file Installer.php.

    {
        $cleanedUpDatabases = [];
        $connections = $this->deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTIONS, []);
        //Do database cleanup for all shards
        foreach ($connections as $config) {
            try {
                $connection = $this->connectionFactory->create($config);
                if (!$connection) {
                    $this->log->log("Can't create connection to database - skipping database cleanup");
                }
            } catch (\Exception $e) {
                $this->log->log($e->getMessage() . ' - skipping database cleanup');
                return;
            }

            $dbName = $connection->quoteIdentifier($config[ConfigOptionsListConstants::KEY_NAME]);
            //If for different shards one database was specified - no need to clean it few times
            if (!in_array($dbName, $cleanedUpDatabases)) {
                $this->log->log("Cleaning up database {$dbName}");
                $connection->query("DROP DATABASE IF EXISTS {$dbName}");
                $connection->query("CREATE DATABASE IF NOT EXISTS {$dbName}");
                $cleanedUpDatabases[] = $dbName;
            }
        }

        if (empty($config)) {
            $this->log->log('No database connection defined - skipping database cleanup');
        }
    }

createSchemaDataHandler()

createSchemaDataHandler (   $className,   $interfaceName  )

protected

Create data handler

Parameters

string	$className
string	$interfaceName

Returns

mixed|null

Exceptions

Definition at line 1096 of file Installer.php.

    {
        if (class_exists($className)) {
            if (!is_subclass_of($className, $interfaceName) && $className !== $interfaceName) {
                throw  new \Magento\Setup\Exception($className . ' must implement \\' . $interfaceName);
            } else {
                return $this->objectManagerProvider->get()->create($className);
            }
        }
        return null;
    }

declarativeInstallSchema()

declarativeInstallSchema

(

array

$request

)

Install Magento if declaration mode was enabled.

Parameters

array

$request

Returns

void

Definition at line 806 of file Installer.php.

    {
        $this->getDeclarationInstaller()->installSchema($request);
    }

getInstallInfo()

getInstallInfo

(

)

Return messages

Returns

array

Definition at line 1284 of file Installer.php.

    {
        return $this->installInfo;
    }

install()

install

(

$request

)

Install Magento application

Parameters

\ArrayObject | array

$request

Returns

void

Exceptions

Definition at line 328 of file Installer.php.

    {
        $script[] = ['File permissions check...', 'checkInstallationFilePermissions', []];
        $script[] = ['Required extensions check...', 'checkExtensions', []];
        $script[] = ['Enabling Maintenance Mode...', 'setMaintenanceMode', [1]];
        $script[] = ['Installing deployment configuration...', 'installDeploymentConfig', [$request]];
        if (!empty($request[InstallCommand::INPUT_KEY_CLEANUP_DB])) {
            $script[] = ['Cleaning up database...', 'cleanupDb', []];
        }
        $script[] = ['Installing database schema:', 'installSchema', [$request]];
        $script[] = ['Installing user configuration...', 'installUserConfig', [$request]];
        $script[] = ['Enabling caches:', 'enableCaches', []];
        $script[] = ['Installing data...', 'installDataFixtures', [$request]];
        if (!empty($request[InstallCommand::INPUT_KEY_SALES_ORDER_INCREMENT_PREFIX])) {
            $script[] = [
                'Creating sales order increment prefix...',
                'installOrderIncrementPrefix',
                [$request[InstallCommand::INPUT_KEY_SALES_ORDER_INCREMENT_PREFIX]],
            ];
        }
        if ($this->isAdminDataSet($request)) {
            $script[] = ['Installing admin user...', 'installAdminUser', [$request]];
        }

        if (!$this->isDryRun($request)) {
            $script[] = ['Caches clearing:', 'cleanCaches', [$request]];
        }
        $script[] = ['Disabling Maintenance Mode:', 'setMaintenanceMode', [0]];
        $script[] = ['Post installation file permissions check...', 'checkApplicationFilePermissions', []];
        $script[] = ['Write installation date...', 'writeInstallationDate', []];
        $estimatedModules = $this->createModulesConfig($request, true);
        $total = count($script) + 4 * count(array_filter($estimatedModules));
        $this->progress = new Installer\Progress($total, 0);

        $this->log->log('Starting Magento installation:');

        foreach ($script as $item) {
            list($message, $method, $params) = $item;
            $this->log->log($message);
            call_user_func_array([$this, $method], $params);
            $this->logProgress();
        }
        $this->log->logSuccess('Magento installation complete.');
        $this->log->logSuccess(
            'Magento Admin URI: /'
            . $this->deploymentConfig->get(BackendConfigOptionsList::CONFIG_PATH_BACKEND_FRONTNAME)
        );

        if ($this->progress->getCurrent() != $this->progress->getTotal()) {
            throw new \LogicException('Installation progress did not finish properly.');
        }
        if ($this->sampleDataState->hasError()) {
            $this->log->log('Sample Data is installed with errors. See log file for details');
        }
    }

installAdminUser()

installAdminUser

(

$data

)

Create admin account

Parameters

\ArrayObject | array

$data

Returns

void

Definition at line 1158 of file Installer.php.

    {
        if ($this->isDryRun($data)) {
            return;
        }

        $adminUserModuleIsInstalled = (bool)$this->deploymentConfig->get('modules/Magento_User');
        //Admin user data is not system data, so we need to install it only if schema for admin user was installed
        if ($adminUserModuleIsInstalled) {
            $this->assertDbConfigExists();
            $data += ['db-prefix' => $this->deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_DB_PREFIX)];
            $setup = $this->setupFactory->create($this->context->getResources());
            $adminAccount = $this->adminAccountFactory->create($setup->getConnection(), (array)$data);
            $adminAccount->save();
        }
    }

installDeploymentConfig()

installDeploymentConfig

(

$data

)

Installs deployment configuration

Parameters

\ArrayObject | array

$data

Returns

void

Definition at line 545 of file Installer.php.

    {
        $this->checkInstallationFilePermissions();
        $this->createModulesConfig($data);
        $userData = is_array($data) ? $data : $data->getArrayCopy();
        $this->setupConfigModel->process($userData);
        $deploymentConfigData = $this->deploymentConfig->get(ConfigOptionsListConstants::CONFIG_PATH_CRYPT_KEY);
        if (isset($deploymentConfigData)) {
            $this->installInfo[ConfigOptionsListConstants::KEY_ENCRYPTION_KEY] = $deploymentConfigData;
        }
        // reset object manager now that there is a deployment config
        $this->objectManagerProvider->reset();
    }

uninstall()

uninstall

(

)

Uninstall Magento application

Returns

void

Definition at line 1204 of file Installer.php.

    {
        $this->log->log('Starting Magento uninstallation:');

        try {
            $this->cleanCaches();
        } catch (\Exception $e) {
            $this->log->log(
                'Can\'t clear cache due to the following error: '
                . $e->getMessage() . PHP_EOL
                . 'To fully clean up your uninstallation, you must manually clear your cache.'
            );
        }

        $this->cleanupDb();

        $this->log->log('File system cleanup:');
        $messages = $this->cleanupFiles->clearAllFiles();
        foreach ($messages as $message) {
            $this->log->log($message);
        }

        $this->deleteDeploymentConfig();

        $this->log->logSuccess('Magento uninstallation complete.');
    }

updateModulesSequence()

updateModulesSequence

(

$keepGeneratedFiles = false

)

Updates modules in deployment configuration

Parameters

bool

$keepGeneratedFiles

Cleanup generated classes and view files and reset ObjectManager

Returns

void

Exceptions

Definition at line 1182 of file Installer.php.

    {
        $config = $this->deploymentConfig->get(ConfigOptionsListConstants::KEY_MODULES);
        if (!$config) {
            throw new \Magento\Setup\Exception(
                "Can't run this operation: deployment configuration is absent."
                . " Run 'magento setup:config:set --help' for options."
            );
        }
        $this->cleanCaches();
        if (!$keepGeneratedFiles) {
            $this->cleanupGeneratedFiles();
        }
        $this->log->log('Updating modules:');
        $this->createModulesConfig([]);
    }

Field Documentation

$sampleDataState

$sampleDataState

protected

Definition at line 217 of file Installer.php.

DATA_INSTALL

const DATA_INSTALL = \Magento\Framework\Setup\InstallDataInterface::class

Definition at line 75 of file Installer.php.

DATA_UPGRADE

const DATA_UPGRADE = \Magento\Framework\Setup\UpgradeDataInterface::class

Definition at line 76 of file Installer.php.

DISABLE_MODULES

const DISABLE_MODULES = 'disable-modules'

Definition at line 60 of file Installer.php.

ENABLE_MODULES

const ENABLE_MODULES = 'enable-modules'

#+ Parameters for enabling/disabling modules

Definition at line 59 of file Installer.php.

INFO_MESSAGE

const INFO_MESSAGE = 'message'

#-

Definition at line 79 of file Installer.php.

MYSQL_VERSION_REQUIRED

const MYSQL_VERSION_REQUIRED = '5.6.0'

The lowest supported MySQL verion

Definition at line 84 of file Installer.php.

PROGRESS_LOG_REGEX

const PROGRESS_LOG_REGEX = '/\[Progress: (\d+) \/ (\d+)\]/s'

Definition at line 67 of file Installer.php.

PROGRESS_LOG_RENDER

const PROGRESS_LOG_RENDER = '[Progress: %d / %d]'

#- #+ Formatting for progress log

Definition at line 66 of file Installer.php.

SCHEMA_INSTALL

const SCHEMA_INSTALL = \Magento\Framework\Setup\InstallSchemaInterface::class

#- #+ Instance types for schema and data handler

Definition at line 73 of file Installer.php.

SCHEMA_UPGRADE

const SCHEMA_UPGRADE = \Magento\Framework\Setup\UpgradeSchemaInterface::class

Definition at line 74 of file Installer.php.

---

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

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