Référence de la classe FinderIndexerQuery

Liste de tous les membres

Fonctions membres publiques
	__construct ($options)
	toURI ($base=null)
	getExcludedTermIds ()
	getIncludedTermIds ()
	getRequiredTermIds ()

Attributs publics
	$search
	$input
	$language
	$mode
	$included = array()
	$excluded = array()
	$ignored = array()
	$operators = array()
	$highlight = array()
	$terms
	$filter
	$filters = array()
	$date1
	$date2
	$when1
	$when2

Fonctions membres protégées
	processStaticTaxonomy ($filterId)
	processDynamicTaxonomy ($filters)
	processDates ($date1, $date2, $when1, $when2)
	processString ($input, $lang, $mode)
	getTokenData ($token)

---

Documentation des constructeurs et destructeur

FinderIndexerQuery::__construct

(

$options

)

Method to instantiate the query object.

Paramètres:

array

$options

An array of query options.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $options, elseif, FinderIndexerHelper\getDefaultLanguage(), FinderIndexerHelper\getPrimaryLanguage(), language, null, et JRegistry\set().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

FinderIndexerQuery::getExcludedTermIds

(

)

Method to get a list of excluded search term ids.

Renvoie:

array An array of excluded term ids.

Depuis:

2.5

Références $i, $return, et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

FinderIndexerQuery::getIncludedTermIds

(

)

Method to get a list of included search term ids.

Renvoie:

array An array of included term ids.

Depuis:

2.5

Références $i, $key, et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

FinderIndexerQuery::getRequiredTermIds

(

)

Method to get a list of required search term ids.

Renvoie:

array An array of required term ids.

Depuis:

2.5

Références $i, $key, et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

FinderIndexerQuery::getTokenData (   $token )

protected

Method to get the base and similar term ids and, if necessary, suggested term data from the database. The terms ids are identified based on a 'like' match in MySQL and/or a common stem. If no term ids could be found, then we know that we will not be able to return any results for that term and we should try to find a similar term to use that we can match so that we can suggest the alternative search query to the user.

Paramètres:

FinderIndexerToken

$token

A FinderIndexerToken object.

Renvoie:

FinderIndexerToken A FinderIndexerToken object.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $db, $i, $key, et $query.

FinderIndexerQuery::processDates (   $date1,   $date2,   $when1,   $when2  )

protected

Method to process the query date filters to determine start and end date limitations.

Paramètres:

string	$date1	The first date filter.
string	$date2	The second date filter.
string	$when1	The first date modifier.
string	$when2	The second date modifier.

Renvoie:

boolean True on success.

Depuis:

2.5

Références $date, JText\_(), JFactory\getApplication(), JFactory\getDate(), null, JString\strtolower(), et JString\trim().

Voici le graphe d'appel pour cette fonction :

FinderIndexerQuery::processDynamicTaxonomy (   $filters )

protected

Method to process the dynamic taxonomy input. The dynamic taxonomy input comes in the form of select fields that the user chooses from. The dynamic taxonomy input is processed AFTER the static taxonomy input because the dynamic options can be used to further narrow a static taxonomy filter.

Paramètres:

array

$filters

An array of taxonomy node ids.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $db, $query, $user, JFactory\getUser(), et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

FinderIndexerQuery::processStaticTaxonomy (   $filterId )

protected

Method to process the static taxonomy input. The static taxonomy input comes in the form of a pre-defined search filter that is assigned to the search form.

Paramètres:

integer

$filterId

The id of static filter.

Renvoie:

boolean True on success, false on failure.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $db, $params, $query, $return, $user, JFactory\getUser(), JRegistry\loadString(), et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

FinderIndexerQuery::processString (   $input,   $lang,   $mode  )

protected

Method to process the query input string and extract required, optional, and excluded tokens; taxonomy filters; and date filters.

Paramètres:

string	$input	The query input string.
string	$lang	The query input language.
string	$mode	The query matching mode.

Renvoie:

boolean True on success.

Depuis:

2.5

Exceptions:

Exception

on database error.

Références $date, $i, $key, $lang, $mode, $parts, $return, $suffix, JText\_(), FinderHelperLanguage\branchSingular(), elseif, ENT_QUOTES, JFactory\getApplication(), FinderIndexerTaxonomy\getBranchTitles(), JFactory\getConfig(), JFactory\getDate(), FinderIndexerTaxonomy\getNodeByTitle(), JDEBUG, null, JString\strlen(), JString\strpos(), JString\strtolower(), JString\substr(), FinderIndexerHelper\tokenize(), et JString\trim().

Voici le graphe d'appel pour cette fonction :

FinderIndexerQuery::toURI

(

$base = null

)

Method to convert the query object into a URI string.

Paramètres:

string

$base

The base URI. [optional]

Renvoie:

string The complete query URI.

Depuis:

2.5

Références $base, $item, $query, $uri, JFactory\getApplication(), JURI\getInstance(), FinderHelperRoute\getItemid(), et null.

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

FinderIndexerQuery::$date1

FinderIndexerQuery::$date2

FinderIndexerQuery::$excluded = array()

FinderIndexerQuery::$filter

FinderIndexerQuery::$filters = array()

FinderIndexerQuery::$highlight = array()

FinderIndexerQuery::$ignored = array()

FinderIndexerQuery::$included = array()

FinderIndexerQuery::$input

FinderIndexerQuery::$language

FinderIndexerQuery::$mode

FinderIndexerQuery::$operators = array()

FinderIndexerQuery::$search

FinderIndexerQuery::$terms

FinderIndexerQuery::$when1

FinderIndexerQuery::$when2

---

La documentation de cette classe a été générée à partir du fichier suivant :

• administrator/components/com_finder/helpers/indexer/query.php