Overview

Namespaces

  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
        • Header
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
    • Tests
      • Batch
      • Cache
      • Common
        • Cache
        • Exception
      • Http
        • Curl
        • Exception
        • Message
          • Header
      • Inflection
      • Iterator
      • Log
      • Message
      • Mock
      • Parser
        • Cookie
        • Message
      • Parsers
        • UriTemplate
      • Plugin
        • Async
        • Backoff
        • Cache
        • Cookie
          • CookieJar
        • CurlAuth
        • ErrorResponse
        • History
        • Log
        • Md5
        • Mock
        • Oauth
        • Redirect
      • Service
        • Builder
        • Command
          • LocationVisitor
            • Request
            • Response
        • Description
        • Exception
        • Mock
          • Command
            • Sub
          • Model
        • Resource
      • Stream
  • None
  • Omnipay
    • Common
      • Exception
      • Message
    • Dummy
      • Message
    • VivaPayments
      • Message
  • PHP

Classes

  • Operation
  • Parameter
  • SchemaFormatter
  • SchemaValidator
  • ServiceDescription
  • ServiceDescriptionLoader

Interfaces

  • OperationInterface
  • ServiceDescriptionInterface
  • ValidatorInterface
  • Overview
  • Namespace
  • Class
  • Tree

Class SchemaValidator

Default parameter validator

Guzzle\Service\Description\SchemaValidator implements Guzzle\Service\Description\ValidatorInterface
Namespace: Guzzle\Service\Description
Located at src/Guzzle/Service/Description/SchemaValidator.php
Methods summary
public static Guzzle\Service\Description\SchemaValidator
# getInstance( )

Returns

Guzzle\Service\Description\SchemaValidator

Codecoverageignore

public
# __construct( boolean $castIntegerToStringType = true )

Parameters

$castIntegerToStringType

Set to true to convert integers into strings when a required type is a string and the input value is an integer. Defaults to true.

public boolean
# validate( Guzzle\Service\Description\Parameter $param, mixed & $value )

Validate a value against the acceptable types, regular expressions, minimum, maximums, instanceOf, enums, etc Add default and static values to the passed in variable. If the validation completes successfully, the input must be run correctly through the matching schema's filters attribute.

Validate a value against the acceptable types, regular expressions, minimum, maximums, instanceOf, enums, etc Add default and static values to the passed in variable. If the validation completes successfully, the input must be run correctly through the matching schema's filters attribute.

Parameters

$param
Schema that is being validated against the value
$value
Value to validate and process. The value may change during this process.

Returns

boolean
Returns true if the input data is valid for the schema

Implementation of

Guzzle\Service\Description\ValidatorInterface::validate()
public array
# getErrors( )

Get the errors encountered while validating

Get the errors encountered while validating

Returns

array

Implementation of

Guzzle\Service\Description\ValidatorInterface::getErrors()
protected boolean
# recursiveProcess( Guzzle\Service\Description\Parameter $param, mixed & $value, string $path = '', integer $depth = 0 )

Recursively validate a parameter

Recursively validate a parameter

Parameters

$param
API parameter being validated
$value
Value to validate and validate. The value may change during this validate.
$path
Current validation path (used for error reporting)
$depth
Current depth in the validation validate

Returns

boolean
Returns true if valid, or false if invalid
protected string|boolean
# determineType( string $type, mixed $value )

From the allowable types, determine the type that the variable matches

From the allowable types, determine the type that the variable matches

Parameters

$type
Parameter type
$value
Value to determine the type

Returns

string|boolean
Returns the matching type on
Properties summary
protected static Guzzle\Service\Description\SchemaValidator $instance

Cache instance of the object

Cache instance of the object

#
protected boolean $castIntegerToStringType

Whether or not integers are converted to strings when an integer is received for a string input

Whether or not integers are converted to strings when an integer is received for a string input

#
protected array $errors

Errors encountered while validating

Errors encountered while validating

#
Omnipay Viva Payments Gateway Module API Documentation API documentation generated by ApiGen