eZ Find 2.6 : Template fetch functions -- Les fonctions de recherche

Date de publication: le samedi 26 novembre 2011 à 15h57
Dernière modification: par Pascal BOYER le samedi 26 novembre 2011 à 22h28

07/10/2011 1:19  

Dedicated template fetch functions were introduced in eZ Find 2.0:
Des fonctions de recherche dédiées ont été introduite à l'occasion de la sortie d'eZ Find 2.0

For example:
Par exemple:

fetch(ezfind, search, hash(<parameters>))

Returns eZ Find search results exposing the powerful features of the backend Solr.
renvoie des résultats de recherche mettant en lumière la puissance du back-end Solr.

fetch(ezfind, MoreLikeThis, hash(<parameters>))

Finds related content with heuristic techniques.
recherche de manière heuristique du contenu en rapport avec un sujet donné.

fetch(ezfind, rawSolrRequest, hash(<parameters>))

Allows for “raw” Solr requests (not for normal use, but for example to search “foreign” Solr or Lucene indexes).
permet les requêtes brutes (ne convient pas à une utilisation normale mais pour rechercher, par exemple, des index Solr ou Lucene «étrangers»)

Fetch parameters / Paramètres de recherche

Review the table for the available fetch parameters. You can click on the parameters for a more elaborate explanation and some examples, or you can scroll down this page and find the explanations and examples of all parameters.
Le tableau ci-dessous présente les paramètres de recherche disponibles. Vous pouvez soit cliquer sur un paramètre (ndt: les ancres ne fonctionnent pas avec OE 5.2) pour vous rendre directement à la description et aux exemples qui lui sont consacrés soit parcourir cet article pour découvrir les descriptions et exemples consacrés à l'ensemble des paramètres.

query

The query parameter can contain one or multiple search terms. The query is used to rank and limit the search results. For information about standard Solr query syntax, visit http://wiki.apache.org/solr/SolrQuerySyntax and http://lucene.apache.org/java/docs/queryparsersyntax.html 
Ce paramètre peut contenir un ou plusieurs termes/mots à rechercher. La requête est utilisée pour classer et limiter les résultats. Visitez les pages http://wiki.apache.org/solr/SolrQuerySyntax et http://lucene.apache.org/java/docs/queryparsersyntax.html pour consulter la documentation sur la syntaxe des requêtes standard de Solr.

Exemple:

fetch( ezfind, search, hash( query, 'eZ Systems' ) )

Renvoie:

Returns all documents containing the words “ez” and “systems”.
tous les documents contenant les mots ez et systems.

Exemple:

fetch( ezfind, search, hash( query, '”eZ Systems”' ) )

Renvoie:

Returns all documents containing the term “ez systems”.
tous les documents contenant le terme ez systems.

offset

Search result offset. The default value is “0”.
Décalage des résultats. La valeur par défaut est 0 (zéro).

Exemple:

fetch( ezfind, search, hash( query, 'eZ Systems', offset, 20 ) )

Renvoie:

Returns documents containing the words “ez” and “systems”, starting from the 20th result.
les documents contenant les mots ez et systems à partir du 20ème résultats (ndt: les résultats 0 à 19 seront ignorés)

limit

Search result count limitation. The default value is “10”.
Limite le nombre de résultats recherchés. La valeur par défaut est 10.

Exemple:

fetch( ezfind, search, hash( query, 'eZ Systems', offset, 0, limit, 25 ) )

Renvoie:

Returns the first 25 documents that contain the words “ez” and “systems”.
les 25 premiers documents contenant les mots ez et systems.

sort_by

The sort_by parameter is used to define the sort order of the search result. It supports the following options:
Ce paramètre, utilisé pour définir l'ordre de tri des résultats, supporte les options suivantes:

All sort keys can be used to sort in ascending (“asc”) or descending (“desc”) order. It is also possible to specify multiple sort options in the same fetch function.
Toutes les clefs de tri peuvent être utilisées conjointement aux ordres de tri ascendant (asc) ou descendant (desc). Il est également possible de cumuler les options de tri à l'intérieur d'une fonction de recherche.

