PHP Structure Check

, _(*1)

This library can check a complex array structure against a given requirement. The purpose of this library is to create a better experience when testing a result set from an api or something similar., _(*2)

Installation

composer require cubicl/php-structure-check

Usage

Create a requirement:, _(*3)

$requirement = new ListType(
    new ObjectType([
        'foo' => new StringType(),
        'bar' => new IntType(),
        'buzz' => new AnyType(),
        'foobar' => new NullableType(new StringType()),
        'nested' => new ObjectType([
            'foobar' => new StringType(),
        ]),
    ])
);

Have some sort of external data you want to check., _(*4)

$data = [
    [
        'foo' => 'foe',
        'bar' => 'baz',
        'buzz' => 'foe',
        'foobar' => null,
        'nested' => [
            'foobar' => 'buzz',
        ],
    ], [
        'foo' => 'foe',
        'bar' => 7,
        'buzz' => 'foe',
        'foobar' => 'baz',
        'nested' => [
            'foobar' => 'bozz',
        ],
    ], [
        'foo' => [],
        'bar' => 9.1,
        'foobar' => 'baz',
        'nested' => [
            'foobar' => 'bazz',
        ],
    ],
];

Check the data against the requirement., _(*5)

$result = Checker::fulfills($data, $requirement);

The returned object holds information about the analysis. You can check the result by calling isValid() on the result object. To fetch the errors, simply call getErrors., _(*6)

Supported Types

Currently the following types are supported:, _(*7)

Any
Nullable
Bool
Numeric
Float
Int
String
Object
List
Datetime
Regex
Optional
Enum

There are some open issues with ideas for more types. Feel free to send pull requests., _(*8)

Additionally you can implement the TypeInterface and use your own type implementations., _(*9)

Checks

Checks are special types which can be used to add more rules to a field. So you can check the length of a string, the count of elements in an array or determine if a numeric value is in a given range., _(*10)