Référence de la classe FinderModelIndex

Graphe d'héritage de FinderModelIndex:

Fonctions membres publiques
	__construct ($config=array())
	delete (&$pks)
	getPluginState ()
	getTotalIndexed ()
	getTable ($type='Link', $prefix='FinderTable', $config=array())
	purge ()
	publish (&$pks, $value=1)

Fonctions membres protégées
	canDelete ($record)
	canEditState ($record)
	getListQuery ()
	getStoreId ($id='')
	populateState ($ordering='l.title', $direction='asc')

Attributs protégés
	$event_after_delete = 'onContentAfterDelete'
	$event_before_delete = 'onContentBeforeDelete'

Description détaillée

Index model class for Finder.

Depuis

2.5

Documentation des constructeurs et destructeur

__construct()

__construct

(

$config = array()

)

Constructor.

Paramètres

array

$config

An associative array of configuration settings. [optional]

Depuis

2.5

Voir également

JControllerLegacy

Références $config.

Documentation des fonctions membres

canDelete()

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 option.

canEditState()

canEditState (   $record )

protected

Method to test whether a record can have its state changed.

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 option.

delete()

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 $context, $dispatcher, $i, $name, JEventDispatcher\getInstance(), et option.

getListQuery()

getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie

JDatabaseQuery A JDatabaseQuery object

Depuis

2.5

Références $db, $listOrder, $ordering, $query, $state, et $type.

getPluginState()

getPluginState

(

)

Method to get the state of the Smart Search Plugins.

Renvoie

array Array of relevant plugins and whether they are enabled or not.

Depuis

2.5

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

getStoreId()

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éférences $id.

getTable()

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éférences $config, $prefix, et $type.

getTotalIndexed()

getTotalIndexed

(

)

Gets the total of indexed items.

Renvoie

integer The total of indexed items.

Depuis

3.6.0

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

populateState()

populateState (   $ordering = 'l.title',   $direction = 'asc'  )

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éférences $direction, $ordering, et $params.

publish()

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 $context, $dispatcher, $i, $name, $user, $value, JEventDispatcher\getInstance(), et option.

purge()

purge

(

)

Method to purge the index, deleting all links.

Renvoie

boolean True on success, false on failure.

Depuis

2.5

Exceptions

Exception

on database error

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

Documentation des champs

$event_after_delete

$event_after_delete = 'onContentAfterDelete'

protected

$event_before_delete

$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