PHP Класс Scalr\Tests\Functional\Api\V2\SpecSchema\Constraint\Validator

Validate SpecObject created form swagger specification with api response
С версии: 5.11 (03.12.2015)
Автор: Andrii Penchuk ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$errors array List of errors
$ignoreDiscriminatorValues array Mark test incomplete this discriminator not yet implemented
$ignoreEnumVal array List of ignore enum values in test
$ignoreRequiredVal array List of ignore required values This values is required but will not be included in response. Example privateKey in cloud credentials key based on object name in Api definitions

Открытые методы

Метод Описание
appendError ( string $property, string $message ) Add errors to this validator
check ( mixed $value, AbstractSpecObject $schema ) Invokes the validation of an element
getErrors ( ) : array
isValid ( ) : boolean

Защищенные методы

Метод Описание
checkItems ( stdClass $element, AbstractSpecObject $schema ) Check each items in element
checkObject ( stdClass $element, AbstractSpecObject $schema ) Validates an object
checkProperty ( mixed $element, Property $schema ) Check property form spec object
checkRequired ( stdClass $element, ObjectEntity $schema ) Check required element
checkSample ( stdClass $element, Property $schema ) Check each sample element
getConcreteTypes ( AbstractSpecObject $schema, string $objectName ) : boolean | AbstractSpecObject if element has concrete type return schema this element

Описание методов

appendError() публичный Метод

Add errors to this validator
public appendError ( string $property, string $message )
$property string error property
$message string error message

check() публичный Метод

Invokes the validation of an element
public check ( mixed $value, AbstractSpecObject $schema )
$value mixed value what we should check
$schema Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\AbstractSpecObject schema value generated of api specification

checkItems() защищенный Метод

Check each items in element
protected checkItems ( stdClass $element, AbstractSpecObject $schema )
$element stdClass the list of items
$schema Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\AbstractSpecObject items schema generated of api specification

checkObject() защищенный Метод

Validates an object
protected checkObject ( stdClass $element, AbstractSpecObject $schema )
$element stdClass object properties
$schema Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\AbstractSpecObject schema this object generated of api specification

checkProperty() защищенный Метод

Check property form spec object
protected checkProperty ( mixed $element, Property $schema )
$element mixed property value
$schema Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\Property property schema generated of api specification

checkRequired() защищенный Метод

Check required element
protected checkRequired ( stdClass $element, ObjectEntity $schema )
$element stdClass object with required element
$schema Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\ObjectEntity schema value generated of api specification

checkSample() защищенный Метод

Check each sample element
protected checkSample ( stdClass $element, Property $schema )
$element stdClass sample element not described in properties
$schema Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\Property schema each sample element generated of api specification

getConcreteTypes() защищенный Метод

if element has concrete type return schema this element
protected getConcreteTypes ( AbstractSpecObject $schema, string $objectName ) : boolean | AbstractSpecObject
$schema Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\AbstractSpecObject schema value generated of api specification
$objectName string concrete type name
Результат boolean | Scalr\Tests\Functional\Api\V2\SpecSchema\DataTypes\AbstractSpecObject

getErrors() публичный Метод

public getErrors ( ) : array
Результат array

isValid() публичный Метод

public isValid ( ) : boolean
Результат boolean

Описание свойств

$errors защищенное свойство

List of errors
protected array $errors
Результат array

$ignoreDiscriminatorValues защищенное статическое свойство

Mark test incomplete this discriminator not yet implemented
protected static array $ignoreDiscriminatorValues
Результат array

$ignoreEnumVal защищенное статическое свойство

List of ignore enum values in test
protected static array $ignoreEnumVal
Результат array

$ignoreRequiredVal защищенное статическое свойство

List of ignore required values This values is required but will not be included in response. Example privateKey in cloud credentials key based on object name in Api definitions
protected static array $ignoreRequiredVal
Результат array