Référence de la classe FinderModelSearch

Graphe d'héritage de FinderModelSearch:

Graphe de collaboration de FinderModelSearch:

Liste de tous les membres

Fonctions membres publiques
	getResults ()
	getTotal ()
	getQuery ()
Fonctions membres publiques inherited from JModelList
	__construct ($config=array())
	getItems ()
	getPagination ()
	getStart ()
	getUserStateFromRequest ($key, $request, $default=null, $type= 'none', $resetPage=true)
Fonctions membres publiques inherited from JModel
	getDbo ()
	getName ()
	getState ($property=null, $default=null)
	getTable ($name= '', $prefix= 'Table', $options=array())
	setDbo (&$db)
	setState ($property, $value=null)
Fonctions membres publiques inherited from JObject
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres protégées
	getListQuery ()
	getResultsTotal ()
	getResultsData ()
	getExcludedLinkIds ()
	getTermsQuery ($terms)
	getStoreId ($id= '', $page=true)
	populateState ($ordering=null, $direction=null)
	retrieve ($id, $persistent=true)
	store ($id, $data, $persistent=true)
Fonctions membres protégées inherited from JModelList
	_getListQuery ()
	getStoreId ($id= '')
Fonctions membres protégées inherited from JModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix= 'Table', $config=array())
	populateState ()
	cleanCache ($group=null, $client_id=0)

Attributs protégés
	$context = 'com_finder.search'
	$query
	$excludedTerms = array()
	$includedTerms = array()
	$requiredTerms = array()
Attributs protégés inherited from JModelList
	$cache = array()
	$filter_fields = array()
Attributs protégés inherited from JModel
	$__state_set = null
	$_db
	$name
	$option = null
	$state
	$event_clean_cache = null
Attributs protégés inherited from JObject
	$_errors = array()

---

Documentation des fonctions membres

FinderModelSearch::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, $suffix, JString\substr(), et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

FinderModelSearch::getListQuery ( )

protected

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

Renvoie:

JDatabaseQuery A database query.

Depuis:

2.5

Réimplémentée à partir de JModelList.

Références $db, $i, $query, $user, elseif, JFactory\getDate(), JFactory\getLanguage(), et JFactory\getUser().

Voici le graphe d'appel pour cette fonction :

FinderModelSearch::getQuery

(

)

Method to get the query object.

Renvoie:

FinderIndexerQuery A query object.

Depuis:

2.5

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

FinderModelSearch::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, $query, $row, et null.

FinderModelSearch::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, $limit, $ordering, $return, $suffix, elseif, null, et JString\substr().

Voici le graphe d'appel pour cette fonction :

FinderModelSearch::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, $limit, $suffix, $total, elseif, null, et JString\substr().

Voici le graphe d'appel pour cette fonction :

FinderModelSearch::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.

FinderModelSearch::getTermsQuery (   $terms )

protected

Method to get a subquery for filtering link ids mapped to specific terms ids.

Paramètres:

array

$terms

An array of search term ids.

Renvoie:

JDatabaseQuery A database object.

Depuis:

2.5

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

FinderModelSearch::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éimplémentée à partir de JModelList.

Références $total, et null.

FinderModelSearch::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

Réimplémentée à partir de JModelList.

Références $app, $options, $params, FinderIndexerHelper\$stemmer, $user, JFactory\getApplication(), FinderIndexerStemmer\getInstance(), JFilterInput\getInstance(), JFactory\getUser(), et JArrayHelper\toInteger().

Voici le graphe d'appel pour cette fonction :

FinderModelSearch::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, JFactory\getCache(), et null.

Voici le graphe d'appel pour cette fonction :

FinderModelSearch::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, $id, et JFactory\getCache().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

FinderModelSearch::$context = 'com_finder.search'

protected

Réimplémentée à partir de JModelList.

FinderModelSearch::$excludedTerms = array()

protected

FinderModelSearch::$includedTerms = array()

protected

FinderModelSearch::$query

protected

Réimplémentée à partir de JModelList.

FinderModelSearch::$requiredTerms = array()

protected

---

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

• components/com_finder/models/search.php