Exemple:

fetch( ezfind, search, hash( query, 'eZ Systems', sort_by,
hash( class_name, asc, published, desc ) ) )

Renvoie:

Returns all documents containing the words “ez” and “systems”. The results are sorted by the content class name in ascending order and then by the published time in descending order.
tous les documents contenant les mots ez et systems. Les résultats seront triés par nom de classe de contenu dans l'ordre ascendant puis dans l'ordre descendant des heures de publication.

<class_attribute>

Sorting can be done based on a content class attribute field, specified by its ID number or identifier. If the content class attribute datatype extends ezfSolrDocumentFieldBase, the sub-structure can be used as well.
Le tri peut être réalisé en fonction du champ d'un attribut de classe de contenu en spécifiant le numéro de ID ou l'identifiant de cet attribut. Si le dataype lié à l'attribut de la classe étend (???) ezfSolrDocumentFieldBase, alors la sous-structure peut également être utilisée.

Exemple:

fetch( ezfind, search, hash( query, 'eZ Systems', sort_by,
hash( 'article/title', 'asc' ) ) )

Renvoie:

Returns all documents containing the words “ez” and “systems”, sorted by the article title in ascending order.
tous les documents contenant les mots ez et systems triés par titre (des articles) et dans l'ordre ascendant.

Exemple:

fetch( ezfind, search, hash( query, 'eZ Systems', sort_by, hash( 'article/options/opt1', 'asc' )))

Renvoie:

Returns all documents containing the words “ez” and “systems”, sorted by the “opt1” part of the article options.
tous les documents contenant les mots ez et systems triés en fonction de l'option opt1 des articles et dans l'ordre ascendant.

Exemple:

fetch( ezfind, search, hash( query, 'eZ Systems', sort_by, hash( 234, 'asc' ) ) )

Renvoie:

Returns all documents containing the words “ez” and “systems”, sorted by the content class attribute with an ID of “234”, in ascending order.
tous les documents contenant les mots ez et systems triés en fonction de l'attribut de classe de ID 234 et dans l'ordre ascendant.

facet

The facet parameter is used to define the facet query that should be performed. The results include information about the facets and facet groups relevant to the current search and are returned in addition to the normal query results. It is possible to perform multiple facet queries in one fetch request.
Ce paramètre est utilisé pour définir la requête à facette à traiter. Les résultats incluent des informations sur les facettes et les groupes de facettes en rapport avec la recherche courante et sont renvoyées en plus des résultats de la requête. Il est possible d'effectuer plusieurs requêtes à facettes en une seule recherche.

The following facet options are available:
Les options de facette suivantes sont disponibles:

Below are examples and more detailed descriptions of the different facet options.
Ci-dessous, des exemples et des descriptions détaillées des différentes options des facettes.

Exemple:

fetch( ezfind, search, hash( 'query', 'Cabriolet', facet',
array( hash( 'field','car/model', 'limit', 20 ) ) ) )

Renvoie:

Returns a list of 10 documents containing the word “cabriolet” and a facet list with 20 groups of car models (this is specific to “model” attributes of objects of the “car” class) also containing the word “cabriolet”.
une liste de 10 documents contenant le mot cabriolet et une liste/facette de 20 groupes de modèles de voitures (spécifique aux attributs model des objets de la classe car) contenant également le mot cabriolet.

Exemple:

fetch( ezfind, search,
hash( 'query', 'Cabriolet',
'facet', array( hash( 'field', 'car/make',
'limit', 25 ),hash( 'field', 'car/size',
'missing', true(),'limit', 25 ))))

Renvoie:

