weew/config-schema

Schema builder for the weew/config package.

Maintainers

Details

github.com/weew/config-schema

Source

Issues

Installs: 109

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

v1.4.2 2016-08-28 20:26 UTC

Requires

Requires (Dev)

MIT 27fc20501e297696a31a5f7158ec97693411a36e

  • Maxim Kott <maximkott.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-11-09 20:07:11 UTC

README

Build Status Code Quality Test Coverage Version Licence

Table of contents

Installation

composer require weew/config-schema

Introduction

This package allows easy config validation and is used in combination with the weew/config package.

Usage

You can describe your config schema like this:

$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.

$result = $schema->check();

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

// or

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