Bootstrap Class Reference

Public Member Functions
	__construct (ObjectManagerFactory $factory, $rootDir, array $initParams)
	getParams ()
	createApplication ($type, $arguments=[])
	run (AppInterface $application)
	getObjectManager ()
	getErrorCode ()
	isDeveloperMode ()

Static Public Member Functions
static	create ($rootDir, array $initParams, ObjectManagerFactory $factory=null)
static	populateAutoloader ($rootDir, $initParams)
static	createObjectManagerFactory ($rootDir, array $initParams)
static	createFilesystemDirectoryList ($rootDir, array $initParams)
static	createFilesystemDriverPool (array $initParams)
static	createConfigFilePool ()

Data Fields
const	ERR_MAINTENANCE = 901
const	ERR_IS_INSTALLED = 902
const	PARAM_REQUIRE_MAINTENANCE = 'MAGE_REQUIRE_MAINTENANCE'
const	PARAM_REQUIRE_IS_INSTALLED = 'MAGE_REQUIRE_IS_INSTALLED'
const	DEFAULT_REQUIRE_MAINTENANCE = false
const	DEFAULT_REQUIRE_IS_INSTALLED = true
const	INIT_PARAM_FILESYSTEM_DIR_PATHS = 'MAGE_DIRS'
const	INIT_PARAM_FILESYSTEM_DRIVERS = 'MAGE_FILESYSTEM_DRIVERS'

Protected Member Functions
	assertInstalled ()
	terminate (\Exception $e)

Detailed Description

A bootstrap of Magento application

Performs basic initialization root function: injects init parameters and creates object manager Can create/run applications

@api @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Since

100.0.2

Definition at line 27 of file Bootstrap.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ObjectManagerFactory	$factory,
			$rootDir,
		array	$initParams
	)

Constructor

Parameters

ObjectManagerFactory	$factory
string	$rootDir
array	$initParams

Definition at line 205 of file Bootstrap.php.

    {
        $this->factory = $factory;
        $this->rootDir = $rootDir;
        $this->server = $initParams;
        $this->objectManager = $this->factory->create($this->server);
    }

Member Function Documentation

assertInstalled()

assertInstalled ( )

protected

Asserts whether application is installed

Returns

void

Exceptions

Definition at line 311 of file Bootstrap.php.

    {
        $isExpected = $this->getIsExpected(self::PARAM_REQUIRE_IS_INSTALLED, self::DEFAULT_REQUIRE_IS_INSTALLED);
        if (null === $isExpected) {
            return;
        }
        $isInstalled = $this->isInstalled();
        if (!$isInstalled && $isExpected) {
            $this->errorCode = self::ERR_IS_INSTALLED;
            throw new \Exception('Error: Application is not installed yet. ');
        }
        if ($isInstalled && !$isExpected) {
            $this->errorCode = self::ERR_IS_INSTALLED;
            throw new \Exception('Error: Application is already installed. ');
        }
    }

create()

static create (   $rootDir, array  $initParams, ObjectManagerFactory  $factory = null  )

static

Static method so that client code does not have to create Object Manager Factory every time Bootstrap is called

Parameters

string	$rootDir
array	$initParams
ObjectManagerFactory	$factory

Returns

Bootstrap

Definition at line 119 of file Bootstrap.php.

    {
        self::populateAutoloader($rootDir, $initParams);
        if ($factory === null) {
            $factory = self::createObjectManagerFactory($rootDir, $initParams);
        }
        return new self($factory, $rootDir, $initParams);
    }

createApplication()

createApplication	(		$type,
			$arguments = []
	)

Factory method for creating application instances

Parameters

string	$type
array	$arguments

Returns

\Magento\Framework\AppInterface

Exceptions

Definition at line 231 of file Bootstrap.php.

    {
        try {
            $application = $this->objectManager->create($type, $arguments);
            if (!($application instanceof AppInterface)) {
                throw new \InvalidArgumentException("The provided class doesn't implement AppInterface: {$type}");
            }
            return $application;
        } catch (\Exception $e) {
            $this->terminate($e);
        }
    }

createConfigFilePool()

static createConfigFilePool ( )

static

Creates instance of configuration files pool

Returns

DriverPool

Definition at line 193 of file Bootstrap.php.

    {
        return new ConfigFilePool();
    }

createFilesystemDirectoryList()

static createFilesystemDirectoryList (   $rootDir, array  $initParams  )

static

Creates instance of filesystem directory list

Parameters

string	$rootDir
array	$initParams

Returns

DirectoryList

Definition at line 164 of file Bootstrap.php.

    {
        $customDirs = [];
        if (isset($initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS])) {
            $customDirs = $initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DIR_PATHS];
        }
        return new DirectoryList($rootDir, $customDirs);
    }

createFilesystemDriverPool()

static createFilesystemDriverPool ( array  $initParams )

static

Creates instance of filesystem driver pool

Parameters

array

$initParams

Returns

DriverPool

Definition at line 179 of file Bootstrap.php.

    {
        $extraDrivers = [];
        if (isset($initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DRIVERS])) {
            $extraDrivers = $initParams[Bootstrap::INIT_PARAM_FILESYSTEM_DRIVERS];
        }
        return new DriverPool($extraDrivers);
    }

createObjectManagerFactory()

static createObjectManagerFactory (   $rootDir, array  $initParams  )

static

Creates instance of object manager factory

Parameters

string	$rootDir
array	$initParams

Returns

ObjectManagerFactory