Returns a list of 10 documents containing the word “cabriolet” and one facet list with 25 groups of car makes (this is specific to “make” attributes of objects of the “car” class) and another facet list with 25 groups of car sizes (this is specific to “size” attributes of objects of the “car” class), both containing the word “cabriolet”. The “car/size” results will also list elements with 0 matching elements.
une liste de 10 documents contenant le mot cabriolet, une liste/facette de 25 groupes de marques de voitures (spécifique aux attributs make des objets de la classe car) et une autre liste/facette de 25 groupes de tailles de voitures (spécifique aux attributs size des objets de la classe car), ces deux listes/facettes contenant le mot cabriolet. Les résultats relatifs à la taille (car/size) listeront également les éléments n'ayant aucune correspondance.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
facet, array( hash( query, 'path:2' ),
hash( query, 'path:5' ) ) ) )
 

Renvoie:

Returns a list of 10 documents containing the word “cabriolet” and a facet list with groups in the subtree with a parent node with an ID of “2”, and another facet list with groups in the subtree with a parent node with an ID of “5”.
For more information about facets, see: http://wiki.apache.org/solr/SimpleFacetParameters
une liste de 10 documents contenant les mots ez et systems, une liste/facette de groupes de l'arborescence dont le nœud parent a une ID de 2 et une autre liste/facette de groupes de l'arborescence dont le nœud parent a une ID de 5.
Pour de plus amples informations sur les facettes, veuillez consulter la page http://wiki.apache.org/solr/SimpleFacetParameters

filter

The filter is used when creating faceted search templates for drill-down navigation. Filters are used to limit the search result set without altering the relevancy sort order. Facet results contain filter definitions that can be used directly. Custom filter definitions can also be created.
A filter is specified by <class_identifier>/<class_attribute>[/<sub_structure]:<value>. The filter option may be a string or list of strings.
Ce paramètre est utilisé pour créer, dans les templates, des recherches à facettes afin de réaliser une navigation de type drill down. Les filtres permettent de limiter les résultats de la recherche sans altérer la pertinence le l'ordre de tri. Les résultats/facettes contiennent des définitions de filtres pouvant être utilisées directement et il est possible de créer des définitions de filtres personnalisées.
Un filtre est spécifié par la syntaxe <class_identifier>/<class_attribute>[/<sub_structure]:<value>. L'option du filtre peut être constituée d'une ou plusieurs chaînes de caractères.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
filter, 'car/in_stock:1' ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, having the content object attribute “car/in_stock” with a value of “1”.
tous les documents contenant les mots ez et systems et correspondant à des objets de contenu de la classe car dont l'attribut in_stock vaut 1.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
filter, array( 'car/in_stock:1',
'car/make:Alfa Romeo',
'car/model:8C' ) ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, having the content object attribute “car/in_stock” with a value of “1”, the “car/make” attribute with the value “alfa romeo” and the “car/model” attribute with the value “8c”.
tous les documents contenant les mots ez et systems et correspondant à des objets de contenu de la classe car dont l'attribut in_stock vaut 1 et dont l'attribut make vaut alfa romeo et dont l'attribut model vaut 8c.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
filter, 'car/make:( Audi OR Volvo )' ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, having the content object attribute “car/make” with the value “audi” or “volvo”.
tous les documents contenant les mots ez et systems et dont l'attribut make vaut audi ou volvo.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
filter, array( 'path:2',
'contentclass_id:1' ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, in the subtree below the node with an ID of “2”, for objects of the content class with an ID of “1”.
tous les documents contenant les mots ez et systems et positionnés sous le nœud dont le ID est 2 et qui sont des instances de la classe d'objet dont le ID est 1

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
filter, array( 'or',
array( 'and',
'article/body:hello',
'article/rating:[1 TO 10]' ),
array( 'and',
'article/body:goodbye',
'article/rating:[10 TO 20]' )))
 

Renvoie:

Returns all articles containing the words “ez” and “systems”, either having both 'hello' present in the body and a rating comprised between 1 and 10, or having both 'goodbye' in the body and a rating comprised between 10 and 20.
tous les documents contenant les mots ez et systems et, soit contenant le mot hello et ayant un classement compris entre 1 et 10, soit contenant le mot goodbye et ayant un classement compris entre 10 et 20.

