DeploymentConfig Class Reference

Public Member Functions
	__construct (DeploymentConfig\Reader $reader, $overrideData=[])
	get ($key=null, $defaultValue=null)
	isAvailable ()
	getConfigData ($key=null)
	resetData ()
	isDbAvailable ()

Detailed Description

Application deployment configuration

@api

Since

100.0.2

Definition at line 17 of file DeploymentConfig.php.

Constructor & Destructor Documentation

__construct()

__construct	(	DeploymentConfig\Reader	$reader,
			$overrideData = []
	)

Constructor

Data can be optionally injected in the constructor. This object's public interface is intentionally immutable

Parameters

DeploymentConfig\Reader	$reader
array	$overrideData

Definition at line 55 of file DeploymentConfig.php.

    {
        $this->reader = $reader;
        $this->overrideData = $overrideData;
    }

Member Function Documentation

get()

get	(		$key = null,
			$defaultValue = null
	)

Gets data from flattened data

Parameters

string	$key
mixed	$defaultValue

Returns

mixed|null

Definition at line 68 of file DeploymentConfig.php.

    {
        $this->load();
        if ($key === null) {
            return $this->flatData;
        }
        return $this->flatData[$key] ?? $defaultValue;
    }

getConfigData()

getConfigData

(

$key = null

)

Gets a value specified key from config data

Parameters

string

$key

Returns

null|mixed

Definition at line 95 of file DeploymentConfig.php.

    {
        $this->load();

        if ($key !== null && !isset($this->data[$key])) {
            return null;
        }

        if (isset($this->data[$key])) {
            return $this->data[$key];
        }

        return $this->data;
    }

isAvailable()

isAvailable

(

)

Checks if data available

Returns

bool

Definition at line 82 of file DeploymentConfig.php.

    {
        $this->data = null;
        $this->load();
        return isset($this->flatData[ConfigOptionsListConstants::CONFIG_PATH_INSTALL_DATE]);
    }

isDbAvailable()

isDbAvailable

(

)

Check if data from deploy files is available

Returns

bool

Since

100.1.3

Definition at line 126 of file DeploymentConfig.php.

    {
        $this->load();
        return isset($this->data['db']);
    }

resetData()

resetData

(

)

Resets config data

Returns

void

Definition at line 115 of file DeploymentConfig.php.

    {
        $this->data = null;
    }

---

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

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