README

Задача работы библиотеки - получить данные из json или php-массива, используя схему. Схема является валидным json, в котором описывается набор строгих правил валидации для каждого узла. Если узел прошел все валидации, он копируется в результирующие данные.

Содержание

• Основные фичи
• Установка
• Простой пример
• Документация (в разработке)

Основные фичи

• подходит как для получения части данных, так и для валидации всего массива данных
• краткое и лаконичное описание правил для каждого узла
• возможность добавлять свои типы данных
• объединенный типы (union types)
• рекурсивные типы
• возможность переиспользования добавленные типы и паттерны
• набор готовых правил:
  • существование узла
  • значение по умолчанию, если узел не существует
  • тип данных узла
  • проверка на не пустое значение
  • проверка длины (строки, массивы, объекты)
  • проверка регулярным выражением
• добавление своих правил

Установка

Только необходимый код: с помощью composer

composer require rudolf-shnaps/extractorizee

Полностью: код, документация, интерактивное демо

git clone https://github.com/rudolf-shnaps/extractorizee.git

Интерактивное демо в папке examples, запускаем сервер, смотрим в браузере http://127.0.0.1:8000

cd ./extractorizee/examples
php -S 127.0.0.1:8000

Простой пример

Эти примеры не раскрывают все возможности библиотеки, побробнее смотрите документацию или интрерактивное демо. В демо есть примеры и песочница.

Для JSON:

<?php

declare(strict_types=1);

use Extractorizee\Builder;

$schema = <<<json
{
    "template":
    {
        "name": ["type: string", "non-empty: string"],
        "age": ["type: int"],
        "documents": ["type: list<string>"]
    }
}
json;

$data = <<<data
{
    "name": "John Doe",
    "age": 30,
    "phoneNumbers": [ "+123 (456) 777 00 88", "+123 (789) 555 00 00" ],
    "documents": [ "doc_2025.pdf", "file.pdf", "smile.jpg" ]
}
data;

$builder = new Builder();
try {
    $builder
        ->setSchema($schema)
        ->setData($data)
        ->make();

    // check warnings (see docs)
    // print_r($builder->warnings());
    if (count($builder->errors()) > 0) {
        print_r($builder->errors());
        // check struct errors (see docs)
        // print_r($builder->errors("struct"));
    } else {
        $extract = $builder->result();
        print_r($extract);
    }
}
catch(\Throwable $e) {
    // do smth
}

Для array:

<?php

declare(strict_types=1);

use Extractorizee\Builder;

$schema = <<<json
{
    "template":
    {
        "name": ["type: string", "non-empty: string"],
        "age": ["type: int"],
        "documents": ["type: list<string>"]
    }
}
json;

$data = [
    "name" =>"John Doe",
    "age" =>30,
    "phoneNumbers" => [ "+123 (456) 777 00 88", "+123 (789) 555 00 00" ],
    "documents" => [ "doc_2025.pdf", "file.pdf", "smile.jpg" ]
];

$builder = new Builder();
try {
    $builder
        ->setMode("array")
        ->setSchema($schema)
        ->setData($data)
        ->make();

    // check warnings (see docs)
    // print_r($builder->warnings());
    if (count($builder->errors()) > 0) {
        print_r($builder->errors());
        // check struct errors (see docs)
        // print_r($builder->errors("struct"));
    } else {
        $extract = $builder->result();
        print_r($extract);
    }
}
catch(\Throwable $e) {
    // do smth
}

TODO

• английская версия readme
• дописать документацию и перевод на английский
• добавить правило enum
• добавить правило для работы с числами: равно, больше, меньше, диапазон