weew/config-schema

Schema builder for the weew/config package.

Config Schema

, _(*1)

Table of contents

• Installation
• Introduction
• Usage

Installation

composer require weew/config-schema, _(*2)

Introduction

This package allows easy config validation and is used in combination with the weew/config package., _(*3)

Usage

You can describe your config schema like this:, _(*4)

$config = new Config([
    'some' => 'value',
    'items' => ['foo', 'bar'],
    'name' => 'John Doe',
]);
$schema = new ConfigSchema($config);

$schema
    ->hasValue('some')
    ->hasArray('items')->allowed(['foo', 'baz'])
    ->hasString('name')->min(3)->max(10)
;

After you've described your schema, you can either validate it, which will return you an instance of IValidationResult, or assert it, which will throw an exception., _(*5)

$result = $schema->check();

foreach ($result->getErrors() as $error) {
    echo $error->getSubject() . ' ' . $error->getMessage();
}

// or

try {
    $schema->assert();
} catch (ConfigValidationException $ex) {
    $result = $ex->getValidationResult();
}