Référence de la classe FilterModel

Graphe d'héritage de FilterModel:

Fonctions membres publiques
	getFilter ()
	getForm ($data=array(), $loadData=true)
	getTotal ()
Fonctions membres publiques hérités de AdminModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	batch ($commands, $pks, $contexts)
	checkin ($pks=array())
	checkout ($pk=null)
	delete (&$pks)
	getItem ($pk=null)
	publish (&$pks, $value=1)
	reorder ($pks, $delta=0)
	save ($data)
	saveorder ($pks=array(), $order=null)
	generateTitle ($categoryId, $table)
	initBatch ()
	editAssociations ($data)
Fonctions membres publiques hérités de FormModel
	__construct ($config=array(), MVCFactoryInterface $factory=null, FormFactoryInterface $formFactory=null)
	checkin ($pk=null)
	checkout ($pk=null)
	validate ($form, $data, $group=null)
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
	cleanCache ($group='com_finder', $clientId=0)
	loadFormData ()
Fonctions membres protégées hérités de AdminModel
	batchAccess ($value, $pks, $contexts)
	batchCopy ($value, $pks, $contexts)
	cleanupPostBatchCopy (TableInterface $table, $newId, $oldId)
	batchLanguage ($value, $pks, $contexts)
	batchMove ($value, $pks, $contexts)
	batchTag ($value, $pks, $contexts)
	canDelete ($record)
	canEditState ($record)
	generateNewTitle ($categoryId, $alias, $title)
	getReorderConditions ($table)
	populateState ()
	prepareTable ($table)
	checkCategoryId ($categoryId)
	redirectToAssociations ($data)
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
	$text_prefix = 'COM_FINDER'
	$context = 'com_finder.filter'
Attributs protégés hérités de AdminModel
	$text_prefix = null
	$event_after_delete = null
	$event_after_save = null
	$event_before_delete = null
	$event_before_save = null
	$event_before_change_state = null
	$event_change_state = null
	$event_before_batch = null
	$batch_copymove = 'category_id'
	$batch_commands
	$associationsContext = null
	$batchSet = null
	$user = null
	$table = null
	$tableClassName = null
	$contentType = null
	$type = null
Attributs protégés hérités de FormModel
	$events_map = null
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='')
Champs de données hérités de AdminModel
	$typeAlias
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Filter model class for Finder.

Depuis

2.5

Documentation des fonctions membres

cleanCache()

cleanCache (   $group = 'com_finder',   $clientId = 0  )

protected

Custom clean cache method.

Paramètres

string	$group	The component name. [optional]
integer	$clientId

getFilter()

getFilter

(

)

Method to get the filter data.

Renvoie

FilterTable|boolean The filter data or false on a failure.

Depuis

2.5

Références $return, elseif, et Joomla\CMS\MVC\Model\getState().

getForm()

getForm	(		$data = array(),
			$loadData = true
	)

Method to get the record form.

Paramètres

array	$data	Data for the form. [optional]
boolean	$loadData	True if the form is to load its own data (default case), false if not. [optional]

Renvoie

Form|boolean A Form object on success, false on failure

Depuis

2.5

Implémente FormModelInterface.

Références $form, et Joomla\CMS\MVC\Model\loadForm().

getTotal()

getTotal

(

)

Method to get the total indexed items

Renvoie

number the number of indexed items

Depuis

3.5

Références $db, $query, et Joomla\Database\getDatabase().

loadFormData()

loadFormData ( )

protected

Method to get the data that should be injected in the form.

Renvoie

mixed The data for the form.

Depuis

2.5

Références $data, Factory\getApplication(), et Joomla\CMS\MVC\Model\preprocessData().

Documentation des champs

$context

$context = 'com_finder.filter'

protected

$text_prefix

$text_prefix = 'COM_FINDER'

protected

---

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

• FilterModel.php