Message-ID: <860977775.2584.1485845654060.JavaMail.confluence@ip-10-127-227-164> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_2583_486903507.1485845654059" ------=_Part_2583_486903507.1485845654059 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html Criteria reference

Criteria reference

Intro

Criteria are the filters for Content and Loca= tion Search, for generic use of API Search see Search Criteria and Sort Clauses= .

A Criterion consist of two parts just like SortClause and FacetBuilder:

Criterion represents the value you use in the API, whi= le CriterionHandler deals with the business logic in= the background translating the value to something the Search engine can un= derstand.

Implementation and availability of a handler typically depends on s= earch engine capabilities and limitations, currently only Legacy (SQL)= Search Engine exists, and for instance its support for FullText and Field = Criterion is not optimal and it is advised to avoid heavy use of these unti= l future search engine arrives.

Common concepts = for most Criteria

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

 

In the Legacy search engine, the field index/sort key column is limited = to 255 characters by design.
Due to this storage limitation, searching c= ontent using the eZ Country Field Type when there are multiple countries se= lected may not return all the expected results.

 


 =

List of Criteria

The list below reflects Criteria available in the eZ\Publish\API\R= epository\Values\Content\Query\Criterion namespace (it is also possi= ble to make a= custom Criterion):

Only for LocationSearch<= /h3>
Criterion Constructor arguments description
Location\Depth >=3D 5.3/2014.03= operator (IN, E= Q, GT, GTE, LT, LTE, BETWEEN), value being the Location= depth(s) as an integer(s).
Location\IsMainLocation >=3D 5.= 3/2014.03 Whether or not the Location is a M= ain Location
value (Location\IsMainLocation::MAIN, Location\IsMainLocation::NOT_MAIN).
Location\Priority >=3D 5.3/2014= .03 Priorities are integers that can b= e used for sorting in ascending or descending order. What is higher or lowe= r priority in relation to the priority number is left to the user choice.operator (GT, GTE, LT, LTE, BETWEEN), val= ue being the location priority(s) as an integer(s).

Only for ContentSearch
Criterion Constructor arguments description
Depth DEPRECATED IN 5.3/2014.03 Use LocationSearch with Loca= tion\Depth, since Depth can give unpredictable results = when content has several locations.
LocationPriority DEPRECATED IN 5.3/2= 014.03 Use LocationSearch with Location\Priority, since LocationPrior= ity can give unpredictable results when content has several = locations.

Common

Criterion Constructor arguments description
ContentId value being sc= alar(s) representing the Content id.
ContentTypeGroupId value being sc= alar(s) representing the Content Typ eGroup id.
ContentTypeId value being sc= alar(s) representing the Content Type id.
ContentTypeIdentifier= >=3D 5.1/2013.01 value being st= ring(s) representing the Content Type identifier, example: "article".
DateMetadata target (= DateMetadata ::MODIFIED, DateMetad= ata ::CREATED), operator (IN, EQ, G= T, 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) re= levant for the field.
FieldRelation >=3D 5.3/2014.05<= /span> 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 provided id's. =
FullText

value being the st= ring to search for, properties is array to set additional prop= erties for use with future search engines like Solr/ElasticSearch.
LanguageCode value being string(s)= representing Language Code(s) on the Content (not on Fields), matchAlwaysAvailable >=3D 5.2/2013.11 as boolean.
LocationId value being sc= alar(s) representing the Location id.
LocationRemoteId value being st= ring(s) representing the Location Remote id.
LogicalAnd A LogicalOperator that takes array of othe= r Criteria, makes sure all Criteria match.
LogicalNot A Logic= alOperator that takes array of other Criteria, makes su= re none of the Criteria match.
LogicalOr A Logic= alOperator that takes array of other Criteria, makes su= re one of the Criteria match.
MapLocationDistance = >=3D 5.3/20= 14.03 target (= FieldDefinition identifier), operator ( IN, EQ, GT, GTE, LT, LTE, <= code> BETWEEN), distance as float(s) from a position using latitude as float, longitude<= /code> as float as arguments
MatchAll No arguments, mainly for inter= nal use when no filter or query is provided on Query object.
MatchNone No arguments, mainly= for internal use by Blocki= ngLimitation.
MoreLikeThis NOT IMPLEMENTED
ObjectStateId value being st= ring(s) representing the Content ObjectState id.
ParentLocationId

value being scalar(s) rep= resenting the Parent's Location id
RemoteId value being st= ring(s) representing the Content Remote id.
SectionId value being sc= alar(s) representing the Content Section id.
Subtree value being st= ring(s) representing the Location id in which you can filter. If the Lo= cation Id is  /1/2/20/42, you will filter everything under 42.
UserMetadata target (UserMet= adata ::OWNER , User= Metadata ::GROUP , UserMetadata ::MODIFIER), operator (IN, EQ<= /code> ), value bei= ng scalars (s) representing the User or User Gro= up id(s).
Visibility value (Visibili= ty ::VISIBLE , Visib= ility ::HIDDEN), Note: This acts o= n all assigned locations when used with ContentSearch, meaning hidden conte= nt will be returned if it has a location which is visible. Use LocationSear= ch to avoid this.

 

Related topics:
------=_Part_2583_486903507.1485845654059--