README

Zorin Configuration Language (ZCONF) Utils

PHP парсер для ZCONF, совместимый с TOML v0.4.0.

Установка

Требуется PHP >= 7.1.

Используйте Composer для установки этого пакета:

composer require localzet/zconf

Использование

Вы можете разобрать как простую строку ZCONF, так и файл .zconf:

Парсинг простой строки ZCONF:

use ZCONF\Parser;

$array = Parser::parseString('key = [1,2,3]');

print_r($array);

Парсинг файла .zconf:

use ZCONF\Parser;

$array = Parser::parseFile('example.zconf');

print_r($array);

Кроме того, методы parseString и parseFile принимают второй аргумент под названием resultAsObject для возврата результата в виде объекта на основе stdClass.

$object = Parser::parseString('key = [1,2,3]', true);

Генератор

Вы можете сгенерировать строку ZCONF с помощью класса Builder. Генератор использует fluent interface для более читаемого кода:

    use ZCONF\Builder;

    $tb = new Builder();

    $result = $tb->addComment('ZCONF file')
        ->addTable('data.string')
        ->addValue('name', "Ivan", 'Ваше имя, например')
        ->addValue('newline', "Эта строка содержит \n символ новой строки")
        ->addValue('winPath', "C:\\Users\\nodejs\\templates")
        ->addValue('literal', '@<\i\c*\s*>') // Строки, начинающиеся с '@'.
        ->addValue('unicode', 'Символ юникода: ' . json_decode('"\u03B4"'))

        ->addTable('data.bool')
        ->addValue('t', true)
        ->addValue('f', false)

        ->addTable('data.integer')
        ->addValue('positive', 25, 'Встроенный комментарий')
        ->addValue('negative', -25)

        ->addTable('data.float')
        ->addValue('positive', 25.25)
        ->addValue('negative', -25.25)

        ->addTable('data.datetime')
        ->addValue('datetime', new \Datetime())

        ->addComment('Работа с массивами')

        ->addTable('data.array')
        ->addValue('simple', array(1,2,3))
        ->addValue('multiple', array(
            array(1,2),
            array('abc', 'def'),
            array(1.1, 1.2),
            array(true, false),
            array( new \Datetime()) ))

        ->addComment('Массивы таблиц')

        ->addArrayOfTable('fruit')                            // Строка
            ->addValue('name', 'apple')
            ->addArrayOfTable('fruit.variety')
                ->addValue('name', 'red delicious')
            ->addArrayOfTable('fruit.variety')
                ->addValue('name', 'granny smith')
        ->addArrayOfTable('fruit')                            // Строка
            ->addValue('name', 'banana')
            ->addArrayOfTable('fruit.variety')
                ->addValue('name', 'plantain')
        ->getString();    // Сгенерировать строку ZCONF

Результат:

# Файл ZCONF

[data.string]
name = "ZCONF" # Ваше имя, например
newline = "Эта строка содержит \n символ новой строки"
winPath = "C:\\Users\\nodejs\\templates"
literal = '<\i\c*\s*>'
unicode = "Символ юникода: δ"

[data.bool]
t = true
f = false

[data.integer]
positive = 25 # Встроенный комментарий
negative = -25

[data.float]
positive = 25.25
negative = -25.25

[data.datetime]
datetime = 2024-06-26T21:12:48Z

# Работа с массивами

[data.array]
simple = [1, 2, 3]
multiple = [[1, 2], ["abc", "def"], [1.1, 1.2], [true, false], [2024-06-26T21:12:48Z]]

# Массивы таблиц

[[fruit]]
name = "apple"

[[fruit.variety]]
name = "red delicious"

[[fruit.variety]]
name = "granny smith"

[[fruit]]
name = "banana"

[[fruit.variety]]
name = "plantain"

Ограничения

Класс Builder - это утилита для получения строк ZCONF, которая имеет следующие ограничения:

Принимает только базовые строки и литеральные строки.

Лицензия

Эта библиотека является программным обеспечением с открытым исходным кодом, лицензированным в соответствии с лицензией MIT.

localzet / zconf

Maintainers

Details