Référence de la classe FinderModelSearch

Graphe d'héritage de FinderModelSearch:

Fonctions membres publiques
	getResults ()
	getTotal ()
	getQuery ()

Fonctions membres protégées
	getListQuery ()
	getResultsTotal ()
	getResultsData ()
	getExcludedLinkIds ()
	getStoreId ($id='', $page=true)
	populateState ($ordering=null, $direction=null)
	retrieve ($id, $persistent=true)
	store ($id, $data, $persistent=true)

Attributs protégés
	$context = 'com_finder.search'
	$query
	$excludedTerms = array()
	$includedTerms = array()
	$requiredTerms = array()

Description détaillée

Search model class for the Finder package.

Depuis

2.5

Documentation des fonctions membres

getExcludedLinkIds()

getExcludedLinkIds ( )

protected

Method to get an array of link ids that match excluded terms.

Renvoie

array An array of links ids.

Depuis

2.5

Exceptions

Exception

on database error.

Références $db, $id, $query, et $suffix.

getListQuery()

getListQuery ( )

protected

Method to build a database query to load the list data.

Renvoie

JDatabaseQuery A database query.

Depuis

2.5

Références $db, $groups, $i, $query, $user, et elseif.

getQuery()

getQuery

(

)

Method to get the query object.

Renvoie

FinderIndexerQuery A query object.

Depuis

2.5

Références $query.

getResults()

getResults

(

)

Method to get the results of the query.

Renvoie

array An array of FinderIndexerResult objects.

Depuis

2.5

Exceptions

Exception

on database error.

Références $db, $items, $query, $results, $row, $rows, et null.

getResultsData()

getResultsData ( )

protected

Method to get the results for the search query.

Renvoie

array An array of result data objects.

Depuis

2.5

Exceptions

Exception

on database error.

Références $base, $direction, $i, $items, $limit, $ordering, $query, $required, $results, $return, $start, $suffix, elseif, et null.

getResultsTotal()

getResultsTotal ( )

protected

Method to get the total number of results for the search query.

Renvoie

integer The results total.

Depuis

2.5

Exceptions

Exception

on database error.

Références $base, $i, $items, $limit, $query, $required, $results, $start, $suffix, $total, elseif, et null.

getStoreId()

getStoreId (   $id = '',   $page = true  )

protected

Method to get a store id based on model the configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres

string	$id	An identifier string to generate the store id. [optional]
boolean	$page	True to store the data paged, false to store all data. [optional]

Renvoie

string A store id.

Depuis

2.5

Références $id, et $query.

getTotal()

getTotal

(

)

Method to get the total number of results.

Renvoie

integer The total number of results.

Depuis

2.5

Exceptions

Exception

on database error.

Références $total, et null.

populateState()

populateState (   $ordering = null,   $direction = null  )

protected

Method to auto-populate the model state. Calling getState in this method will result in recursion.

Paramètres

string	$ordering	An optional ordering field. [optional]
string	$direction	An optional direction. [optional]

Renvoie

void

Depuis

2.5

Load the sort ordering. Currently this is 'hard' coded via menu item parameter but may not satisfy a users need. More flexibility was way more user friendly. So we allow the user to pass a custom value from the pool of fields that are indexed like the 'title' field. Also, we allow this parameter to be passed in either case (lower/upper).

Load the sort direction. Currently this is 'hard' coded via menu item parameter but may not satisfy a users need. More flexibility was way more user friendly. So we allow to be inverted. Also, we allow this parameter to be passed in either case (lower/upper).

Références $app, $input, $options, $params, FinderIndexerHelper\$stemmer, $user, et FinderIndexerStemmer\getInstance().

retrieve()

retrieve (   $id,   $persistent = true  )

protected

Method to retrieve data from cache.

Paramètres

string	$id	The cache store id.
boolean	$persistent	Flag to enable the use of external cache. [optional]

Renvoie

mixed The cached data if found, null otherwise.

Depuis

2.5

Références $data, $id, et null.

store()

store (   $id,   $data,   $persistent = true  )

protected

Method to store data in cache.

Paramètres

string	$id	The cache store id.
mixed	$data	The data to cache.
boolean	$persistent	Flag to enable the use of external cache. [optional]

Renvoie

boolean True on success, false on failure.

Depuis

2.5

Références $data, et $id.

Documentation des champs

$context

$context = 'com_finder.search'

protected

$excludedTerms

$excludedTerms = array()

protected

$includedTerms

$includedTerms = array()

protected

$query

$query

protected

$requiredTerms

$requiredTerms = array()

protected

---

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

• components/com_finder/models/search.php