class_id

This parameter is used to limit the search result to specific content classes, using either their identifiers or ID numbers. This can also be achieved by using the filter functionality. class_id may be either a single value or a list of values.
Ce paramètre est utilisé pour limiter les résultats à certaines classes par le biais des identifiants ou des numéros de ID de celles-ci. Mais il est également possible d'utiliser les filtres. class_id vaut soit une valeur unique soit une liste de valeurs.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
class_id, 1 ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, for objects of the content class with an ID of “1”.
tous les documents contenant les mots ez et systems et qui sont des objets de la classe dont le ID vaut 1.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
class_id, array( 'folder', 'article' ) ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, for objects of the Folder and Article content classes.
tous les documents contenant les mots ez et systems et qui sont des objets des classes Folder ou Article.

subtree_array

This parameter is a list of node IDs that specifies which subtrees should be included in the search. The same functionality can be achieved with the filter functionality.
Ce paramètre est une liste de ID de nœuds définissant les sous-arborescences à prendre en compte pour la recherche. La même fonction peut être réalisée par le biais des filtres.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
subtree_array, array( 23, 42 ) ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, from the subtrees with parent nodes with IDs of “23” and “42”.
tous les documents contenant les mots ez et systems et placés sous les nœuds parents dont le ID vaut 23 et 42.

section_id

This parameter is a integer specifying which section should be searched. The same functionality can be achieved with the filter functionality.
Ce paramètre est un entier définissant la section dans laquelle la recherche doit être effectuée. La même fonction peut être réalisée par le biais des filtres.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
section_id, 3 ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems” in the Media section (3).
tous les documents contenant les mots ez et systems et placés dans la section Media (dont le ID vaut 3);

ignore_visibility

This parameter is a Boolean which specifies whether or not hidden nodes should be returned in the search results.
Ce paramètre est un booléen indiquant si les nœuds cachés doivent être ou non retournés avec les résultats.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
ignore_visibility, true() ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, even if they are hidden.
tous les documents contenant les mots ez et systems qu'ils soient cachés ou non.

limitation

This parameter is an associative array overriding the current user's access rights to the read-function of the content-module. The format must exactly match the return format of the eZUser::hasAccessTo() method:
Ce paramètre est un tableau associatif surchargeant les droits d'accès à la fonction read (lire) du module content de l'utilisateur courant. Le format doit correspondre exactement au format retourné par la méthode eZUser::hasAccessTo():

Array elements :
Éléments du tableau:
'accessWord', 'yes' - access allowed/accès autorisé
'no' - access denied/accès refusé
'limited' - access array describing access included/tableau d'accès décrivant l'accès inclus
'policies', array containing the policy limitations/tableau contenant les limitations de la politique de droits
'accessList', array describing missing access rights/tableau décrivant les droits d'accès manquants

Exemple:

