Skip to content

northphp/schema

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Schema

Build Status

A simple schema validation package.

Installation

composer require north/schema

Examples

Basic validation of an array.

use North\Schema\Schema;

$schema = new Schema([
    'name' => 'string',
    'age' => 'int',
]);

// validate input against schema.
// returns bool or throws exception.
$schema->valid([
    'name' => 'fredrik',
    'age' => 27,
]);

Class validation converts class to array and validates public properties.

use North\Schema\Schema;

class User
{
    public $name = '';

    public function __construct($o)
    {
        foreach ($o as $k => $v) {
            $this->$k = $v;
        }
    }
}

$schema = new Schema([
    'name' => 'string',
]);

// validate input against schema.
// returns bool or throws exception.
$schema->valid(
    new User([
        'name' => 'fredrik',
    ]),
);

Types

  • array
  • bool/boolean
  • callable
  • closure
  • function
  • implements (implements:INTERFACE)
  • int/integer
  • iterable
  • float
  • string
  • object
  • resources
  • type (type:CLASS)

Types can take arguments, for example for implements and type:

[
    'person' => 'type:Person',
    'implements' => 'implements:Stringable',
]

Custom types

$schema->addType('custom_string', function($value) {
    return is_string($value);
});

When using extra arguments for types you just takes in more arguments.

$schema->addType('type', function ($t, string $expected) {
    return get_class($t) === $expected;
});

More examples in the tests/SchemaTest.php

License

MIT © Fredrik Forsmo