Criteria reference

Intro

Criteria are the filters for Content and Location Search in "Platform stack", for generic use of API Search see Search Criteria and Sort Clauses

Criteria, the plural form for Criterion, consists of two parts just like SortClause and FacetBuilder:

• The API Value: Criterion 
• Specific handler per SearchEngine: Criterion Handler

The Criterion represents the value you use in the API, while CriterionHandler deals with the business logic in the background translating the value to something the Search engine can understand.

Common concepts for most Criteria

For how to use each and every Criterion see list below as it depends on the Criterion Value constructor, but in general you should be aware of the following common concepts:

• target: Exposed if the given Criterion supports targeting a specific sub field, example: FieldDefinition or Meta Data identifier
• value: The value(s) to filter on, this is typically a  scalar or array of scalars.
• operator: Exposed on some Criteria
  • All operators can be seen as constants on eZ\Publish\API\Repository\Values\Content\Query\Criterion\Operator, at time of writing: IN, EQ, GT, GTE, LT, LTE, LIKE, BETWEEN,CONTAINS
  • Most Criteria does not expose this and selects EQ or IN depending on if value is scalar or array
  • IN & BETWEEN always acts on a array of values, while the other operators acts on single scalar value
• valueData : Additional value data, required by some criterions, MapLocationDistance for instance

List of Criteria

The list below reflects Criteria available in eZ\Publish\API\Repository\Values\Content\Query\Criterion namespace (it is also possible to make custom criterion):

Only for LocationSearch

Only for ContentSearch

Common