Environment Class Reference

Inheritance diagram for Environment:

Public Member Functions
	__construct (\Magento\Framework\Setup\FilePermissions $permissions, \Magento\Framework\Filesystem $filesystem, \Magento\Setup\Model\CronScriptReadinessCheck $cronScriptReadinessCheck, \Magento\Setup\Model\PhpReadinessCheck $phpReadinessCheck)
	indexAction ()
	phpVersionAction ()
	phpSettingsAction ()
	phpExtensionsAction ()
	filePermissionsAction ()
	updaterApplicationAction ()
	cronScriptAction ()

Data Fields
const	UPDATER_DIR = 'update'

Protected Attributes
	$filesystem
	$cronScriptReadinessCheck
	$phpReadinessCheck

Detailed Description

Class Environment

Provides information and checks about the environment.

Definition at line 18 of file Environment.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Setup\FilePermissions	$permissions,
		\Magento\Framework\Filesystem	$filesystem,
		\Magento\Setup\Model\CronScriptReadinessCheck	$cronScriptReadinessCheck,
		\Magento\Setup\Model\PhpReadinessCheck	$phpReadinessCheck
	)

Constructor

Parameters

\Magento\Framework\Setup\FilePermissions	$permissions
\Magento\Framework\Filesystem	$filesystem
\Magento\Setup\Model\CronScriptReadinessCheck	$cronScriptReadinessCheck
\Magento\Setup\Model\PhpReadinessCheck	$phpReadinessCheck

Definition at line 54 of file Environment.php.

      {
        $this->permissions = $permissions;
        $this->filesystem = $filesystem;
        $this->cronScriptReadinessCheck = $cronScriptReadinessCheck;
        $this->phpReadinessCheck = $phpReadinessCheck;
    }

Member Function Documentation

cronScriptAction()

cronScriptAction

(

)

Verifies Setup and Updater Cron status

Returns

\Zend\View\Model\JsonModel

Definition at line 212 of file Environment.php.

    {
        $responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;

        $setupCheck = $this->cronScriptReadinessCheck->checkSetup();
        $updaterCheck = $this->cronScriptReadinessCheck->checkUpdater();
        $data = [];
        if (!$setupCheck['success']) {
            $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
            $data['setupErrorMessage'] = 'Error from Setup Application Cron Script:<br/>' . $setupCheck['error'];
        }
        if (!$updaterCheck['success']) {
            $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
            $data['updaterErrorMessage'] = 'Error from Updater Application Cron Script:<br/>' . $updaterCheck['error'];
        }
        if (isset($setupCheck['notice'])) {
            $data['setupNoticeMessage'] = 'Notice from Setup Application Cron Script:<br/>' . $setupCheck['notice'];
        }
        if (isset($updaterCheck['notice'])) {
            $data['updaterNoticeMessage'] = 'Notice from Updater Application Cron Script:<br/>' .
                $updaterCheck['notice'];
        }
        $data['responseType'] = $responseType;
        return new \Zend\View\Model\JsonModel($data);
    }

filePermissionsAction()

filePermissionsAction

(

)

Verifies file permissions

Returns

\Zend\View\Model\JsonModel

Definition at line 160 of file Environment.php.

    {
        $responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;
        $missingWritePermissionPaths = $this->permissions->getMissingWritablePathsForInstallation(true);

        $currentPaths = [];
        $requiredPaths = [];
        if ($missingWritePermissionPaths) {
            foreach ($missingWritePermissionPaths as $key => $value) {
                if (is_array($value)) {
                    $requiredPaths[] = ['path' => $key, 'missing' => $value];
                    $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
                } else {
                    $requiredPaths[] = ['path' => $key];
                    $currentPaths[] = $key;
                }
            }
        }
        $data = [
            'responseType' => $responseType,
            'data' => [
                'required' => $requiredPaths,
                'current' => $currentPaths,
            ],
        ];

        return new \Zend\View\Model\JsonModel($data);
    }

indexAction()

indexAction

(

)

No index action, return 404 error page

Returns

\Zend\View\Model\JsonModel

Definition at line 71 of file Environment.php.

    {
        $view = new \Zend\View\Model\JsonModel([]);
        $view->setTemplate('/error/404.phtml');
        $this->getResponse()->setStatusCode(\Zend\Http\Response::STATUS_CODE_404);
        return $view;
    }

phpExtensionsAction()

phpExtensionsAction

(

)

Verifies php verifications

Returns

\Zend\View\Model\JsonModel

Definition at line 120 of file Environment.php.

    {
        $type = $this->getRequest()->getQuery('type');

        $data = [];
        if ($type == ReadinessCheckInstaller::INSTALLER) {
            $data = $this->phpReadinessCheck->checkPhpExtensions();
        } elseif ($type == ReadinessCheckUpdater::UPDATER) {
            $data = $this->getPhpChecksInfo(ReadinessCheck::KEY_PHP_EXTENSIONS_VERIFIED);
        }
        return new \Zend\View\Model\JsonModel($data);
    }

phpSettingsAction()

phpSettingsAction

(

)

Checks PHP settings

Returns

\Zend\View\Model\JsonModel

Definition at line 102 of file Environment.php.

    {
        $type = $this->getRequest()->getQuery('type');

        $data = [];
        if ($type == ReadinessCheckInstaller::INSTALLER) {
            $data = $this->phpReadinessCheck->checkPhpSettings();
        } elseif ($type == ReadinessCheckUpdater::UPDATER) {
            $data = $this->getPhpChecksInfo(ReadinessCheck::KEY_PHP_SETTINGS_VERIFIED);
        }
        return new \Zend\View\Model\JsonModel($data);
    }

phpVersionAction()

phpVersionAction

(

)

Verifies php version

Returns

\Zend\View\Model\JsonModel

Definition at line 84 of file Environment.php.

    {
        $type = $this->getRequest()->getQuery('type');

        $data = [];
        if ($type == ReadinessCheckInstaller::INSTALLER) {
            $data = $this->phpReadinessCheck->checkPhpVersion();
        } elseif ($type == ReadinessCheckUpdater::UPDATER) {
            $data = $this->getPhpChecksInfo(ReadinessCheck::KEY_PHP_VERSION_VERIFIED);
        }
        return new \Zend\View\Model\JsonModel($data);
    }

updaterApplicationAction()

updaterApplicationAction

(

)

Verifies updater application exists

Returns

\Zend\View\Model\JsonModel

Definition at line 194 of file Environment.php.

    {
        $responseType = ResponseTypeInterface::RESPONSE_TYPE_SUCCESS;

        if (!$this->filesystem->getDirectoryRead(DirectoryList::ROOT)->isExist(self::UPDATER_DIR)) {
            $responseType = ResponseTypeInterface::RESPONSE_TYPE_ERROR;
        }
        $data = [
            'responseType' => $responseType
        ];
        return new \Zend\View\Model\JsonModel($data);
    }

Field Documentation

$cronScriptReadinessCheck

$cronScriptReadinessCheck

protected

Definition at line 37 of file Environment.php.

$filesystem

$filesystem

protected

Definition at line 30 of file Environment.php.

$phpReadinessCheck

$phpReadinessCheck

protected

Definition at line 44 of file Environment.php.

UPDATER_DIR

const UPDATER_DIR = 'update'

Path to updater application

Definition at line 23 of file Environment.php.

---

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

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