ConfigWriter Class Reference

Public Member Functions
	__construct (Writer $writer, ArrayManager $arrayManager, PreparedValueFactory $valueFactory=null)
	save (array $values, $scope=ScopeConfigInterface::SCOPE_TYPE_DEFAULT, $scopeCode=null)

Detailed Description

Class ConfigWriter. Save configuration values into config file.

Definition at line 20 of file ConfigWriter.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Writer	$writer,
		ArrayManager	$arrayManager,
		PreparedValueFactory	$valueFactory = null
	)

Parameters

Writer	$writer
ArrayManager	$arrayManager
PreparedValueFactory | null	$valueFactory	Creates a prepared instance of Value

Definition at line 44 of file ConfigWriter.php.

      {
        $this->writer = $writer;
        $this->arrayManager = $arrayManager;
        $this->preparedValueFactory = $valueFactory ?: ObjectManager::getInstance()->get(PreparedValueFactory::class);
    }

Member Function Documentation

save()

save	(	array	$values,
			$scope = ScopeConfigInterface::SCOPE_TYPE_DEFAULT,
			$scopeCode = null
	)

Save given list of configuration values into config file.

Parameters

array	$values	the configuration values (path-value pairs) to be saved.
string	$scope	scope in which configuration would be saved.
string | null	$scopeCode

Returns

void

Definition at line 62 of file ConfigWriter.php.

    {
        $config = [];
        $pathPrefix = $this->getPathPrefix($scope, $scopeCode);

        $values = array_filter(
            $values,
            function ($value) {
                return $value !== null;
            }
        );

        foreach ($values as $configPath => $configValue) {
            $fullConfigPath = $pathPrefix . $configPath;
            $backendModel = $this->preparedValueFactory->create($configPath, $configValue, $scope, $scopeCode);

            if ($backendModel instanceof Value) {
                $backendModel->validateBeforeSave();
                $backendModel->beforeSave();
                $configValue = $backendModel->getValue();
                $backendModel->afterSave();
            }

            $config = $this->setConfig($config, $fullConfigPath, $configValue);
        }

        $this->writer->saveConfig(
            [ConfigFilePool::APP_ENV => $config]
        );
    }

---

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

• vendor/magento/module-deploy/Model/ConfigWriter.php