Settings Class Reference

Public Member Functions
	__construct ($baseDir, array $settings)
	get ($settingName, $defaultValue=null)
	getAsBoolean ($settingName)
	getAsFile ($settingName, $defaultValue='')
	getAsConfigFile ($settingName)
	getAsMatchingPaths ($settingName)

Protected Member Functions
	_resolvePath ($relativePath)
	_resolvePathPattern ($pattern)

Detailed Description

Convenient access to the bootstrap settings

Definition at line 14 of file Settings.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$baseDir,
		array	$settings
	)

Constructor

Parameters

string	$baseDir
array	$settings

Exceptions

Definition at line 37 of file Settings.php.

    {
        if (!is_dir($baseDir)) {
            throw new \InvalidArgumentException("Base path '{$baseDir}' has to be an existing directory.");
        }
        $this->_baseDir = realpath($baseDir);
        $this->_settings = $settings;
    }

Member Function Documentation

_resolvePath()

_resolvePath (   $relativePath )

protected

Return an absolute path by a relative one without checking its validity

Parameters

string

$relativePath

Returns

string

Definition at line 130 of file Settings.php.

    {
        return $this->_baseDir . '/' . $relativePath;
    }

_resolvePathPattern()

_resolvePathPattern (   $pattern )

protected

Resolve semicolon-separated relative glob pattern(s) to matched absolute paths

Parameters

string

$pattern

Returns

array

Definition at line 141 of file Settings.php.

    {
        $result = [];
        $allPatterns = preg_split('/\s*;\s*/', trim($pattern), -1, PREG_SPLIT_NO_EMPTY);
        foreach ($allPatterns as $onePattern) {
            $onePattern = $this->_resolvePath($onePattern);
            $files = Glob::glob($onePattern, Glob::GLOB_BRACE);
            $result = array_merge($result, $files);
        }
        return $result;
    }

get()

get	(		$settingName,
			$defaultValue = null
	)

Retrieve a setting value as is

Parameters

string	$settingName
mixed	$defaultValue

Returns

mixed

Definition at line 53 of file Settings.php.

    {
        return array_key_exists($settingName, $this->_settings) ? $this->_settings[$settingName] : $defaultValue;
    }

getAsBoolean()

getAsBoolean

(

$settingName

)

Interpret a setting value as a switch and return TRUE when it equals to the string "enabled" or FALSE otherwise

Parameters

string

$settingName

Returns

bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 65 of file Settings.php.

    {
        return $this->get($settingName) === 'enabled';
    }

getAsConfigFile()

getAsConfigFile

(

$settingName

)

Interpret a setting value as a file optionally falling back to the '.dist' file and return absolute path to it

Parameters

string

$settingName

Returns

string

Exceptions

Definition at line 93 of file Settings.php.

    {
        $result = $this->getAsFile($settingName);
        if ($result !== '') {
            if (!is_file($result) && substr($result, -5) != '.dist') {
                $result .= '.dist';
            }
            if (is_file($result)) {
                return $result;
            }
        }
        throw new \Magento\Framework\Exception\LocalizedException(
            __("Setting '%1' specifies the non-existing file '%2'.", $settingName, $result)
        );
    }

getAsFile()

getAsFile	(		$settingName,
			$defaultValue = ''
	)

Interpret a setting value as a relative file name and return absolute path to it

Parameters

string	$settingName
string	$defaultValue

Returns

string

Definition at line 77 of file Settings.php.

    {
        $result = $this->get($settingName, $defaultValue);
        if ($result !== '') {
            $result = $this->_resolvePath($result);
        }
        return $result;
    }

getAsMatchingPaths()

getAsMatchingPaths

(

$settingName

)

Interpret a setting value as a semicolon-separated relative glob pattern(s) and return matched absolute paths

Parameters

string

$settingName

Returns

array

Definition at line 115 of file Settings.php.

    {
        $settingValue = $this->get($settingName, '');
        if ($settingValue !== '') {
            return $this->_resolvePathPattern($settingValue);
        }
        return [];
    }

---

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

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