Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
     Glossary
   eZ Publish 4.x / legacy

 
eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: adding subtree details

...

CriterionConstructor arguments description
ContentIdvalue being scalar(s) representing the Content id.
ContentTypeGroupIdvalue being scalar(s) representing the ContentTypeGroup id.
ContentTypeIdvalue being scalar(s) representing the ContentType id.
ContentTypeIdentifier
Status
colourYellow
title>= 5.1/2013.01
value being string(s) representing the ContentType identifier, example: "article".
DateMetadatatarget (DateMetadata::MODIFIED , DateMetadata::CREATED), operator (IN, EQ, GT, GTE, LT, LTE, BETWEEN), value being integer(s) representing unix timestamp.
Field

target (FieldDefinition identifier), operator (IN, EQ, GT, GTE, LT, LTE, LIKE, BETWEEN, CONTAINS), value being scalar(s) relevant for the field.

FieldRelation
Status
colourYellow
title>= 5.3/2014.05
target (FieldDefinition identifier), operator (IN, CONTAINS), value being array of scalars representing Content id of relation.
Use of IN means relation needs to have one of the provided ID's, while CONTAINS implies it needs to have all provide id's.
FullText

value being the string to search for, properties is array to set additional properties for use with future search engines like Solr/ElasticSearch.

LanguageCodevalue being string(s) representing Language Code(s) on the Content (not on Fields), matchAlwaysAvailable
Status
colourYellow
title>= 5.2/2013.11
as boolean.
LocationIdvalue being scalar(s) representing the Location id.
LocationRemoteIdvalue being string(s) representing the Location Remote id.
LogicalAndA LogicalOperator that takes array of other Criteria, makes sure all Criteria matches.
LogicalNotA LogicalOperator that takes array of other Criteria, makes sure none of the Criteria matches.
LogicalOrA LogicalOperator that takes array of other Criteria, makes sure one of the Criteria matches.
MapLocationDistance
Status
colourYellow
title>= 5.3/2014.03
target (FieldDefinition identifier), operator (IN, EQ, GT, GTE, LT, LTE, BETWEEN), distance as float(s), latitude as float, longitude as float.
MatchAllNo arguments, mainly for internal use when no filter or query is provided on Query object.
MatchNoneNo arguments, mainly for internal use by BlockingLimitation.
MoreLikeThis
Status
colourRed
titlenot implemented
ObjectStateIdvalue being string(s) representing the Content ObjectState id.
ParentLocationId

value being scalar(s) representing the Parent's Location id

RemoteIdvalue being string(s) representing the Content Remote id.
SectionIdvalue being scalar(s) representing the Content Section id.
Subtreevalue being string(s) representing the Location id in which you can filter. If the Location Id is  /1/2/20/42, you will filter everything under 42.
UserMetadatatarget (UserMetadata::OWNER , UserMetadata::GROUP, UserMetadata::MODIFIER), operator (IN, EQ), value being scalars(s) representing the User or UserGroup id(s).
Visibilityvalue (Visibility::VISIBLE , Visibility::HIDDEN), Note: This acts on all assigned locations when used with ContentSearch, meaning hidden content will be returned if it has a location which is visible. Use LocationSearch to avoid this.