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

LanguageCode

LanguageCode.php : 23 Copy path

Extends Criterion

Implements FilteringCriterion

A criterion that matches content based on its language code and always-available state.

Supported operators:

IN: matches against a list of language codes
EQ: matches against one language code

Properties¶

$matchAlwaysAvailable ¶

LanguageCode.php : 30 Copy path

Switch for matching Content that is always-available.

public bool $matchAlwaysAvailable

$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() ¶

LanguageCode.php : 42 Copy path

Creates a new LanguageCode criterion.

    
                        public __construct(string|array<string|int, string> $value[, bool $matchAlwaysAvailable = true ])

Parameters

Name	Type	Default value	Description
$value	string\|array<string\|int, string>	-	One or more language codes that must be matched
$matchAlwaysAvailable	bool	true	Denotes if always-available Content is to be matched regardless of language codes, this is the default behaviour

getSpecifications() ¶

LanguageCode.php : 52 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>