Interface

eZ\Publish\API\Repository\Values\Content\Query\CriterionInterface

interface CriterionInterface

Base interface for Criterion implementations.

Methods

static CriterionInterface createFromQueryBuilder(string $target, string $operator, mixed $value)

Creates a new Criterion for $target with operator $operator on $value.

Specifications[] getSpecifications()

Criterion description function.

Details

at line 25
static public CriterionInterface createFromQueryBuilder(string $target, string $operator, mixed $value)

Creates a new Criterion for $target with operator $operator on $value.

Parameters

string $target The target (field identifier for a field, metadata identifier, etc)
string $operator The criterion operator, from Criterion\Operator
mixed $value The Criterion value, either as an individual item or an array

Return Value

CriterionInterface

at line 57
public Specifications[] getSpecifications()

Criterion description function.

Returns the combination of the Criterion's supported operator/value, as an array of eZ\Publish\API\Repository\Values\Content\Query\Criterion\Operator\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 array( // The EQ operator expects a single value, either as an integer or a string new Specifications( Operator::EQ, Specifications::INPUTTYPESINGLE, array( Specifications::INPUTVALUEINTEGER, Specifications::INPUTVALUESTRING ), ), // The IN operator expects an array of values, of either integers or strings new Specifications( Operator::IN, Specifications::INPUTTYPEARRAY, array( Specifications::INPUTVALUEINTEGER, Specifications::INPUTVALUESTRING ) ) )*

Return Value

Specifications[]