Référence de la classe FinderIndexerQuery

Fonctions membres publiques
	__construct ($options)
	toUri ($base='')
	getExcludedTermIds ()
	getIncludedTermIds ()
	getRequiredTermIds ()

Champs de données
	$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)

Description détaillée

Query class for the Finder indexer package.

Depuis

2.5

Documentation des constructeurs et destructeur

__construct()

__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, et Registry\set().

Documentation des fonctions membres

getExcludedTermIds()

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, et $results.

getIncludedTermIds()

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, $results, et $value.

getRequiredTermIds()

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, $results, et $value.

getTokenData()

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, $query, et $results.

processDates()

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, $offset, et null.

processDynamicTaxonomy()

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, $filters, $groups, $query, et $results.

processStaticTaxonomy()

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, $filters, $groups, $params, $query, $results, et $return.

processString()

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, $input, $key, $lang, $mode, $modifier, $offset, $parts, $return, $suffix, $value, FinderHelperLanguage\branchSingular(), elseif, ENT_QUOTES, FinderIndexerTaxonomy\getBranchTitles(), FinderIndexerTaxonomy\getNodeByTitle(), JDEBUG, null, et FinderIndexerHelper\tokenize().

toUri()

toUri

(

$base = ''

)

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, FinderHelperRoute\getItemid(), et null.

Documentation des champs

$date1

$date1

$date2

$date2

$excluded

$excluded = array()

$filter

$filter

$filters

$filters = array()

$highlight

$highlight = array()

$ignored

$ignored = array()

$included

$included = array()

$input

$input

$language

$language

$mode

$mode

$operators

$operators = array()

$search

$search

$terms

$terms

$when1

$when1

$when2

$when2

---

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

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