README

Пакет представляет собой загрузчик конфигурационных файлов, который поддерживает PHP и JSON форматы.

Установка

Установить этот пакет можно как зависимость, используя Composer.

composer require fi1a/config

Пример загрузки и сохранения конфигурационного файла

Объект со значениями конфигурационного файла Fi1a\Config\ConfigValuesInterface можно создать с помощью фабричного метода load(), в который необходимо передать объект Fi1a\Config\Readers\ReaderInterface для чтения из файла и Fi1a\Config\Parsers\ParserInterface для парсинга:

use Fi1a\Config\Config;
use Fi1a\Config\Parsers\PHPParser;
use Fi1a\Config\Readers\FileReader;
use Fi1a\Config\Writers\FileWriter;
use Fi1a\Filesystem\Adapters\LocalAdapter;
use Fi1a\Filesystem\Filesystem;

$filesystem = new Filesystem(new LocalAdapter(__DIR__));
$file = $filesystem->factoryFile('./config.php');

$reader = new FileReader($file);
$writer = new FileWriter($file);

$parser = new PHPParser();

$config = Config::load($reader, $parser); // Fi1a\Config\ConfigValuesInterface

$config->get('path:to:value', true);
$config->set('path:to:value', 'value');

Config::write($config, $writer, $parser); // true

Пример загрузки конфигурационных файлов

Значения можно получить из нескольких файлов, используя метод Fi1a\Config\Config::batchLoad и передав массив с объектами Fi1a\Config\Readers\ReaderInterface для чтения из файла и Fi1a\Config\Parsers\ParserInterface для парсинга:

use Fi1a\Config\Config;
use Fi1a\Config\Parsers\PHPParser;
use Fi1a\Config\Readers\FileReader;
use Fi1a\Filesystem\Adapters\LocalAdapter;
use Fi1a\Filesystem\Filesystem;

$parser = new PHPParser();

$filesystem = new Filesystem(new LocalAdapter(__DIR__));

$config = Config::batchLoad([
    [
        new FileReader($filesystem->factoryFile('./config1.php')),
        $parser,
    ],
    [
        new FileReader($filesystem->factoryFile('./config2.php')),
        $parser,
    ],
    [
        new FileReader($filesystem->factoryFile('./config3.php')),
        $parser,
    ],
]); // Fi1a\Config\ConfigValuesInterface

$config->get('path:to:value', true);

Класс со значениями

Методы Fi1a\Config\Config::load и Fi1a\Config\Config::batchLoad возвращают объект Fi1a\Config\ConfigValues, реализующий интерфейс Fi1a\Collection\DataType\PathAccessInterface из пакета fi1a/collection.

Данный класс позволяет получать доступ к ключам массива по пути (foo:bar:baz).

Для создания нового объекта со значениями можно использовать метод Fi1a\Config\Config::create:

use Fi1a\Config\Config;

$register = Config::create(['foo' => ['bar' => ['baz' => 1], 'qux' => 2,],]);

$register->get('foo:bar:baz'); // 1
$register->get('foo:qux'); // 2
$register->get('foo:bar:baz:bat'); // null
$register->get('foo:bar:baz:bat', false); // false

$register->has('foo:bar'); // true
$register->has('foo:bar:baz'); // true
$register->has('foo:bar:baz:bat'); // false

Чтение

За чтение конфигураций отвечают классы, реализующие интерфейс Fi1a\Config\Readers\ReaderInterface.

Чтение конфигурационного файла

Класс Fi1a\Config\Readers\FileReader осуществляет чтение кодированной строки из файла.

Аргумент	Описание
string $filePath	Путь к файлу

use Fi1a\Config\Config;
use Fi1a\Config\Parsers\PHPParser;
use Fi1a\Config\Readers\FileReader;
use Fi1a\Filesystem\Adapters\LocalAdapter;
use Fi1a\Filesystem\Filesystem;

$filesystem = new Filesystem(new LocalAdapter(__DIR__));

$reader = new FileReader($filesystem->factoryFile('./config.php'));
$parser = new PHPParser();

$config = Config::load($reader, $parser); // Fi1a\Config\ConfigValuesInterface

$config->get('path:to:value', true);
$config->set('path:to:value', 'value');

Чтение конфигурационных файлов из директории

