La classe SolrQuery

(PECL solr >= 0.9.2)

Introduction

Représente une collection de paires nom-valeur envoyées au serveur Solr lors d'une requête.

Synopsis de la classe

SolrQuery extends SolrModifiableParams implements Serializable {

/* Constantes */

const integer ORDER_ASC = 0 ;

const integer ORDER_DESC = 1 ;

const integer FACET_SORT_INDEX = 0 ;

const integer FACET_SORT_COUNT = 1 ;

const integer TERMS_SORT_INDEX = 0 ;

const integer TERMS_SORT_COUNT = 1 ;

/* Propriétés */

/* Méthodes */

public SolrQuery addFacetDateField ( string $dateField )

public SolrQuery addFacetDateOther ( string $value [, string $field_override ] )

public SolrQuery addFacetField ( string $field )

public SolrQuery addFacetQuery ( string $facetQuery )

public SolrQuery addField ( string $field )

public SolrQuery addFilterQuery ( string $fq )

public SolrQuery addHighlightField ( string $field )

public SolrQuery addMltField ( string $field )

public SolrQuery addMltQueryField ( string $field , float $boost )

public SolrQuery addSortField ( string $field [, int $order = SolrQuery::ORDER_DESC ] )

public SolrQuery addStatsFacet ( string $field )

public SolrQuery addStatsField ( string $field )

public __construct ([ string $q ] )

public void __destruct ( void )

public bool getFacet ( void )

public string getFacetDateEnd ([ string $field_override ] )

public array getFacetDateFields ( void )

public string getFacetDateGap ([ string $field_override ] )

public string getFacetDateHardEnd ([ string $field_override ] )

public array getFacetDateOther ([ string $field_override ] )

public string getFacetDateStart ([ string $field_override ] )

public array getFacetFields ( void )

public int getFacetLimit ([ string $field_override ] )

public string getFacetMethod ([ string $field_override ] )

public int getFacetMinCount ([ string $field_override ] )

public bool getFacetMissing ([ string $field_override ] )

public int getFacetOffset ([ string $field_override ] )

public string getFacetPrefix ([ string $field_override ] )

public array getFacetQueries ( void )

public int getFacetSort ([ string $field_override ] )

public array getFields ( void )

public array getFilterQueries ( void )

public bool getHighlight ( void )

public string getHighlightAlternateField ([ string $field_override ] )

public array getHighlightFields ( void )

public string getHighlightFormatter ([ string $field_override ] )

public string getHighlightFragmenter ([ string $field_override ] )

public int getHighlightFragsize ([ string $field_override ] )

public bool getHighlightHighlightMultiTerm ( void )

public int getHighlightMaxAlternateFieldLength ([ string $field_override ] )

public int getHighlightMaxAnalyzedChars ( void )

public bool getHighlightMergeContiguous ([ string $field_override ] )

public int getHighlightRegexMaxAnalyzedChars ( void )

public string getHighlightRegexPattern ( void )

public float getHighlightRegexSlop ( void )

public bool getHighlightRequireFieldMatch ( void )

public string getHighlightSimplePost ([ string $field_override ] )

public string getHighlightSimplePre ([ string $field_override ] )

public int getHighlightSnippets ([ string $field_override ] )

public bool getHighlightUsePhraseHighlighter ( void )

public bool getMlt ( void )

public bool getMltBoost ( void )

public int getMltCount ( void )

public array getMltFields ( void )

public int getMltMaxNumQueryTerms ( void )

public int getMltMaxNumTokens ( void )

public int getMltMaxWordLength ( void )

public int getMltMinDocFrequency ( void )

public int getMltMinTermFrequency ( void )

public int getMltMinWordLength ( void )

public array getMltQueryFields ( void )

public string getQuery ( void )

public int getRows ( void )

public array getSortFields ( void )

public int getStart ( void )

public bool getStats ( void )

public array getStatsFacets ( void )

public array getStatsFields ( void )

public bool getTerms ( void )

public string getTermsField ( void )

public bool getTermsIncludeLowerBound ( void )

public bool getTermsIncludeUpperBound ( void )

public int getTermsLimit ( void )

public string getTermsLowerBound ( void )

public int getTermsMaxCount ( void )

public int getTermsMinCount ( void )

public string getTermsPrefix ( void )

public bool getTermsReturnRaw ( void )

public int getTermsSort ( void )

public string getTermsUpperBound ( void )

public int getTimeAllowed ( void )

public SolrQuery removeFacetDateField ( string $field )

public SolrQuery removeFacetDateOther ( string $value [, string $field_override ] )

public SolrQuery removeFacetField ( string $field )

public SolrQuery removeFacetQuery ( string $value )

public SolrQuery removeField ( string $field )

public SolrQuery removeFilterQuery ( string $fq )

public SolrQuery removeHighlightField ( string $field )

public SolrQuery removeMltField ( string $field )

public SolrQuery removeMltQueryField ( string $queryField )

public SolrQuery removeSortField ( string $field )

public SolrQuery removeStatsFacet ( string $value )

public SolrQuery removeStatsField ( string $field )

public SolrQuery setEchoHandler ( bool $flag )

public SolrQuery setEchoParams ( string $type )

public SolrQuery setExplainOther ( string $query )

public SolrQuery setFacet ( bool $flag )

public SolrQuery setFacetDateEnd ( string $value [, string $field_override ] )

public SolrQuery setFacetDateGap ( string $value [, string $field_override ] )

public SolrQuery setFacetDateHardEnd ( bool $value [, string $field_override ] )

public SolrQuery setFacetDateStart ( string $value [, string $field_override ] )

public SolrQuery setFacetEnumCacheMinDefaultFrequency ( int $frequency [, string $field_override ] )

public SolrQuery setFacetLimit ( int $limit [, string $field_override ] )

public SolrQuery setFacetMethod ( string $method [, string $field_override ] )

public SolrQuery setFacetMinCount ( int $mincount [, string $field_override ] )

public SolrQuery setFacetMissing ( bool $flag [, string $field_override ] )

public SolrQuery setFacetOffset ( int $offset [, string $field_override ] )

public SolrQuery setFacetPrefix ( string $prefix [, string $field_override ] )

public SolrQuery setFacetSort ( int $facetSort [, string $field_override ] )

public SolrQuery setHighlight ( bool $flag )

public SolrQuery setHighlightAlternateField ( string $field [, string $field_override ] )

public SolrQuery setHighlightFormatter ( string $formatter [, string $field_override ] )

public SolrQuery setHighlightFragmenter ( string $fragmenter [, string $field_override ] )

public SolrQuery setHighlightFragsize ( int $size [, string $field_override ] )

public SolrQuery setHighlightHighlightMultiTerm ( bool $flag )

public SolrQuery setHighlightMaxAlternateFieldLength ( int $fieldLength [, string $field_override ] )

public SolrQuery setHighlightMaxAnalyzedChars ( int $value )

public SolrQuery setHighlightMergeContiguous ( bool $flag [, string $field_override ] )

public SolrQuery setHighlightRegexMaxAnalyzedChars ( int $maxAnalyzedChars )

public SolrQuery setHighlightRegexPattern ( string $value )

public SolrQuery setHighlightRegexSlop ( float $factor )

public SolrQuery setHighlightRequireFieldMatch ( bool $flag )

public SolrQuery setHighlightSimplePost ( string $simplePost [, string $field_override ] )

public SolrQuery setHighlightSimplePre ( string $simplePre [, string $field_override ] )

public SolrQuery setHighlightSnippets ( int $value [, string $field_override ] )

public SolrQuery setHighlightUsePhraseHighlighter ( bool $flag )

public SolrQuery setMlt ( bool $flag )

public SolrQuery setMltBoost ( bool $flag )

public SolrQuery setMltCount ( int $count )

public SolrQuery setMltMaxNumQueryTerms ( int $value )

public SolrQuery setMltMaxNumTokens ( int $value )

public SolrQuery setMltMaxWordLength ( int $maxWordLength )

public SolrQuery setMltMinDocFrequency ( int $minDocFrequency )

public SolrQuery setMltMinTermFrequency ( int $minTermFrequency )

public SolrQuery setMltMinWordLength ( int $minWordLength )

public SolrQuery setOmitHeader ( bool $flag )

public SolrQuery setQuery ( string $query )

public SolrQuery setRows ( int $rows )

public SolrQuery setShowDebugInfo ( bool $flag )

public SolrQuery setStart ( int $start )

public SolrQuery setStats ( bool $flag )

public SolrQuery setTerms ( bool $flag )

public SolrQuery setTermsField ( string $fieldname )

public SolrQuery setTermsIncludeLowerBound ( bool $flag )

public SolrQuery setTermsIncludeUpperBound ( bool $flag )

public SolrQuery setTermsLimit ( int $limit )

public SolrQuery setTermsLowerBound ( string $lowerBound )

public SolrQuery setTermsMaxCount ( int $frequency )

public SolrQuery setTermsMinCount ( int $frequency )

public SolrQuery setTermsPrefix ( string $prefix )

public SolrQuery setTermsReturnRaw ( bool $flag )

public SolrQuery setTermsSort ( int $sortType )

public SolrQuery setTermsUpperBound ( string $upperBound )

public SolrQuery setTimeAllowed ( int $timeAllowed )

/* Méthodes héritées */

public SolrModifiableParams::__construct ( void )

public void SolrModifiableParams::__destruct ( void )

}

