Référence de la classe FinderModelIndex

Graphe d'héritage de FinderModelIndex:

Graphe de collaboration de FinderModelIndex:

Liste de tous les membres

Fonctions membres publiques
	__construct ($config=array())
	delete (&$pks)
	getPluginState ()
	getTable ($type= 'Link', $prefix= 'FinderTable', $config=array())
	purge ()
	publish (&$pks, $value=1)
Fonctions membres publiques inherited from JModelList
	getItems ()
	getPagination ()
	getTotal ()
	getStart ()
	getUserStateFromRequest ($key, $request, $default=null, $type= 'none', $resetPage=true)
Fonctions membres publiques inherited from JModel
	getDbo ()
	getName ()
	getState ($property=null, $default=null)
	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
	canDelete ($record)
	canEditState ($record)
	getListQuery ()
	getStoreId ($id= '')
	populateState ($ordering=null, $direction=null)
Fonctions membres protégées inherited from JModelList
	_getListQuery ()
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
	$event_after_delete = 'onContentAfterDelete'
	$event_before_delete = 'onContentBeforeDelete'
Attributs protégés inherited from JModelList
	$cache = array()
	$context = null
	$filter_fields = array()
	$query = 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 constructeurs et destructeur

FinderModelIndex::__construct

(

$config = array()

)

Constructor.

Paramètres:

array

$config

An associative array of configuration settings. [optional]

Depuis:

2.5

Voir également:

JController

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

Références $config.

---

Documentation des fonctions membres

FinderModelIndex::canDelete (   $record )

protected

Method to test whether a record can be deleted.

Paramètres:

object

$record

A record object.

Renvoie:

boolean True if allowed to delete the record. Defaults to the permission for the component.

Depuis:

2.5

Références $user, et JFactory\getUser().

Voici le graphe d'appel pour cette fonction :

FinderModelIndex::canEditState (   $record )

protected

Method to test whether a record can be deleted.

Paramètres:

object

$record

A record object.

Renvoie:

boolean True if allowed to change the state of the record. Defaults to the permission for the component.

Depuis:

2.5

Références $user, et JFactory\getUser().

Voici le graphe d'appel pour cette fonction :

FinderModelIndex::delete

(

&

$pks

)

Method to delete one or more records.

Paramètres:

array

&$pks

An array of record primary keys.

Renvoie:

boolean True if successful, false if an error occurs.

Depuis:

2.5

Références $dispatcher, $i, $name, $user, JText\_(), JDispatcher\getInstance(), JFactory\getUser(), et JPluginHelper\importPlugin().

Voici le graphe d'appel pour cette fonction :

FinderModelIndex::getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie:

JDatabaseQuery A JDatabaseQuery object

Depuis:

2.5

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

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

FinderModelIndex::getPluginState

(

)

Method to get the state of the Smart Search plug-ins.

Renvoie:

array Array of relevant plug-ins and whether they are enabled or not.

Depuis:

2.5

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

FinderModelIndex::getStoreId (   $id = '' )

protected

Method to get a store id based on model 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

A prefix for the store id. [optional]

Renvoie:

string A store id.

Depuis:

2.5

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

Références $id.

FinderModelIndex::getTable	(		$type = 'Link',
			$prefix = 'FinderTable',
			$config = array()
	)

Returns a JTable object, always creating it.

Paramètres:

string	$type	The table type to instantiate. [optional]
string	$prefix	A prefix for the table class name. [optional]
array	$config	Configuration array for model. [optional]

Renvoie:

JTable A database object

Depuis:

2.5

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

Références $config, $type, et JTable\getInstance().

Voici le graphe d'appel pour cette fonction :

FinderModelIndex::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 $params, $state, $type, et JComponentHelper\getParams().

Voici le graphe d'appel pour cette fonction :

FinderModelIndex::publish	(	&	$pks,
			$value = 1
	)

Method to change the published state of one or more records.

Paramètres:

array	&$pks	A list of the primary keys to change.
integer	$value	The value of the published state. [optional]

Renvoie:

boolean True on success.

Depuis:

2.5

Références $dispatcher, $i, $name, $user, JText\_(), JDispatcher\getInstance(), JFactory\getUser(), et JPluginHelper\importPlugin().

Voici le graphe d'appel pour cette fonction :

FinderModelIndex::purge

(

)

Method to purge the index, deleting all links.

Renvoie:

boolean True on success, false on failure.

Depuis:

2.5

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

---

Documentation des données membres

FinderModelIndex::$event_after_delete = 'onContentAfterDelete'

protected

FinderModelIndex::$event_before_delete = 'onContentBeforeDelete'

protected

---

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

• administrator/components/com_finder/models/index.php