hasbridge / php-json-schema Goto Github PK

PHP 5.3 implementation of json schema validation.

License: MIT License

PHP 100.00%

php-json-schema's Introduction

This library provides JSON schema validation using the schema found at http://json-schema.org. Note that it is not yet feature complete, but does support basic validation. The JSON schema draft can be found at http://tools.ietf.org/html/draft-zyp-json-schema-03

Requirements

PHP 5.3 or greater (requires namespace and closure support)

Usage

$someJson = '{"foo":"bar"}';
$jsonObject = json_decode($someJson);

$validator = new JsonValidator('/path/to/yourschema.json');

$validator->validate($jsonObject);

Supported Types

Types may be defined as either a single string type name, or an array of allowable type names.

string
number
integer
boolean
object
array
null
any

Supported Definitions

Not all definitions are yet supported, but here is a list of those which are:

properties (object)
additionalProperties (object)
required (all)
pattern (string)
minLength (string)
maxLength (string)
format (string, number, integer)
minimum (number, integer)
maximum (number, integer)
exclusiveMinimum (number, integer)
exclusiveMaximum (number, integer)
divisibleBy (number, integer)
enum (array)
minItems (array)
maxItems (array)
uniqueItems (array)
items (array)
disallow (all)

The following definitions are not yet supported:

patternProperties
dependencies
extends
id
$ref
$schema

php-json-schema's People

Contributors

Stargazers

Watchers

php-json-schema's Issues

Load a schema from string rather than file

The constructor only has one method of loading a schema, via a file path determined by $schemaFile. Can we allow for this to be some JSON string and not use an actual file?

Issue with additionalProperties

First of all nice job on the validator
However, I have stumbled upon an issue with the additioalProperties
Consider the below schema and data, which I tried to validate online at
https://json-schema-validator.herokuapp.com/
and it does not pass validation (as it should not)

Schema
{
"type": "object",
"properties": {
"class": {
"type": "string"
},
"meta_keywords": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"header": {
"type": "string"
},
"footer": {
"type": "string"
},
"page_title": {
"type": "string"
},
"containers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"template": {
"type": "string"
},
"columns": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "integer"
},
"uniqueItems": true
}
}
}
}
}
},
"required": [
"header",
"footer",
"page_title",
"containers"
]
}

data
{"page_title":"wefewfw","meta_keywords":"","meta_description":"","containers":[{"id":1412867034986,"template":"6-6","columns":{"column1":["13"],"column2":["14"]}}],"header":"10","footer":"9"}

However, when I use your class it passes.

Regards

Array of objects

Hi!

Thanks for this project! Really cool!
I'm facing some problems with array of objects(looks like the property is ignored in this situation). Does php-json-schema support this feature?

Regards,
Matheus

"oneOf" schema operator

Any chance of implementing a "oneOf" operator?

See: http://stackoverflow.com/questions/25014650/json-schema-example-for-oneof-objects

Merge with justinrainbow/json-schema

I just found this on packagist. I have contributed to justinrainbow/json-schema in the past because we needed it for composer.

I want to propose merging the two projects.

I'm not against competition, but if we can agree and join forces it's a huge win imo. Especially for projects that are as similar as these. If you could bring your expertise into the json-schema project, that would be huge imo.

It would also show the PHP community standing together, just saying.

Think about it. :)

Poke @justinrainbow @digitalkaoz

PS: Please do not take offense in this, I have great respect for you creating a json schema validator in the first place!

uniqueItems should use SORT_REGULAR flag

currently it uses default SORT_STRING flag, which coerces each array element into a string. this fails if the array elements are objects

SORT_REGULAR then compares by object properties and it works ok

check here for more explanation http://stackoverflow.com/questions/2426557/array-unique-for-objects

Please tag 0.2.1

The following code causes a bug where the minimum is not enforced if the value is 0.

php-json-schema/src/Json/Validator.php

Line 422 in 62b2bb9

if (isset($schema->minimum) && $schema->minimum) {

It has been fixed in a later commit but the latest version composer can use is 0.2.0. Please tag a 0.2.1 on master.

Nested required properties

Hi,
When I'm validating a json against a json schema which has nested required properties it's not working properly (it passes the validation test even if required properties are missing). For example this json:
{
"users": {
"name": "Roland",
"surname": "Gaski",
"ages": 100
}
}
is being validated by this json schema:
{
"type": "object",
"properties": {
"users": {
"id": "users",
"type": "object",
"properties": {
"name": {
"id": "name",
"type": "string"
},
"surname": {
"id": "surname",
"type": "string"
},
"age": {
"id": "age",
"type": "integer"
}
},
"required": [
"name",
"surname",
"age"
]
}
},
"required": [
"users"
]
}
And it passes the test, however "age" property is required so it shouldn't, is there an easy way to check nested required properties?
Thanks for help

Bug: Unique Array when array items are object fails

Please,

I think there is a bug, comparing unique array, when items are objects.

Consider:
protected function checkUniqueItems($entity, $schema, $entityName) {
if (isset($schema->uniqueItems) && $schema->uniqueItems) {
if (count(array_unique($entity)) != count($entity)) {

With this:
protected function checkUniqueItems($entity, $schema, $entityName) {
if (isset($schema->uniqueItems) && $schema->uniqueItems) {
if (count(array_unique($entity,SORT_REGULAR)) != count($entity)) {

Adding SORT_REGULAR (or perhaps depending on type of ites) flag on array_unique items

Thanks

Place exceptions into their own files

Placing the definitions of "ValidationException" and "SchemaException" inside the Validator file is no good for autoloading through Composer.

If one has not loaded instantiated the Validator class, Composer will believe it hasn't loaded the class "ValidationException" and it will attempt to find it by file. Ka boom.

Suggestion: Place the exception classes into their own files.

I can do a pull request if you want.

required

Hi
I have the validation working for the types
but when I remove a node like firstname that is required I don't get an Exception ?
isn't this supported ?
Thanks