OMV\Json\Schema Class Reference

Inheritance diagram for OMV\Json\Schema:

Public Member Functions
	__construct ($schema)
	addProperty ($path, array $schema=array())
	removeProperty ($path)
	getAssoc ()
	getAssocByPath ($name)
	validate ($value, $name="")

Protected Member Functions
	validateType ($value, $schema, $name)
	validateAny ($value, $schema, $name)
	validateBoolean ($value, $schema, $name)
	validateInteger ($value, $schema, $name)
	validateNumber ($value, $schema, $name)
	validateString ($value, $schema, $name)
	validateArray ($value, $schema, $name)
	validateObject ($value, $schema, $name)
	validateNull ($value, $schema, $name)
	checkMinimum ($value, $schema, $name)
	checkMaximum ($value, $schema, $name)
	checkExclusiveMinimum ($value, $schema, $name)
	checkExclusiveMaximum ($value, $schema, $name)
	checkMinLength ($value, $schema, $name)
	checkMaxLength ($value, $schema, $name)
	checkPattern ($value, $schema, $name)
	checkFormat ($value, $schema, $name)
	checkEnum ($value, $schema, $name)
	checkMinItems ($value, $schema, $name)
	checkMaxItems ($value, $schema, $name)
	checkProperties ($value, $schema, $name)
	checkItems ($value, $schema, $name)
	checkOneOf ($value, $schema, $name)

Detailed Description

Implements a JSON schema validator.

See also

https://tools.ietf.org/html/draft-zyp-json-schema-03

http://json-schema.org/latest/json-schema-core.html

http://json-schema.org/latest/json-schema-validation.html

Constructor & Destructor Documentation

__construct()

OMV\Json\Schema::__construct

(

$schema

)

Parameters

schema

The schema as associative array in JSON schema syntax.

Member Function Documentation

addProperty()

OMV\Json\Schema::addProperty	(		$path,
		array	$schema = array()
	)

Add a new property to the schema at runtime.

Parameters

path	The path of the property, e.g. "aaa.bbb.ccc", where 'ccc' is the name of the property to add.
schema	The schema of the property to add, e.g. array("type" => "integer", "default" => 100)

checkFormat()

OMV\Json\Schema::checkFormat (   $value,   $schema,   $name  )

protected

See also

https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23

getAssoc()

OMV\Json\Schema::getAssoc ( )

final

Returns the JSON schema.

Returns

The JSON schema as associative array.

getAssocByPath()

OMV\Json\Schema::getAssocByPath (   $name )

final

Returns the JSON schema by the given path.

Returns

The JSON schema as associative array.

removeProperty()

OMV\Json\Schema::removeProperty

(

$path

)

Remove a property from the schema at runtime.

Parameters

path	The path of the property to remove.

validate()

OMV\Json\Schema::validate (   $value,   $name = ""  )

final

Validate the given value.

Parameters

value	The value to validate.
name	The JSON path of the entity to validate, e.g. 'aa.bb.cc', defaults to an empty string. Use an empty value for the root.

Returns

None.

Exceptions

---

The documentation for this class was generated from the following file:

• json/schema.inc