fetch( ezfind, search,
hash( query, 'eZ Systems',
limitation, hash( 'accessWord', 'yes' ) ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”, regardless of the current user's access rights to the read-function of the content-module.
tous les documents contenant les mots ez et systems indépendamment des droits d'accès à la fonction read (lire) du module content de l'utilisateur courant.

spell_check

This parameter is an array configuring the spell check behaviour of the search. The first parameter is a Boolean value which enables or not the spellchecker. The second one is optional and is only taken into account if the first one is set to true. It contains the identifier of the dictionary to be used. For now only 'default' is supported.
The spell checking behaviour can also be controlled from ezfind.ini.
Ce paramètre est un tableau configurant le comportement de la correction d'orthographe des termes de la recherche. Le premier paramètre est une valeur booléenne qui active ou non le correcteur d'orthographe. Le second paramètre, optionnel et pris en compte uniquement si le premier est défini à true, contient l'identifiant du dictionnaire à utiliser. default est actuellement la seule valeur supportée.
Le comportement de la correction orthographique peut être également ccontrôlée via le fichier ezfind.ini

Exemple:

fetch( ezfind, search,
hash( query, 'eZy Sistems',
spell_check, array( true(), 'default' ) ) )
 

Renvoie:

Result with documents containing the words “ezy” and “sistems” and a spellcheck suggestion if Solr considered these two words as incorrectly spelled. The spellcheck feedback is placed under $search_results.SearchExtras.spellcheck and $search_results.SearchExtras.spellcheck_collation, $search_results being the result of the fetch function call.
les documents contenant les mots ezy et sistems ainsi qu'une suggestion de correction orthographique si Solr considère l'orthographe de ces deux mots incorrecte. Les suggestions orthographiques sont placées dans les variables $search_results.SearchExtras.spellcheck et $search_results.SearchExtras.spellcheck_collation, $search_results étant le résultat de l'appel de la fonction fetch.

query_handler

This parameter is a string defining which Solr search handler should be used. The possible values are listed here:
Ce paramètre est une chaîne de caractères définissant le gestionnaire Solr à utiliser. Les valeurs possibles sont présentées ci-après:

The default behaviour can be controlled from ezfind.ini, but heuristic is the most common default handler.
Le comportement par défaut peut être contrôlé par le biais du fichier ezfind.ini mais le gestionnaire heuristique constitue le choix par défaut le plus courant.

Exemple:

fetch( ezfind, search,
hash( query, 'eZ AND Publish',
query_handler, 'standard' ) )
 

Renvoie:

Returns all documents containing both words “ez” and “systems”, using the standard handler.
tous les documents contenant les mots ez et systems et utilise le gestionnaire standard.

boost_functions

This parameter is used to pass query-time boosts and is an associative array, with two keys: 'fields' and 'functions'.
Ce paramètre, utilisé pour transmettre les facteurs de pondération query-time (lors des requêtes ???), est un tableau associatif contenant deux clefs: fields et functions.

• fields accepts either an associative array or an array, placing a boost factor on given fields. See 'Example 1' and 'Example 1 bis'.
  accepte un tableau associatif ou non attribuant un facteur de boost à des champs donnés. Voir les exemples 1 et 1bis.
• functions accepts an array, containing one or more expressions. The latter is not be interpreted and must therefore comply with Solr's Function Query syntax (http://wiki.apache.org/solr/FunctionQuery). See Example 2.
  accepte un tableau contenant une ou plusieurs expressions. La dernière n'est pas interprétée et doit donc se conformer à la syntaxe de la fonction Query de Solr (http://wiki.apache.org/solr/FunctionQuery). Voir l'exemple 2.

Both can be provided simultaneously.
Les deux clefs peuvent être fournies simultanément.

Exemple 1:

fetch( ezfind, search,
hash( 'query', 'eZ Systems',
'boost_functions',
hash( 'fields',
array( 'article/title:2' ) ) )
 

Renvoie:

Returns all documents containing the words “ez” and “systems”. The articles for which the search words were found in the 'title' will be returned first.
tous les documents contenant les mots ez et systems. Les articles pour lesquels les mots recherchés ont été trouvés dans le titre (title) seront retournés en premier.

Exemple 1bis:

fetch( ezfind, search,
hash( 'query', 'eZ Systems',
'boost_functions',
hash( 'fields',
hash( 'article/title', 2 ) ) )
 

Renvoie:

Identical to Example 1.
un résultat identique à celui de l'exemple 1.

Exemple 2:

fetch( ezfind, search,
hash( 'query', 'eZ Systems',
'boost_functions',
hash( 'functions',
array( 'ord(meta_modified_dt)^2' ) ))
 

Renvoie:

Returns all documents containing the words “ez” and “systems”. The most recent documents will be returned first, the result score being influenced by the formula : 'ord(meta_modified_dt)^2'
tous les documents contenant les mots ez et systems. Les documents les plus récents seront retournés en premier, le score du résultat étant influencé par la formule 'ord(meta_modified_dt)^2'

Commentaires