Ibexa >
Contracts >
Core >
Repository >
Values >
Content >
Query >
Criterion >
FieldRelation

FieldRelation

FieldRelation.php : 24 Copy path

Extends Criterion

A criterion that matches Content based on the relations in relation field.

This includes Relation and RelationList field types in standard installation, but also any other field type storing Relation::FIELD type relation.

Supported operators:

IN: will match if Content relates to one or more of the given ids through given relation field
CONTAINS: will match if Content relates to all of the given ids through given relation field

Properties¶

$operator ¶

Criterion.php : 23 Copy path

The operator used by the Criterion.

public string $operator

$target ¶

Criterion.php : 37 Copy path

The target used by the criteria (field, metadata...).

public string $target

$value ¶

Criterion.php : 30 Copy path

The value(s) matched by the criteria.

public array<string|int, scalar>|scalar $value

$valueData ¶

Criterion.php : 44 Copy path

Additional value data, required by some criterions, MapLocationDistance for instance.

public Value $valueData

Methods¶

__construct() ¶

Criterion.php : 60 Copy path

Performs operator validation based on the Criterion specifications returned by {@see getSpecifications()}.

public __construct(string|null $target, string|null $operator, array<string|int, scalar>|scalar $value[, Value|null $valueData = null ])

Parameters

Name	Type	Default value	Description
$target	string\|null	-	The target the Criterion applies to: metadata identifier, field identifier...
$operator	string\|null	-	The operator the Criterion uses. If null is given, will default to Operator::IN if $value is an array, Operator::EQ if it is not.
$value	array<string\|int, scalar>\|scalar	-	-
$valueData	Value\|null	null	-

getSpecifications() ¶

FieldRelation.php : 26 Copy path

Criterion description function.

public getSpecifications() : array<string|int, Specifications>

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>