README

PHP Objects/methods that help you validate structure of complex nested PHP arrays. Like XML or JSON Schema.

use C0DE8\MatchMaker\Manager;

use C0DE8\MatchMaker\Exception\InvalidValueTypeException;
use C0DE8\MatchMaker\Exception\KeyMatcherFailException;
use C0DE8\MatchMaker\Exception\KeyMatchFailException;
use C0DE8\MatchMaker\Exception\MatcherException;
 
$books = [
    [
        'type'     => 'book',
        'title'    => 'Geography book',
        'chapters' => [
            'eu' => ['title' => 'Europe',  'interesting' => true],
            'as' => ['title' => 'America', 'interesting' => false]
        ],
        'price'    => 19.99
    ],
    [
        'type'     => 'book',
        'title'    => 'Foreign languages book',
        'chapters' => [
            'de' => ['title' => 'Deutsch']
        ],
        'price'    => 29.99
    ]
];

$pattern = [
    '*' => [
        'type'     => 'book',
        'title'    => ':string contains(book)',
        'chapters' => [
            ':string length(2) {1,3}' => [
                'title'        => ':string',
                'interesting?' => ':bool',
            ]
        ],
        'price'    => ':float'
    ]
];
 
try {
 
    (new Manager)->matchAgainst($books, $pattern); // return true (otherwise throws an exception)
 
} catch (\InvalidArgumentException $excetpion) {
 
    echo $exception->getMessage();
 
} catch (InvalidValueTypeException $excetpion) {
 
    echo $exception->getMessage();
 
} catch (KeyMatcherFailException $excetpion) {
 
    echo $exception->getMessage();
 
} catch (MatcherException $excetpion) {
 
    echo $exception->getMessage();
 
} catch (\Exception $excetpion) {
 
    echo $exception->getMessage();
}

It could be used to check scalar values, objects or arrays from different sources (JSON, XML, Post Data).

Matching rules

Matching rules are strings that start with ':' (colon). You can use multiple matchers joined with space. Matcher could be any callable (name of function or closure). You can add your own rules or replace standard ones.

General
- empty
- nonempty
- required
- in(a, b, ...)
- mixed
- any
Types
- array
- bool
- boolean
- callable
- double
- float
- int
- integer
- long
- numeric
- number
- object
- real
- resource
- scalar
- string
Numbers
- gt(n)
- gte(n)
- lt(n)
- lte(n)
- negative
- positive
- between(a, b)
Strings
- alnum
- alpha
- cntrl
- digit
- graph
- lower
- print
- punct
- space
- upper
- xdigit
- regexp(pattern)
- email
- url
- ip
- length(n)
- min(n)
- max(n)
- contains(needle)
- starts(s)
- ends(s)
- json
- date
Arrays
- count(n)
- keys(key1, key2, ...)
Objects
- instance(class)
- class_exists(className)
- property(name, value)
- method(name, value)

More details you can find here

Quantifiers for keys

! - one key required (default)
? - optional key
* - any count of keys
{3} - strict count of keys
{1,5} - range

For matchers (i.e. ':string') default quantifier is *

Installation

Install matchmaker via composer for your project:

stable

composer require c0de8/matchmaker:*

development

composer require c0de8/matchmaker:dev-master

PHPUnit

This package expects (uses) PHPUnit Version 6.x.x. Site

(but PHPUnit Version 5.x.x also works)

License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

c0de8 / matchmaker

Maintainers

Details