Sort Clauses reference

Intro

Sort Clauses are the sorting options for = Content and Location Search in eZ Platform. For generic use of API Search s= ee Searc= h Criteria and Sort Clauses.

A Sort Clause consists of two parts just like Criterion and FacetBuilder:

The API Value: SortClause
Specific handler per search engine: SortClausesHandler

The SortClause represents the value you use in th= e API, while SortClauseHandler deals with th= e business logic in the background, translating the value to something the = Search engine can understand.

Implementation and availability of a handler sometimes depends on s= earch engine capabilities and limitations.

Common conc= epts for all Sort Clauses

For how to use each and every Sort Clause, see list below a= s it depends on the Sort Clause Value constructor, but in general you should be aware of the following common concept:=

sortDirection: The direction to perform the sort, eithe= r Query::SORT_ASC (default) o= r Query:: SORT_DESC

List of Sort C= lauses

The list below reflects Sort Clauses available in the = eZ\Publish\API\Repository\Values\Content\Query\SortClause namespace (it is also possible to make a custom Sort Clause):

Arguments starting with "?" are optional.

Only for LocationSear= ch

Sort Clause	Constructor arguments description
`Location\Depth` >=3D 5.3/2014.03=	?`sortDirection`
`Location\Id <= /code> >=3D= 5.3/2014.03`	?`sortDirection<= /code>`
`Location\IsMainLocation >=3D 5.= 3/2014.03`	?`sortDirection<= /code>`
`Location\Depth` >= =3D 5.3/2014.03	?`sortDirection<= /code>`
`Location\Priori= ty` >=3D 5.3/2014.03	?`sortDirection<= /code>`
`Location\Visibility` = >=3D 5.3/20= 14.03	?`sortDirection`

Only for ContentSearch=

Sort Clause	Constructor arguments description
`LocationDepth` DEPRECATED IN 5.3/2014= .03	Use LocationSearch with `Loca= tion\Depth`, since `LocationDepth` can give unpredictable = results when content has several Locations.
`LocationPath =` DEPRECAT= ED IN 5.3/2014.03
`LocationPathString` DE= PRECATED IN 5.3/2014.03
`LocationPriority` DEPRECATED IN 5.3/2= 014.03	Use LocationSearch with `Location\Priority`, since `LocationPrior= ity` can give unpredictable results when content has several L= ocations.

Common

Sort Clause	Constructor arguments description
`ContentId`	`?sortDirection`
`ContentName`	`?sortDirection`=
`DateModified`	`?sortDirection`
`DatePublished =`	`?sortDirection`
`Field`	`typeIdentifier` as = string`, fieldIdentifier` as string`, ?sortDirection, ?languageCode >=3D 5.3/2014.01` as string
`MapLocationDistance` = >=3D 5.3/20= 14.03	`typeIdentifier`= as string `, fieldIdentifier` as string `,` `latitude` as = float `,` `longitu= de` as float, ? `sor= tDirection, ?languageCode` as string
`SectionIdentifier`	?`sortDirection`
`SectionName`	?`sortDirection`