SetupInfo Class Reference

Public Member Functions
	__construct ($server, $projectRoot='')
	getUrl ()
	getProjectUrl ()
	getProjectAdminPath ()
	getDir ($projectRoot)
	isAvailable ()

Data Fields
const	PARAM_NOT_INSTALLED_URL_PATH = 'MAGE_NOT_INSTALLED_URL_PATH'
const	PARAM_NOT_INSTALLED_URL = 'MAGE_NOT_INSTALLED_URL'
const	DEFAULT_PATH = 'setup'

Detailed Description

A model for determining information about setup application

Definition at line 14 of file SetupInfo.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$server,
			$projectRoot = ''
	)

Constructor

Parameters

array	$server
string	$projectRoot

Exceptions

Definition at line 56 of file SetupInfo.php.

    {
        $this->server = $server;
        if (empty($server['DOCUMENT_ROOT'])) {
            throw new \InvalidArgumentException('DOCUMENT_ROOT variable is unavailable.');
        }
        $this->docRoot = rtrim(str_replace('\\', '/', $server['DOCUMENT_ROOT']), '/');
        $this->projectRoot = $projectRoot ?: $this->detectProjectRoot();
        $this->projectRoot = str_replace('\\', '/', $this->projectRoot);
    }

Member Function Documentation

getDir()

getDir

(

$projectRoot

)

Gets setup application directory path in the filesystem

Parameters

string

$projectRoot

Returns

string

Definition at line 136 of file SetupInfo.php.

    {
        return rtrim($projectRoot, '/') . '/' . $this->getPath();
    }

getProjectAdminPath()

getProjectAdminPath

(

)

Get the admin area path

Returns

string

Definition at line 125 of file SetupInfo.php.

    {
        return BackendFrontnameGenerator::generate();
    }

getProjectUrl()

getProjectUrl

(

)

Gets the "main" application URL

Returns

string

Definition at line 109 of file SetupInfo.php.

    {
        $isProjectInDocRoot = false !== strpos($this->projectRoot . '/', $this->docRoot . '/');
        if (empty($this->server['HTTP_HOST'])) {
            return '';
        } elseif (!$isProjectInDocRoot) {
            return 'http://' . $this->server['HTTP_HOST'] . '/';
        }
        return 'http://' . $this->server['HTTP_HOST'] . substr($this->projectRoot . '/', strlen($this->docRoot));
    }

getUrl()

getUrl

(

)

Gets setup application URL

Returns

string

Definition at line 96 of file SetupInfo.php.

    {
        if (isset($this->server[self::PARAM_NOT_INSTALLED_URL])) {
            return $this->server[self::PARAM_NOT_INSTALLED_URL];
        }
        return Request\Http::getDistroBaseUrlPath($this->server) . $this->getPath() . '/';
    }

isAvailable()

isAvailable

(

)

Checks if the setup application is available in current document root

Returns

bool

Definition at line 146 of file SetupInfo.php.

    {
        $setupDir = $this->getDir($this->projectRoot);
        $isSubDir = false !== strpos($setupDir . '/', $this->docRoot . '/');
        // Setup is not accessible from pub folder
        $setupDir = rtrim($setupDir, '/');
        $lastOccurrence = strrpos($setupDir, '/pub/setup');

        if (false !== $lastOccurrence) {
            $setupDir = substr_replace($setupDir, '/setup', $lastOccurrence, strlen('/pub/setup'));
        }

        return $isSubDir && realpath($setupDir);
    }

Field Documentation

DEFAULT_PATH

const DEFAULT_PATH = 'setup'

#- Default path relative to the project root

Definition at line 26 of file SetupInfo.php.

PARAM_NOT_INSTALLED_URL

const PARAM_NOT_INSTALLED_URL = 'MAGE_NOT_INSTALLED_URL'

Definition at line 20 of file SetupInfo.php.

PARAM_NOT_INSTALLED_URL_PATH

const PARAM_NOT_INSTALLED_URL_PATH = 'MAGE_NOT_INSTALLED_URL_PATH'

#+ Initialization parameters for redirecting if the application is not installed

Definition at line 19 of file SetupInfo.php.

---

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

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