Overview

Namespaces

  • Racoon
    • Api
      • Auth
      • Exception
      • Response
        • Format
        • Generate
      • Schema

Classes

  • Item
  • Schema
  • Translator
  • Overview
  • Namespace
  • Class

Class Item

Namespace: Racoon\Api\Schema
Located at Schema/Item.php
Methods summary
public
# __construct( string $propertyName, string $readableName, array $constraintGroups = [], boolean $required = true, TomWright\Validator\Constraint\ConstraintGroup $optionalConstraintGroup = null )

Item constructor.

Item constructor.

Parameters

$propertyName
$readableName
$constraintGroups
$required
$optionalConstraintGroup
public static static
# create( $propertyName, $readableName, array $constraintGroups = [], boolean $required = true, TomWright\Validator\Constraint\ConstraintGroup $optionalConstraintGroup = null )

Parameters

$propertyName
$readableName
$constraintGroups
$required
$optionalConstraintGroup

Returns

static
public boolean
# validate( stdClass $request )

Parameters

$request

Returns

boolean

Throws

Racoon\Api\Exception\InvalidArgumentException
TomWright\Validator\Exception\FailedConstraintException
public null|string
# getPropertyName( )

Returns

null|string
public
# setPropertyName( null|string $propertyName )

Parameters

$propertyName

Returns


$this
public mixed|null
# getPropertyValue( )

Returns

mixed|null
public
# setPropertyValue( mixed|null $propertyValue )

Parameters

$propertyValue

Returns


$this
public null|string
# getReadableName( )

Returns

null|string
public
# setReadableName( null|string $readableName )

Parameters

$readableName

Returns


$this
public TomWright\Validator\Validator
# getValidator( )

Returns

TomWright\Validator\Validator
public string
# getRequirements( )

Returns

string
public boolean
# isRequired( )

Returns

boolean
public
# setRequired( boolean $required )

Parameters

$required
public TomWright\Validator\Constraint\ConstraintGroup
# getOptionalConstraintGroup( )

Returns

TomWright\Validator\Constraint\ConstraintGroup
public
# setOptionalConstraintGroup( TomWright\Validator\Constraint\ConstraintGroup $optionalConstraintGroup )

Parameters

$optionalConstraintGroup
Properties summary
protected null|string $propertyName
#
protected null|mixed $propertyValue
#
protected null|string $readableName
#
protected TomWright\Validator\Validator $validator
#
protected boolean $required
#
protected TomWright\Validator\Constraint\ConstraintGroup $optionalConstraintGroup
#
API documentation generated by ApiGen