Comment.php

Go to the documentation of this file.

<?php
namespace Magento\Config\Model\Config\Export;

use Magento\Config\App\Config\Source\DumpConfigSourceInterface;
use Magento\Config\Model\Config\TypePool;
use Magento\Config\Model\Placeholder\PlaceholderFactory;
use Magento\Config\Model\Placeholder\PlaceholderInterface;
use Magento\Framework\App\Config\CommentInterface;
use Magento\Framework\App\ObjectManager;

class Comment implements CommentInterface
{
    private $placeholder;

    private $source;

    private $typePool;

    public function __construct(
        PlaceholderFactory $placeholderFactory,
        DumpConfigSourceInterface $source,
        TypePool $typePool = null
    ) {
        $this->placeholder = $placeholderFactory->create(PlaceholderFactory::TYPE_ENVIRONMENT);
        $this->source = $source;
        $this->typePool = $typePool ?: ObjectManager::getInstance()->get(TypePool::class);
    }

    public function get()
    {
        $comments = [];

        foreach ($this->source->getExcludedFields() as $path) {
            if ($this->typePool->isPresent($path, TypePool::TYPE_SENSITIVE)) {
                $comments[] = $this->placeholder->generate($path) . ' for ' . $path;
            }
        }

        if (!empty($comments)) {
            $comments = array_merge([
                'Shared configuration was written to config.php and system-specific configuration to env.php.',
                'Shared configuration file (config.php) doesn\'t contain sensitive data for security reasons.',
                'Sensitive data can be stored in the following environment variables:'
            ], $comments);
        }

        return implode(PHP_EOL, $comments);
    }
}