Definition at line 149 of file Bootstrap.php.

    {
        $dirList = self::createFilesystemDirectoryList($rootDir, $initParams);
        $driverPool = self::createFilesystemDriverPool($initParams);
        $configFilePool = self::createConfigFilePool();
        return new ObjectManagerFactory($dirList, $driverPool, $configFilePool);
    }

getErrorCode()

getErrorCode

(

)

Getter for error code

Returns

int

Definition at line 386 of file Bootstrap.php.

    {
        return $this->errorCode;
    }

getObjectManager()

getObjectManager

(

)

Gets the object manager instance

Returns

\Magento\Framework\ObjectManagerInterface

Definition at line 365 of file Bootstrap.php.

    {
        return $this->objectManager;
    }

getParams()

getParams

(

)

Gets the current parameters

Returns

array

Definition at line 218 of file Bootstrap.php.

    {
        return $this->server;
    }

isDeveloperMode()

isDeveloperMode

(

)

Checks whether developer mode is set in the initialization parameters

Returns

bool

Definition at line 396 of file Bootstrap.php.

    {
        $mode = 'default';
        if (isset($this->server[State::PARAM_MODE])) {
            $mode = $this->server[State::PARAM_MODE];
        } else {
            $deploymentConfig = $this->getObjectManager()->get(DeploymentConfig::class);
            $configMode = $deploymentConfig->get(State::PARAM_MODE);
            if ($configMode) {
                $mode = $configMode;
            }
        }

        return $mode == State::MODE_DEVELOPER;
    }

populateAutoloader()

static populateAutoloader (   $rootDir,   $initParams  )

static

Populates autoloader with mapping info

Parameters

string	$rootDir
array	$initParams

Returns

void

Definition at line 135 of file Bootstrap.php.

    {
        $dirList = self::createFilesystemDirectoryList($rootDir, $initParams);
        $autoloadWrapper = AutoloaderRegistry::getAutoloader();
        Populator::populateMappings($autoloadWrapper, $dirList);
    }

run()

run

(

AppInterface

$application

)

Runs an application

Parameters

\Magento\Framework\AppInterface

$application

Returns

void

Definition at line 250 of file Bootstrap.php.

    {
        try {
            try {
                \Magento\Framework\Profiler::start('magento');
                $this->initErrorHandler();
                $this->assertMaintenance();
                $this->assertInstalled();
                $response = $application->launch();
                $response->sendResponse();
                \Magento\Framework\Profiler::stop('magento');
            } catch (\Exception $e) {
                \Magento\Framework\Profiler::stop('magento');
                $this->objectManager->get(LoggerInterface::class)->error($e->getMessage());
                if (!$application->catchException($this, $e)) {
                    throw $e;
                }
            }
        } catch (\Exception $e) {
            $this->terminate($e);
        }
    }

terminate()

terminate ( \Exception  $e )

protected

Display an exception and terminate program execution

Parameters

\Exception

$e

Returns

void @SuppressWarnings(PHPMD.ExitExpression)

Definition at line 419 of file Bootstrap.php.

    {
        if ($this->isDeveloperMode()) {
            echo $e;
        } else {
            $message = "An error has happened during application run. See exception log for details.\n";
            try {
                if (!$this->objectManager) {
                    throw new \DomainException();
                }
                $this->objectManager->get(LoggerInterface::class)->critical($e);
            } catch (\Exception $e) {
                $message .= "Could not write error message to log. Please use developer mode to see the message.\n";
            }
            echo $message;
        }
        exit(1);
    }

Field Documentation

DEFAULT_REQUIRE_IS_INSTALLED

const DEFAULT_REQUIRE_IS_INSTALLED = true

Definition at line 56 of file Bootstrap.php.

DEFAULT_REQUIRE_MAINTENANCE

const DEFAULT_REQUIRE_MAINTENANCE = false

#- #+ Default behavior of bootstrap assertions

Definition at line 55 of file Bootstrap.php.

ERR_IS_INSTALLED

const ERR_IS_INSTALLED = 902

Definition at line 33 of file Bootstrap.php.

ERR_MAINTENANCE

const ERR_MAINTENANCE = 901

#+ Possible errors that can be triggered by the bootstrap

Definition at line 32 of file Bootstrap.php.

INIT_PARAM_FILESYSTEM_DIR_PATHS

const INIT_PARAM_FILESYSTEM_DIR_PATHS = 'MAGE_DIRS'

#- Initialization parameter for custom directory paths

Definition at line 62 of file Bootstrap.php.

INIT_PARAM_FILESYSTEM_DRIVERS

const INIT_PARAM_FILESYSTEM_DRIVERS = 'MAGE_FILESYSTEM_DRIVERS'

Initialization parameter for additional filesystem drivers

Definition at line 67 of file Bootstrap.php.

PARAM_REQUIRE_IS_INSTALLED

const PARAM_REQUIRE_IS_INSTALLED = 'MAGE_REQUIRE_IS_INSTALLED'

Definition at line 49 of file Bootstrap.php.

PARAM_REQUIRE_MAINTENANCE

const PARAM_REQUIRE_MAINTENANCE = 'MAGE_REQUIRE_MAINTENANCE'

#- #+ Initialization parameters that allow control bootstrap behavior of asserting maintenance mode or is installed

Possible values:

• true – set expectation that it is required
• false – set expectation that is required not to
• null – bypass the assertion completely

If key is absent in the parameters array, the default behavior will be used

See also

DEFAULT_REQUIRE_MAINTENANCE

DEFAULT_REQUIRE_IS_INSTALLED

Definition at line 48 of file Bootstrap.php.

---

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

• vendor/magento/framework/App/Bootstrap.php