Application Class Reference

Inheritance diagram for Application:

Public Member Functions
	__construct (\Magento\Framework\Shell $shell, $installDir, $installConfigFile, $globalConfigFile, $globalConfigDir, $appMode, AutoloaderInterface $autoloadWrapper, $loadTestExtensionAttributes=false)
	getDbInstance ()
	getTempDir ()
	getInitParams ()
	isInstalled ()
	reinitialize (array $overriddenParams=[])
	createInstallDir ()
	cleanup ()
	install ($cleanup)
	_customizeParams ($params)
	getArea ()
	loadArea ($areaCode)

Data Fields
const	DEFAULT_APP_AREA = 'global'

Protected Member Functions
	getInstallConfig ()
	_ensureDirExists ($dir)
	getCustomDirs ()

Protected Attributes
	$_db
	$_shell
	$installConfig
	$_globalConfigDir
	$installDir
	$_configDir
	$_initParams = []
	$_appMode
	$_appArea = null
	$_primaryConfigData = []
	$_factory
	$dirList
	$dumpDb = true
	$canLoadArea = true
	$canInstallSequence = true

Detailed Description

Encapsulates application installation, initialization and uninstall.

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

Definition at line 21 of file Application.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Shell	$shell,
			$installDir,
			$installConfigFile,
			$globalConfigFile,
			$globalConfigDir,
			$appMode,
		AutoloaderInterface	$autoloadWrapper,
			$loadTestExtensionAttributes = false
	)

Constructor.

Parameters

\Magento\Framework\Shell	$shell
string	$installDir
array	$installConfigFile
string	$globalConfigFile
string	$globalConfigDir
string	$appMode
AutoloaderInterface	$autoloadWrapper
bool | null	$loadTestExtensionAttributes

Definition at line 160 of file Application.php.

      {
        if (getcwd() != BP . '/dev/tests/integration') {
            chdir(BP . '/dev/tests/integration');
        }
        $this->_shell = $shell;
        $this->installConfigFile = $installConfigFile;
        $this->_globalConfigDir = realpath($globalConfigDir);
        $this->_appMode = $appMode;
        $this->installDir = $installDir;
        $this->loadTestExtensionAttributes = $loadTestExtensionAttributes;

        $customDirs = $this->getCustomDirs();
        $this->dirList = new \Magento\Framework\App\Filesystem\DirectoryList(BP, $customDirs);
        \Magento\Framework\Autoload\Populator::populateMappings(
            $autoloadWrapper,
            $this->dirList
        );
        $this->_initParams = [
            \Magento\Framework\App\Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS => $customDirs,
            \Magento\Framework\App\State::PARAM_MODE => $appMode
        ];
        $driverPool = new \Magento\Framework\Filesystem\DriverPool;
        $configFilePool = new \Magento\Framework\Config\File\ConfigFilePool;
        $this->_factory = new \Magento\TestFramework\ObjectManagerFactory($this->dirList, $driverPool, $configFilePool);

        $this->_configDir = $this->dirList->getPath(DirectoryList::CONFIG);
        $this->globalConfigFile = $globalConfigFile;
    }

Member Function Documentation

_customizeParams()

_customizeParams

(

$params

)

Sub-routine for merging custom parameters with the ones defined in object state

Parameters

array

$params

Returns

array

Definition at line 599 of file Application.php.

    {
        return array_replace_recursive($this->_initParams, $params);
    }

_ensureDirExists()

_ensureDirExists (   $dir )

protected

Create a directory with write permissions or don't touch existing one

Parameters

string

$dir

Returns

void

Exceptions

Definition at line 625 of file Application.php.

    {
        if (!file_exists($dir)) {
            $old = umask(0);
            mkdir($dir, 0777, true);
            umask($old);
        } elseif (!is_dir($dir)) {
            throw new \Magento\Framework\Exception\LocalizedException(__("'%1' is not a directory.", $dir));
        }
    }

cleanup()

cleanup

(

)

Cleanup both the database and the file system

Returns

void

See also

\Magento\Setup\Mvc\Bootstrap\InitParamListener::BOOTSTRAP_PARAM

Definition at line 471 of file Application.php.

    {
        $this->createInstallDir();
        $this->_shell->execute(
            PHP_BINARY . ' -f %s setup:uninstall -vvv -n --magento-init-params=%s',
            [BP . '/bin/magento', $this->getInitParamsQuery()]
        );
    }

createInstallDir()

createInstallDir

(

)

Create install dir for integration framework

Returns

void

Definition at line 458 of file Application.php.

    {
        $this->_ensureDirExists($this->installDir);
        $this->_ensureDirExists($this->_configDir);

        $this->copyAppConfigFiles();
    }

getArea()

getArea

(

)

