Install Class Reference

Inheritance diagram for Install:

Public Member Functions
	__construct (WebLogger $logger, InstallerFactory $installerFactory, ProgressFactory $progressFactory, \Magento\Framework\Setup\SampleData\State $sampleDataState, DeploymentConfig $deploymentConfig, RequestDataConverter $requestDataConverter)
	indexAction ()
	startAction ()
	progressAction ()

Protected Attributes
	$sampleDataState

Detailed Description

Install controller

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 27 of file Install.php.

Constructor & Destructor Documentation

__construct()

__construct	(	WebLogger	$logger,
		InstallerFactory	$installerFactory,
		ProgressFactory	$progressFactory,
		\Magento\Framework\Setup\SampleData\State	$sampleDataState,
		DeploymentConfig	$deploymentConfig,
		RequestDataConverter	$requestDataConverter
	)

Default Constructor

Parameters

WebLogger	$logger
InstallerFactory	$installerFactory
ProgressFactory	$progressFactory
\Magento\Framework\Setup\SampleData\State	$sampleDataState
\Magento\Framework\App\DeploymentConfig	$deploymentConfig
RequestDataConverter	$requestDataConverter

Definition at line 69 of file Install.php.

      {
        $this->log = $logger;
        $this->installer = $installerFactory->create($logger);
        $this->progressFactory = $progressFactory;
        $this->sampleDataState = $sampleDataState;
        $this->deploymentConfig = $deploymentConfig;
        $this->requestDataConverter = $requestDataConverter;
    }

Member Function Documentation

indexAction()

indexAction

(

)

Returns

ViewModel

Definition at line 88 of file Install.php.

    {
        $view = new ViewModel;
        $view->setTerminal(true);
        return $view;
    }

progressAction()

progressAction

(

)

Checks progress of installation

Returns

JsonModel

Definition at line 132 of file Install.php.

    {
        $percent = 0;
        $success = false;
        $contents = [];
        $json = new JsonModel();

        // Depending upon the install environment and network latency, there is a possibility that
        // "progress" check request may arrive before the Install POST request. In that case
        // "install.log" file may not be created yet. Check the "install.log" is created before
        // trying to read from it.
        if (!$this->log->logfileExists()) {
            return $json->setVariables(['progress' => $percent, 'success' => true, 'console' => $contents]);
        }

        try {
            $progress = $this->progressFactory->createFromLog($this->log);
            $percent = sprintf('%d', $progress->getRatio() * 100);
            $success = true;
            $contents = $this->log->get();
            if ($this->sampleDataState->hasError()) {
                $json->setVariable('isSampleDataError', true);
            }
        } catch (\Exception $e) {
            $contents = [(string)$e];
        }
        return $json->setVariables(['progress' => $percent, 'success' => $success, 'console' => $contents]);
    }

startAction()

startAction

(

)

Index Action

Returns

JsonModel

Definition at line 100 of file Install.php.

    {
        $this->log->clear();
        $json = new JsonModel;
        try {
            $this->checkForPriorInstall();
            $content = $this->getRequest()->getContent();
            $source = $content ? $source = Json::decode($content, Json::TYPE_ARRAY) : [];
            $data = $this->requestDataConverter->convert($source);
            $this->installer->install($data);
            $json->setVariable(
                'key',
                $this->installer->getInstallInfo()[SetupConfigOptionsList::KEY_ENCRYPTION_KEY]
            );
            $json->setVariable('success', true);
            if ($this->sampleDataState->hasError()) {
                $json->setVariable('isSampleDataError', true);
            }
            $json->setVariable('messages', $this->installer->getInstallInfo()[Installer::INFO_MESSAGE]);
        } catch (\Exception $e) {
            $this->log->logError($e);
            $json->setVariable('messages', $e->getMessage());
            $json->setVariable('success', false);
        }
        return $json;
    }

Field Documentation

$sampleDataState

$sampleDataState

protected

Definition at line 47 of file Install.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Controller/Install.php