Class ObjectValidator

Object validator

Phramework\Validate\ObjectValidator

Namespace: Phramework\Validate
License: Apache-2.0
Author: Xenofon Spafaridis nohponex@gmail.com
Since: 0.0.0
See:

http://json-schema.org/latest/json-schema-validation.html#anchor53 5.4. Validation keywords for objects

Todo: Implement patternProperties
Todo: Implement additionalProperties "additionalProperties": { "type": "string" }
Todo: Implement dependencies
Todo: Can it have default?
Located at ObjectValidator.php

Methods summary

`public`	# `__construct( object $properties = [], string[] $required = [], object\|boolean\|null $additionalProperties = null, integer $minProperties = 0, integer $maxProperties = null )` Parameters `$properties` [Optional] Properties `$required` [Optional] Required properties keys `$additionalProperties` [Optional] Default is null `$minProperties` [Optional] Default is 0 `$maxProperties` [Optional] Default is null Overrides `Phramework\Validate\BaseValidator::__construct`
`public Phramework\Validate\ValidateResult`	# `validate( object $value )` Validate value Validate value Parameters `$value` Value to validate Returns `Phramework\Validate\ValidateResult` See \Phramework\Validate\ValidateResult for ValidateResult object Todo clean up failure of recurvice objects
`public object`	# `parse( array\|object $value )` This method use this validator to parse data from $value argument and return a clean object This method use this validator to parse data from $value argument and return a clean object Parameters `$value` Input value to validate Returns object Throws `Phramework\Exceptions\MissingParametersException` `Phramework\Exceptions\IncorrectParametersException` Todo find out if MissingParameters add errors additionalProperties Overrides `Phramework\Validate\BaseValidator::parse`
`public`	# `addProperties( array\|\|object $properties )` Add properties to this object validator Add properties to this object validator Parameters `$properties` [description] Throws Exception If properties is not an array
`public`	# `addProperty( Phramework\Validate\BaseValidator $key, Phramework\Validate\BaseValidator $property )` Add a property to this object validator Add a property to this object validator Parameters `$key` $property `$property` Throws Exception If property key exists

Methods inherited from Phramework\Validate\BaseValidator

__get(), __set(), createFromArray(), createFromJSON(), createFromObject(), createFromObjectForAdditional(), getType(), getTypeAttributes(), parseStatic(), registerValidator(), setDefault(), setDescription(), setEnum(), setTitle(), toArray(), toJSON(), toObject(), validateCommon(), validateEnum()

Properties summary

`protected static string`	`$type` Overwrite base class type Overwrite base class type	# `'object'`
`protected static string[]`	`$typeAttributes` Validator's attributes Can be overwritten Validator's attributes Can be overwritten	# `[ 'minProperties', 'maxProperties', 'required', 'properties', 'additionalProperties' ]`

Properties inherited from Phramework\Validate\BaseValidator

$attributes, $commonAttributes, $default

Magic properties

`public integer`	`$minProperties` Minimum number of properties
`public integer\|null`	`$maxProperties` Minimum number of properties
`public object`	`$properties` Properties
`public object\|boolean\|null`	`$additionalProperties`

Namespaces

Classes

Class ObjectValidator

Methods summary

Parameters

Overrides

Parameters

Returns

See

Todo

Parameters

Returns

Throws

Todo

Overrides

Parameters

Throws

Parameters

Throws

Methods inherited from Phramework\Validate\BaseValidator

Properties summary

Properties inherited from Phramework\Validate\BaseValidator

Magic properties