Ge current application area

Returns

string

Definition at line 641 of file Application.php.

    {
        return $this->_appArea;
    }

getCustomDirs()

getCustomDirs ( )

protected

Gets customized directory paths

Returns

array

Definition at line 687 of file Application.php.

    {
        $path = DirectoryList::PATH;
        $var = "{$this->installDir}/var";
        $generated = "{$this->installDir}/generated";
        $customDirs = [
            DirectoryList::CONFIG => [$path => "{$this->installDir}/etc"],
            DirectoryList::VAR_DIR => [$path => $var],
            DirectoryList::MEDIA => [$path => "{$this->installDir}/pub/media"],
            DirectoryList::STATIC_VIEW => [$path => "{$this->installDir}/pub/static"],
            DirectoryList::TMP_MATERIALIZATION_DIR => [$path => "{$var}/view_preprocessed/pub/static"],
            DirectoryList::GENERATED_CODE => [$path => "{$generated}/code"],
            DirectoryList::CACHE => [$path => "{$var}/cache"],
            DirectoryList::LOG => [$path => "{$var}/log"],
            DirectoryList::SESSION => [$path => "{$var}/session"],
            DirectoryList::TMP => [$path => "{$var}/tmp"],
            DirectoryList::UPLOAD => [$path => "{$var}/upload"],
            DirectoryList::PUB => [$path => "{$this->installDir}/pub"],
        ];
        return $customDirs;
    }

getDbInstance()

getDbInstance

(

)

Retrieve the database adapter instance.

Returns

\Magento\TestFramework\Db\AbstractDb

Definition at line 203 of file Application.php.

    {
        if (null === $this->_db) {
            if ($this->isInstalled()) {
                $configPool = new \Magento\Framework\Config\File\ConfigFilePool();
                $driverPool = new \Magento\Framework\Filesystem\DriverPool();
                $reader = new Reader($this->dirList, $driverPool, $configPool);
                $deploymentConfig = new DeploymentConfig($reader, []);
                $host = $deploymentConfig->get(
                    ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT .
                    '/' . ConfigOptionsListConstants::KEY_HOST
                );
                $user = $deploymentConfig->get(
                    ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT .
                    '/' . ConfigOptionsListConstants::KEY_USER
                );
                $password = $deploymentConfig->get(
                    ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT .
                    '/' . ConfigOptionsListConstants::KEY_PASSWORD
                );
                $dbName = $deploymentConfig->get(
                    ConfigOptionsListConstants::CONFIG_PATH_DB_CONNECTION_DEFAULT .
                    '/' . ConfigOptionsListConstants::KEY_NAME
                );
            } else {
                $installConfig = $this->getInstallConfig();
                $host = $installConfig['db-host'];
                $user = $installConfig['db-user'];
                $password = $installConfig['db-password'];
                $dbName = $installConfig['db-name'];
            }
            $this->_db = new Db\Mysql(
                $host,
                $user,
                $password,
                $dbName,
                $this->getTempDir(),
                $this->_shell
            );
        }
        return $this->_db;
    }

getInitParams()

getInitParams

(

)

Retrieve application initialization parameters.

Returns

array

Definition at line 284 of file Application.php.

    {
        return $this->_initParams;
    }

getInstallConfig()

getInstallConfig ( )

protected

Gets installation parameters.

Returns

array

Definition at line 251 of file Application.php.

    {
        if (null === $this->installConfig) {
            $this->installConfig = include $this->installConfigFile;
        }
        return $this->installConfig;
    }

getTempDir()

getTempDir

(

)

Get path to temporary directory.

Returns

string

Definition at line 274 of file Application.php.

    {
        return $this->installDir;
    }

install()

install

(

$cleanup

)

Install an application

Parameters

bool

$cleanup

Returns

void

Exceptions

