Specifications
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.
Constants¶
FORMAT_ARRAY ¶
Criterion input type description constants: array.
|
|
FORMAT_SINGLE ¶
Criterion input type description constants: single.
|
|
TYPE_BOOLEAN ¶
Criterion input value type description constants: boolean.
|
|
TYPE_INTEGER ¶
Criterion input value type description constants: integer.
|
|
TYPE_STRING ¶
Criterion input value type description constants: string.
|
|
Properties¶
$operator
¶
Specified operator, as one of the Operator::* constants.
|
|
$valueCount
¶
Limitation on the number of items as the value.
|
|
Only usable if Specifications::$valueFormat is Specifications::FORMAT_ARRAY. Not setting it means that 1...n will be required
Tags
$valueFormat
¶
Format supported for the Criterion value.
|
|
Either Specifications::FORMAT_SINGLE for single or Specifications::FORMAT_ARRAY for multiple.
Tags
$valueTypes
¶
Accepted values types, specifying what type of variables are accepted as a value.
|
|
Tags
Methods¶
__construct()
¶
Creates a new Specifications object.
|
|
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 |