Copied!

Specifications

Specifications.php : 18

This class is used by Criteria to describe which operators they support.

Instances of this class are returned in an array by the Criterion::getSpecifications() method

Tags
See
Criterion::getSpecifications()

Constants

publicFORMAT_ARRAY

Specifications.php : 23

Criterion input type description constants: array.

public mixed FORMAT_ARRAY = 2

publicFORMAT_SINGLE

Specifications.php : 21

Criterion input type description constants: single.

public mixed FORMAT_SINGLE = 1

publicTYPE_BOOLEAN

Specifications.php : 30

Criterion input value type description constants: boolean.

public mixed TYPE_BOOLEAN = 4

publicTYPE_INTEGER

Specifications.php : 26

Criterion input value type description constants: integer.

public mixed TYPE_INTEGER = 1

publicTYPE_STRING

Specifications.php : 28

Criterion input value type description constants: string.

public mixed TYPE_STRING = 2

Properties

public $operator

Specifications.php : 35

Specified operator, as one of the Operator::* constants.

public mixed $operator

public $valueCount

Specifications.php : 72

Limitation on the number of items as the value.

public int $valueCount

Only usable if Specifications::$valueFormat is Specifications::FORMAT_ARRAY. Not setting it means that 1...n will be required

Tags
See
Specifications::$valueFormat
See
Specifications::FORMAT_ARRAY

public $valueFormat

Specifications.php : 48

Format supported for the Criterion value.

public int $valueFormat

Either Specifications::FORMAT_SINGLE for single or Specifications::FORMAT_ARRAY for multiple.

Tags
See
Specifications::FORMAT_SINGLE
See
Specifications::FORMAT_ARRAY

public $valueTypes

Specifications.php : 59

Accepted values types, specifying what type of variables are accepted as a value.

public int $valueTypes
Tags
See
Specifications::TYPE_INTEGER
See
Specifications::TYPE_STRING
See
Specifications::TYPE_BOOLEAN

Methods

public__construct()

Specifications.php : 88

Creates a new Specifications object.

public __construct(string $operator, int $valueFormat[, int $valueTypes = null ][, int $valueCount = null ])

Parameters

Name Type Default value Description
$operator string -

The specified operator, as one of the Operator::* constants

$valueFormat int -

The accepted value format, either Specifications::FORMAT_ARRAY or Specifications::FORMAT_SINGLE

$valueTypes int null

The supported value types, as a bit field of the self::TYPE_* constants

$valueCount int null

The required number of values, when the accepted format is Specifications::FORMAT_ARRAY

Tags
See
Specifications::FORMAT_SINGLE
See
Specifications::FORMAT_ARRAY
See
Specifications::TYPE_INTEGER
See
Specifications::TYPE_STRING
See
Specifications::TYPE_BOOLEAN