A criterion that matches Location based on its priority.
Supported operators:
- BETWEEN: matches location whose priority is between (included) the TWO given priorities
- GT, GTE: matches location whose priority is greater than/greater than or equals the given priority
- LT, LTE: matches location whose priority is lower than/lower than or equals the given priority
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()
¶
Priority.php
:
32
Creates a new LocationPriority criterion.
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $operator | string | - |
One of the Operator constants |
| $value | mixed | - |
The match value, either as an array of as a single value, depending on the operator |
createFromQueryBuilder()
¶
Priority.php
:
51
|
|
|
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $target | mixed | - | - |
| $operator | mixed | - | - |
| $value | mixed | - | - |
Tags
getSpecifications()
¶
Priority.php
:
37
Criterion description function.
|
|
|
Returns the combination of the Criterion's supported operator/value, as an array of Specifications objects
- Specifications::$operator is a supported Operator constant.
- Specifications::$valueFormat is the type of input value this operator requires, either array (Specifications::FORMAT_ARRAY) or single (Specifications::FORMAT_SINGLE).
- Specifications::$valueTypes are bitwise flags of types the operator will accept (Specifications::TYPE_BOOLEAN, Specifications::TYPE_INTEGER, and/or Specifications::TYPE_STRING).
- Specifications::$valueCount 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<int, Specifications>