Référence de la classe IndexModel

Graphe d'héritage de IndexModel:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	delete (&$pks)
	getPluginState ()
	getTotalIndexed ()
	getTable ($type='Link', $prefix='Administrator', $config=array())
	purge ()
	publish (&$pks, $value=1)
Fonctions membres publiques hérités de ListModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getIsEmptyState ()
	getActiveFilters ()
	getItems ()
	getPagination ()
	getTotal ()
	getStart ()
	getFilterForm ($data=array(), $loadData=true)
	getUserStateFromRequest ($key, $request, $default=null, $type='none', $resetPage=true)
Fonctions membres publiques hérités de BaseDatabaseModel
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	getTable ($name='', $prefix='', $options=array())
	isCheckedOut ($item)
	getDbo ()
	setDbo (DatabaseInterface $db=null)
	__get ($name)
Fonctions membres publiques hérités de BaseModel
	__construct ($config=array())
	getName ()
Fonctions membres publiques hérités de CMSObject
	__construct ($properties=null)
	__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)
Fonctions membres publiques hérités de StatefulModelInterface
	getState ($property=null, $default=null)
	setState ($property, $value=null)
Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)
Fonctions membres publiques hérités de CurrentUserInterface
	setCurrentUser (User $currentUser)
Fonctions membres publiques hérités de CacheControllerFactoryAwareInterface
	setCacheControllerFactory (CacheControllerFactoryInterface $factory)
Fonctions membres publiques hérités de DatabaseAwareInterface
	setDatabase (DatabaseInterface $db)
Fonctions membres publiques hérités de FormFactoryAwareInterface
	setFormFactory (FormFactoryInterface $factory)

Fonctions membres protégées
	canDelete ($record)
	canEditState ($record)
	getListQuery ()
	getStoreId ($id='')
	populateState ($ordering='l.title', $direction='asc')
Fonctions membres protégées hérités de ListModel
	getEmptyStateQuery ()
	_getListQuery ()
	getListQuery ()
	getStoreId ($id='')
	loadFormData ()
	populateState ($ordering=null, $direction=null)
	refineSearchStringToRegex ($search, $regexDelimiter='/')
Fonctions membres protégées hérités de BaseDatabaseModel
	_getList ($query, $limitstart=0, $limit=0)
	_getListCount ($query)
	_createTable ($name, $prefix='Table', $config=array())
	bootComponent ($component)
	dispatchEvent (EventInterface $event)

Attributs protégés
	$event_after_delete = 'onContentAfterDelete'
	$event_before_delete = 'onContentBeforeDelete'
	$event_after_purge = 'onFinderIndexAfterPurge'
Attributs protégés hérités de ListModel
	$cache = array()
	$context = null
	$filter_fields = array()
	$query = array()
	$lastQueryStoreId = null
	$filterFormName = null
	$htmlFormName = 'adminForm'
	$filterBlacklist = array()
	$filterForbiddenList = array()
	$listBlacklist = array('select')
	$listForbiddenList = array('select')
Attributs protégés hérités de BaseDatabaseModel
	$option = null
	$event_clean_cache = null
Attributs protégés hérités de BaseModel
	$name
Attributs protégés hérités de CMSObject
	$_errors = array()

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Index model class for Finder.

Depuis

2.5

Documentation des constructeurs et destructeur

__construct()

__construct	(		$config = array(),
		MVCFactoryInterface	$factory = null
	)

Constructor.

Paramètres

array	$config	An optional associative array of configuration settings.
MVCFactoryInterface	$factory	The factory.

Voir également

Depuis

3.7

Références $config, et Symfony\Contracts\Service\__construct().

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 Factory\getUser().

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 Factory\getUser().

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, $i, $name, $result, Text\_(), Factory\getApplication(), et PluginHelper\importPlugin().

getListQuery()

getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie

Depuis

2.5

Références $db, $language, $listOrder, $ordering, $query, $state, $type, Joomla\Database\getDatabase(), et Joomla\CMS\MVC\Model\getState().

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, $query, et Joomla\Database\getDatabase().

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, et Joomla\CMS\MVC\Model\getState().

getTable()

getTable	(		$type = 'Link',
			$prefix = 'Administrator',
			$config = array()
	)

Returns a Table 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

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, $query, et Joomla\Database\getDatabase().

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, $params, ComponentHelper\getParams(), Joomla\CMS\MVC\Model\populateState(), et Joomla\CMS\MVC\Model\setState().

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, $i, $name, $result, $user, $value, Text\_(), Factory\getApplication(), Factory\getUser(), et PluginHelper\importPlugin().

purge()

purge

(

)

Method to purge the index, deleting all links.

Renvoie

boolean True on success, false on failure.

Depuis

2.5

Exceptions

Références $db, $root, Factory\getApplication(), Joomla\Database\getDatabase(), et PluginHelper\importPlugin().

Documentation des champs

$event_after_delete

$event_after_delete = 'onContentAfterDelete'

protected

$event_after_purge

$event_after_purge = 'onFinderIndexAfterPurge'

protected

$event_before_delete

$event_before_delete = 'onContentBeforeDelete'

protected

---

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

• IndexModel.php