Класс Fi1a\Config\Readers\DirectoryReader осуществляет чтение файлов конфигураций из переданной директории по маске. Аргументы конструктора:

Аргумент	Описание
string $directoryPath	Путь до директории
string $regex	Регулярное выражение. Маска для имен файлов

use Fi1a\Config\Config;
use Fi1a\Config\Parsers\PHPParser;
use Fi1a\Config\Readers\DirectoryReader;
use Fi1a\Filesystem\Adapters\LocalAdapter;
use Fi1a\Filesystem\Filesystem;

$filesystem = new Filesystem(new LocalAdapter(__DIR__));

$reader = new DirectoryReader($filesystem->factoryFolder('.'), '/^(.+)\.config\.php$/');
$parser = new PHPParser();

$config = Config::load($reader, $parser); // Fi1a\Config\ConfigValuesInterface

$config->get('path:to:value', true);
$config->set('path:to:value', 'value');

Запись

За запись конфигураций отвечают классы реализующие интерфейс Fi1a\Config\Writers\WriterInterface.

Запись конфигурационного файла

Класс Fi1a\Config\Writers\FileWriter осуществляет запись кодированной строки в файл.

Аргумент	Описание
string $filePath	Путь для записи в файл

use Fi1a\Config\Config;
use Fi1a\Config\Parsers\PHPParser;
use Fi1a\Config\Writers\FileWriter;
use Fi1a\Filesystem\Adapters\LocalAdapter;
use Fi1a\Filesystem\Filesystem;

$filesystem = new Filesystem(new LocalAdapter(__DIR__));

$writer = new FileWriter($filesystem->factoryFile('./config.php'));

$parser = new PHPParser();

$config = Config::create(['foo' => 'bar', 'baz' => [1, 2, 3]]);

Config::write($config, $writer, $parser); // true

Кодирование

За кодирование конфигураций отвечают классы, реализующие интерфейс Fi1a\Config\Parsers\ParserInterface.

Создание объекта парсера на основе типа файла

Используя фабричный метод Fi1a\Config\Parsers\Factory::byFileType можно получить объект парсера на основе расширения файла:

use Fi1a\Config\Config;
use Fi1a\Config\Parsers\Factory;
use Fi1a\Config\Readers\FileReader;
use Fi1a\Filesystem\Adapters\LocalAdapter;
use Fi1a\Filesystem\Filesystem;

$filesystem = new Filesystem(new LocalAdapter(__DIR__));

$file = $filesystem->factoryFile('./config.json');
$reader = new FileReader($file);
$parser = Factory::byFileType($file->getPath()); // Fi1a\Config\Parsers\JSONParser

$config = Config::load($reader, $parser); // Fi1a\Config\ConfigValuesInterface

$config->get('path:to:value', true);

Кодирование в PHP формат

Для кодирование в PHP формат следует использовать класс Fi1a\Config\Parsers\PHPParser. В конструктор можно передать в качестве аргументов следующие значения:

Аргумент	Описание
string $encoding = 'UTF-8'	Кодировка
bool $useShortArraySyntax = true	Использовать короткую нотацию массивов или нет
string $indent = '4spaces'	Определяет значение отступов ('4spaces', '1tab' или ваше значение)

Пример:

use Fi1a\Config\Config;
use Fi1a\Config\Parsers\PHPParser;
use Fi1a\Config\Readers\FileReader;
use Fi1a\Config\Writers\FileWriter;
use Fi1a\Filesystem\Adapters\LocalAdapter;
use Fi1a\Filesystem\Filesystem;

$filesystem = new Filesystem(new LocalAdapter(__DIR__));

$file = $filesystem->factoryFile('./config.php');
$reader = new FileReader($file);
$writer = new FileWriter($file);
$parser = new PHPParser('UTF-8', false, '1tab');

$config = Config::load($reader, $parser); // Fi1a\Config\ConfigValuesInterface

$config->get('path:to:value', true);
$config->set('path:to:value', 'value');

Config::write($config, $writer, $parser); // true

Кодирование в JSON формат

Для кодирование в JSON формат следует использовать класс Fi1a\Config\Parsers\JSONParser. В конструктор можно передать в качестве аргументов следующие значения:

Аргумент	Описание
?int $depth = null	Максимальная глубина вложенности структуры, для которой будет производиться декодирование. По умолчанию: 512
?int $flags = null	Битовая маска из констант.