A criterion that matches content based on its state.
Supported operators:
- IN: matches against a list of object state IDs
- EQ: matches against one object state ID
Properties¶
$operator
¶
Criterion.php
:
23
The operator used by the Criterion.
|
|
|
$target
¶
Criterion.php
:
37
The target used by the criteria (field, metadata...).
|
|
|
$value
¶
Criterion.php
:
30
The value(s) matched by the criteria.
|
|
|
$valueData
¶
Criterion.php
:
44
Additional value data, required by some criterions, MapLocationDistance for instance.
|
|
|
Methods¶
__construct()
¶
ObjectStateId.php
:
32
Creates a new ObjectStateId criterion.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $value | int|array<string|int, int> | - |
One or more object state IDs that must be matched |
Tags
getSpecifications()
¶
ObjectStateId.php
:
37
Criterion description function.
|
|
|
Returns the combination of the Criterion's supported operator/value, as an array of Specifications objects
- Operator is one supported Operator, as an Operator::* constant
- ValueType is the type of input value this operator requires, either array or single
- SupportedTypes is an array of types the operator will accept
- ValueCountLimitation is an integer saying how many values are expected.
// IN and EQ are supported
return [
// The EQ operator expects a single value, either as an integer or a string
new Specifications(
Operator::EQ,
Specifications::FORMAT_SINGLE,
Specifications::TYPE_INTEGER | Specifications::TYPE_STRING
),
// The IN operator expects an array of values, of either integers or strings
new Specifications(
Operator::IN,
Specifications::FORMAT_ARRAY,
Specifications::TYPE_INTEGER | Specifications::TYPE_STRING
)
]
Return values
array<string|int, Specifications>