Writer Class Reference

Public Member Functions
	__construct (Reader $reader, Filesystem $filesystem, ConfigFilePool $configFilePool, DeploymentConfig $deploymentConfig, Writer\FormatterInterface $formatter=null, CommentParser $commentParser=null)
	checkIfWritable ()
	saveConfig (array $data, $override=false, $pool=null, array $comments=[])

Detailed Description

Deployment configuration writer to files: env.php, config.php. @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 20 of file Writer.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Reader	$reader,
		Filesystem	$filesystem,
		ConfigFilePool	$configFilePool,
		DeploymentConfig	$deploymentConfig,
		Writer\FormatterInterface	$formatter = null,
		CommentParser	$commentParser = null
	)

Parameters

Reader	$reader
Filesystem	$filesystem
ConfigFilePool	$configFilePool
DeploymentConfig	$deploymentConfig
Writer\FormatterInterface	$formatter
CommentParser	$commentParser	The parser of comments from configuration files

Definition at line 68 of file Writer.php.

      {
        $this->reader = $reader;
        $this->filesystem = $filesystem;
        $this->configFilePool = $configFilePool;
        $this->deploymentConfig = $deploymentConfig;
        $this->formatter = $formatter ?: new Writer\PhpFormatter();
        $this->commentParser = $commentParser ?: new CommentParser($filesystem, $configFilePool);
    }

Member Function Documentation

checkIfWritable()

checkIfWritable

(

)

Check if configuration file is writable

Returns

bool

Definition at line 89 of file Writer.php.

    {
        $configDirectory = $this->filesystem->getDirectoryWrite(DirectoryList::CONFIG);
        foreach ($this->reader->getFiles() as $file) {
            if (!$configDirectory->isWritable($file)) {
                return false;
            }
        }
        return true;
    }

saveConfig()

saveConfig	(	array	$data,
			$override = false,
			$pool = null,
		array	$comments = []
	)

Saves config in specified file. $pool option is deprecated since version 2.2.0.

Usage:

saveConfig(
     [
         ConfigFilePool::APP_ENV => ['some' => 'value'],
     ],
     true,
     null,
     []
)

Parameters

array	$data	The data to be saved
bool	$override	Whether values should be overridden
string	$pool	The file pool (deprecated)
array	$comments	The array of comments

Returns

void

Exceptions

FileSystemException

@SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 124 of file Writer.php.

    {
        foreach ($data as $fileKey => $config) {
            $paths = $this->configFilePool->getPaths();

            if (isset($paths[$fileKey])) {
                $currentData = $this->reader->load($fileKey);
                $currentComments = $this->commentParser->execute($paths[$fileKey]);

                if ($currentData) {
                    if ($override) {
                        $config = array_merge($currentData, $config);
                    } else {
                        $config = array_replace_recursive($currentData, $config);
                    }
                }

                $comments = array_merge($currentComments, $comments);

                $contents = $this->formatter->format($config, $comments);
                try {
                    $writeFilePath = $paths[$fileKey];
                    $this->filesystem->getDirectoryWrite(DirectoryList::CONFIG)->writeFile($writeFilePath, $contents);
                } catch (FileSystemException $e) {
                    throw new FileSystemException(
                        new Phrase('The "%1" deployment config file isn\'t writable.', [$paths[$fileKey]])
                    );
                }
                if (function_exists('opcache_invalidate')) {
                    opcache_invalidate(
                        $this->filesystem->getDirectoryRead(DirectoryList::CONFIG)->getAbsolutePath($paths[$fileKey])
                    );
                }
            }
        }
        $this->deploymentConfig->resetData();
    }

---

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

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