Definition at line 490 of file Application.php.

    {
        $dirs = \Magento\Framework\App\Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS;
        $this->_ensureDirExists($this->installDir);
        $this->_ensureDirExists($this->_configDir);
        $this->_ensureDirExists($this->_initParams[$dirs][DirectoryList::PUB][DirectoryList::PATH]);
        $this->_ensureDirExists($this->_initParams[$dirs][DirectoryList::MEDIA][DirectoryList::PATH]);
        $this->_ensureDirExists($this->_initParams[$dirs][DirectoryList::STATIC_VIEW][DirectoryList::PATH]);
        $this->_ensureDirExists($this->_initParams[$dirs][DirectoryList::VAR_DIR][DirectoryList::PATH]);

        $this->copyAppConfigFiles();

        $installParams = $this->getInstallCliParams();

        // performance optimization: restore DB from last good dump to make installation on top of it (much faster)
        // do not restore from the database if the cleanup option is set to ensure we have a clean DB to test on
        $db = $this->getDbInstance();
        if ($db->isDbDumpExists() && !$cleanup) {
            $db->restoreFromDbDump();
        }

        // run install script
        $this->_shell->execute(
            PHP_BINARY . ' -f %s setup:install -vvv ' . implode(' ', array_keys($installParams)),
            array_merge([BP . '/bin/magento'], array_values($installParams))
        );

        // enable only specified list of caches
        $initParamsQuery = $this->getInitParamsQuery();
        $this->_shell->execute(
            PHP_BINARY . ' -f %s cache:disable -vvv --bootstrap=%s',
            [BP . '/bin/magento', $initParamsQuery]
        );
        $this->_shell->execute(
            PHP_BINARY . ' -f %s cache:enable -vvv %s %s %s %s --bootstrap=%s',
            [
                BP . '/bin/magento',
                \Magento\Framework\App\Cache\Type\Config::TYPE_IDENTIFIER,
                \Magento\Framework\App\Cache\Type\Layout::TYPE_IDENTIFIER,
                \Magento\Framework\App\Cache\Type\Translate::TYPE_IDENTIFIER,
                \Magento\Eav\Model\Cache\Type::TYPE_IDENTIFIER,
                $initParamsQuery,
            ]
        );

        // right after a clean installation, store DB dump for future reuse in tests or running the test suite again
        if (!$db->isDbDumpExists() && $this->dumpDb) {
            $this->getDbInstance()->storeDbDump();
        }
    }

isInstalled()

isInstalled

(

)

Weather the application is installed or not.

Returns

bool

Definition at line 294 of file Application.php.

    {
        return is_file($this->getLocalConfig());
    }

loadArea()

loadArea

(

$areaCode

)

Load application area

Parameters

string

$areaCode

Returns

void

Exceptions

Definition at line 653 of file Application.php.

    {
        $this->_appArea = $areaCode;
        $scope = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
            \Magento\Framework\Config\Scope::class
        );
        $scope->setCurrentScope($areaCode);
        \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->configure(
            \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
                \Magento\Framework\App\ObjectManager\ConfigLoader::class
            )->load(
                $areaCode
            )
        );
        $app = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(\Magento\Framework\App\AreaList::class);
        $areasForPartialLoading = [
            \Magento\Framework\App\Area::AREA_GLOBAL,
            \Magento\Framework\App\Area::AREA_WEBAPI_REST,
            \Magento\Framework\App\Area::AREA_WEBAPI_SOAP,
            \Magento\Framework\App\Area::AREA_CRONTAB,
            \Magento\Framework\App\Area::AREA_GRAPHQL
        ];
        if (in_array($areaCode, $areasForPartialLoading, true)) {
            $app->getArea($areaCode)->load(\Magento\Framework\App\Area::PART_CONFIG);
        } else {
            \Magento\TestFramework\Helper\Bootstrap::getInstance()->loadArea($areaCode);
        }
    }

reinitialize()

reinitialize

(

array

$overriddenParams = []

)

Reset and initialize again an already installed application

Parameters

array

$overriddenParams

Returns

void

Definition at line 433 of file Application.php.

    {
        $this->_resetApp();
        $this->initialize($overriddenParams);
    }

Field Documentation

$_appArea

$_appArea = null

protected

Definition at line 96 of file Application.php.

$_appMode

$_appMode

protected

Definition at line 89 of file Application.php.

$_configDir

$_configDir

protected

Definition at line 75 of file Application.php.

$_db

$_db

protected

Definition at line 33 of file Application.php.

$_factory

$_factory

protected

Definition at line 110 of file Application.php.

$_globalConfigDir

$_globalConfigDir

protected

Definition at line 61 of file Application.php.

$_initParams

$_initParams = []

protected

Definition at line 82 of file Application.php.

$_primaryConfigData

$_primaryConfigData = []

protected

Definition at line 103 of file Application.php.

$_shell

$_shell

protected

Definition at line 40 of file Application.php.

$canInstallSequence

$canInstallSequence = true

protected

Definition at line 146 of file Application.php.

$canLoadArea

$canLoadArea = true

protected

Definition at line 141 of file Application.php.

$dirList

$dirList

protected

Definition at line 117 of file Application.php.

$dumpDb

$dumpDb = true

protected

Definition at line 136 of file Application.php.

$installConfig

$installConfig

protected

Definition at line 54 of file Application.php.

$installDir

$installDir

protected

Definition at line 68 of file Application.php.

DEFAULT_APP_AREA

const DEFAULT_APP_AREA = 'global'

Default application area.

Definition at line 26 of file Application.php.

---

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

• vendor/magento/magento2-base/dev/tests/integration/framework/Magento/TestFramework/Application.php