Constantes pré-définies

SolrQuery::ORDER_ASC: Utilisé pour spécifier une direction croissante du tri.
SolrQuery::ORDER_DESC: Utilisé pour spécifier une direction décroissante du tri.
SolrQuery::FACET_SORT_INDEX: Utilisé pour spécifier que le facet doit être trié par son index
SolrQuery::FACET_SORT_COUNT: Utilisé pour spécifier que le facet doit être trié par son total.
SolrQuery::TERMS_SORT_INDEX: Utilisé dans TermsComponent
SolrQuery::TERMS_SORT_COUNT: Utilisé dans TermsComponent

Sommaire

SolrQuery::addFacetDateField — Lie un facet.date
SolrQuery::addFacetDateOther — Ajoute une autre paramètre facet.date.other
SolrQuery::addFacetField — Ajoute un autre champ à la facette
SolrQuery::addFacetQuery — Ajoute une requête de facette
SolrQuery::addField — Spécifie quel champ doit retourner le résultat
SolrQuery::addFilterQuery — Spécifie un filtre de requête
SolrQuery::addHighlightField — Lie un hl.fl
SolrQuery::addMltField — Spécifie un champ à utiliser pour les similitudes
SolrQuery::addMltQueryField — Lie un mlt.qf
SolrQuery::addSortField — Utilisé pour contrôler le tri du résultat
SolrQuery::addStatsFacet — Récupère un sous résultat pour y trouver des valeurs d'une facette donnée
SolrQuery::addStatsField — Lie un paramètre stats.field
SolrQuery::__construct — Constructeur
SolrQuery::__destruct — Destructeur
SolrQuery::getFacet — Retourne la valeur du paramètre de facette
SolrQuery::getFacetDateEnd — Retourne la valeur du paramètre facet.date.end
SolrQuery::getFacetDateFields — Retourne tous les champs facet.date
SolrQuery::getFacetDateGap — Récupère la valeur du paramètre facet.date.gap
SolrQuery::getFacetDateHardEnd — Récupère la valeur du paramètre facet.date.hardend
SolrQuery::getFacetDateOther — Récupère la valeur du paramètre facet.date.other
SolrQuery::getFacetDateStart — Récupère la limite inférieure du premier intervalle de la date pour toutes les facettes de date pour ce champ
SolrQuery::getFacetFields — Récupère toutes les facettes des champs
SolrQuery::getFacetLimit — Récupère le nombre maximal de contraintes qui peut être retourné pour les facettes des champs
SolrQuery::getFacetMethod — Récupère la valeur du paramètre facet.method
SolrQuery::getFacetMinCount — Récupère le nombre minimal de facettes des champs qui doivent être incluses dans la réponse
SolrQuery::getFacetMissing — Récupère l'état courant du paramètre facet.missing
SolrQuery::getFacetOffset — Récupère la position dans la liste des contraintes à utiliser pour la pagination
SolrQuery::getFacetPrefix — Récupère le préfixe de la facette
SolrQuery::getFacetQueries — Récupère toutes les facettes des requêtes
SolrQuery::getFacetSort — Retourne le type de tri de la facette
SolrQuery::getFields — Récupère la liste des champs qui seront retournés dans la réponse
SolrQuery::getFilterQueries — Récupère un tableau de filtres de requêtes
SolrQuery::getHighlight — Récupère l'état du paramètre h1
SolrQuery::getHighlightAlternateField — Récupère le champ mis en évidence à utiliser comme champ par défaut ou comme champ de sauvegarde
SolrQuery::getHighlightFields — Récupère tous les champs pour lesquels Solr doit mettre en évidence un extrait
SolrQuery::getHighlightFormatter — Récupère le formatage utilisé pour mettre en évidence la sortie
SolrQuery::getHighlightFragmenter — Récupère le générateur d'extrait de texte pour la mise en évidence
SolrQuery::getHighlightFragsize — Retourne le nombre de caractères des fragments à considérer pour la mise en évidence
SolrQuery::getHighlightHighlightMultiTerm — Retourne si l'on doit activer la mise en évidence pour les intervalles/jokers/flous/préfixes des requêtes
SolrQuery::getHighlightMaxAlternateFieldLength — Retourne le nombre maximal de caractères du champ à retourner
SolrQuery::getHighlightMaxAnalyzedChars — Retourne le nombre maximal de caractères du document dans lequel les extraits seront cherchés
SolrQuery::getHighlightMergeContiguous — Retourne si l'on doit rassembler les fragments contigus en un seul fragment
SolrQuery::getHighlightRegexMaxAnalyzedChars — Retourne le nombre maximal de caractères depuis un champ lors de l'utilisation d'une regex
SolrQuery::getHighlightRegexPattern — Récupère l'expression rationnelle utilisée pour la fragmentation
SolrQuery::getHighlightRegexSlop — Récupère le facteur de déviation depuis la taille du fragment idéal
SolrQuery::getHighlightRequireFieldMatch — Retourne si le champ ne doit être mis en évidence que si la requête correspond à un champ en particulier
SolrQuery::getHighlightSimplePost — Récupère le texte qui doit apparaître après le terme mise en évidence
SolrQuery::getHighlightSimplePre — Retourne le texte qui doit apparaître avant le terme mise en évidence
SolrQuery::getHighlightSnippets — Récupère le nombre maximal d'extraits mis en évidence à générer par champ
SolrQuery::getHighlightUsePhraseHighlighter — Récupère l'état du paramètre hl.usePhraseHighlighter
SolrQuery::getMlt — Retourne si les résultats MoreLikeThis doivent être activés
SolrQuery::getMltBoost — Retourne si la requête doit être améliorée en utilisant la pertinence des termes
SolrQuery::getMltCount — Récupère le nombre de documents similaires à retourner pour chaque résultat
SolrQuery::getMltFields — Récupère tous les champs à utiliser pour la similarité
SolrQuery::getMltMaxNumQueryTerms — Retourne le nombre maximal de termes de requête qui peuvent être inclus lors de la génération d'une requête
SolrQuery::getMltMaxNumTokens — Retourne le nombre maximal de jokers à analyser dans chaque champ du document
SolrQuery::getMltMaxWordLength — Retourne la longueur minimale des mots en deçà de laquelle ils seront ignorés
SolrQuery::getMltMinDocFrequency — Retourne le seuil de fréquence d'apparition des mots
SolrQuery::getMltMinTermFrequency — Retourne la fréquence en deçà duquel les termes doivent être ignorés dans le document source
SolrQuery::getMltMinWordLength — Retourne la longueur minimum d'un mot en deça duquel il sera ignoré
SolrQuery::getMltQueryFields — Retourne les champs de la requête ainsi que leurs boosts
SolrQuery::getQuery — Retourne la requête principale
SolrQuery::getRows — Retourne le nombre maximal de documents
SolrQuery::getSortFields — Retourne tous les champs de tri
SolrQuery::getStart — Retourne la position dans le jeu complet de résultats
SolrQuery::getStats — Vérifie si les statistiques sont actives ou non
SolrQuery::getStatsFacets — Retourne toutes les statistiques définies
SolrQuery::getStatsFields — Retourne les statistiques des champs
SolrQuery::getTerms — Vérifie si le TermsComponent est activé ou non
SolrQuery::getTermsField — Récupère le champ depuis lequel les termes sont récupérés
SolrQuery::getTermsIncludeLowerBound — Vérifie si l'on doit inclure ou non la limite inférieure dans le jeu de résultats
SolrQuery::getTermsIncludeUpperBound — Vérifie si l'on doit inclure ou non la limite supérieure dans le jeu de résultats
SolrQuery::getTermsLimit — Retourne le nombre maximal de termes que Solr peut retourner
SolrQuery::getTermsLowerBound — Retourne le terme sur lequel on doit commencer
SolrQuery::getTermsMaxCount — Retourne la fréquence maximale des documents
SolrQuery::getTermsMinCount — Retourne la fréquence minimale des documents
SolrQuery::getTermsPrefix — Retourne le préfixe du terme
SolrQuery::getTermsReturnRaw — Si l'on doit retourner ou non les caractères brutes
SolrQuery::getTermsSort — Retourne un entier indiquant le nombre de termes stockés
SolrQuery::getTermsUpperBound — Retourne le terme sur lequel on doit s'arrêter
SolrQuery::getTimeAllowed — Retourne le délai d'exécution autorisé pour une requête
SolrQuery::removeFacetDateField — Supprime un champ date
SolrQuery::removeFacetDateOther — Supprime un paramètre facet.date.other
SolrQuery::removeFacetField — Supprime un paramètre facet.date
SolrQuery::removeFacetQuery — Supprime un paramètre facet.query
SolrQuery::removeField — Efface un champ depuis la liste des champs
SolrQuery::removeFilterQuery — Supprime un filtre de requête
SolrQuery::removeHighlightField — Supprime un des champs utilisés pour la mise en évidence
SolrQuery::removeMltField — Supprime un des champs moreLikeThis
SolrQuery::removeMltQueryField — Supprime un des champs moreLikeThis de la requête
SolrQuery::removeSortField — Supprime un champ de tri
SolrQuery::removeStatsFacet — Supprime un paramètre stats.facet
SolrQuery::removeStatsField — Supprime un paramètre stats.field
SolrQuery::setEchoHandler — Bascule le paramètre echoHandler
SolrQuery::setEchoParams — Détermine les paramètres à inclure dans la réponse
SolrQuery::setExplainOther — Définit le paramètre de requête explainOther
SolrQuery::setFacet — Lie un paramètre facet. Active ou désactive les facet
SolrQuery::setFacetDateEnd — Lie un facet.date.end
SolrQuery::setFacetDateGap — Lie un facet.date.gap
SolrQuery::setFacetDateHardEnd — Lie un facet.date.hardend
SolrQuery::setFacetDateStart — Lie un facet.date.start
SolrQuery::setFacetEnumCacheMinDefaultFrequency — Définit la fréquence minimale du document utilisée pour déterminer le comptage des termes
SolrQuery::setFacetLimit — Lie un facet.limit
SolrQuery::setFacetMethod — Spécifie le type d'algorithme à utiliser pour un champ facet
SolrQuery::setFacetMinCount — Lie un facet.mincount
SolrQuery::setFacetMissing — Lie un facet.missing
SolrQuery::setFacetOffset — Définit la position dans la liste des contraintes pour la pagination
SolrQuery::setFacetPrefix — Spécifie un préfixe utilisé pour limiter les termes
SolrQuery::setFacetSort — Détermine le tri des facet
SolrQuery::setHighlight — Active ou désactive la coloration
SolrQuery::setHighlightAlternateField — Spécifie le champ de sauvegarde à utiliser
SolrQuery::setHighlightFormatter — Spécifie un formateur pour la sortie colorisée
SolrQuery::setHighlightFragmenter — Définit un générateur d'extraits de texte pour le texte colorisé
SolrQuery::setHighlightFragsize — La taille du fragment à considérer pour la coloration
SolrQuery::setHighlightHighlightMultiTerm — Utilise SpanScorer pour coloriser les termes d'une phrase
SolrQuery::setHighlightMaxAlternateFieldLength — Définit le nombre maximal de caractères du champ à retourner
SolrQuery::setHighlightMaxAnalyzedChars — Spécifie le nombre de caractères dans un document pour y chercher des extraits correspondants
SolrQuery::setHighlightMergeContiguous — Si l'on doit rassembler les fragments proches dans un seul fragment
SolrQuery::setHighlightRegexMaxAnalyzedChars — Spécifie le nombre maximal de caractères à analyser
SolrQuery::setHighlightRegexPattern — Spécifie l'expression rationnelle pour la fragmentation
SolrQuery::setHighlightRegexSlop — Définit le facteur par lequel le fragmenteur regex peut dévier de la taille idéale du fragment
SolrQuery::setHighlightRequireFieldMatch — Champ correspondant requis lors de la colorisation
SolrQuery::setHighlightSimplePost — Définit le texte qui doit apparaître après un terme colorisé
SolrQuery::setHighlightSimplePre — Définit le texte qui doit apparaître avant un terme colorisé
SolrQuery::setHighlightSnippets — Définit le nombre maximal d'extraits à coloriser par champ
SolrQuery::setHighlightUsePhraseHighlighter — Si l'on doit coloriser les termes d'une phrase uniquement si ils apparaissent dans la requête
SolrQuery::setMlt — Active ou désactive moreLikeThis
SolrQuery::setMltBoost — Si la requête doit être stimulée par la pertinence des termes
SolrQuery::setMltCount — Définit le nombre de documents similaires à retourner à chaque résultat
SolrQuery::setMltMaxNumQueryTerms — Définit le nombre maximal de termes de requête à inclure
SolrQuery::setMltMaxNumTokens — Spécifie le nombre maximal de motifs à analyser
SolrQuery::setMltMaxWordLength — Définit la longueur maximale d'un mot
SolrQuery::setMltMinDocFrequency — Définit la fréquence mltMinDoc
SolrQuery::setMltMinTermFrequency — Définit la fréquence en dessous de laquelle les termes seront ignorés dans le document source
SolrQuery::setMltMinWordLength — Définit la longueur minimale d'un mot
SolrQuery::setOmitHeader — Exclut l'en-tête des résultats retournés
SolrQuery::setQuery — Définit la requête de recherche
SolrQuery::setRows — Spécifie le nombre maximal de lignes à retourner dans le résultat
SolrQuery::setShowDebugInfo — Drapeau pour afficher les informations de débogage
SolrQuery::setStart — Spécifie le nombre maximal de lignes à ignorer
SolrQuery::setStats — Active ou désactive le composant statistique
SolrQuery::setTerms — Active ou désactive le TermsComponent
SolrQuery::setTermsField — Définit le nom du champ dans lequel les termes seront récupérés
SolrQuery::setTermsIncludeLowerBound — Inclut le terme inférieure liée dans le jeu de résultat
SolrQuery::setTermsIncludeUpperBound — Inclut le terme supérieure liée dans le jeu de résultat
SolrQuery::setTermsLimit — Définit le nombre maximal de termes à retourner
SolrQuery::setTermsLowerBound — Spécifie le terme de départ
SolrQuery::setTermsMaxCount — Définit la fréquence maximale du document
SolrQuery::setTermsMinCount — Définit la fréquence minimale d'un document
SolrQuery::setTermsPrefix — Restreint les termes correspondants qui commencent avec un préfixe donné
SolrQuery::setTermsReturnRaw — Retourne les caractères brutes d'un terme indexé
SolrQuery::setTermsSort — Spécifie la façon dont seront triés les termes retournés
SolrQuery::setTermsUpperBound — Définit le terme à partir duquel on doit stopper
SolrQuery::setTimeAllowed — Le temps allouée pour faire une recherche

SolrModifiableParams::__destruct

Solr

SolrQuery::addFacetDateField

Manuel PHP