Référence de la classe MessagesModel

Graphe d'héritage de MessagesModel:

Fonctions membres publiques
	__construct ($config=array(), MVCFactoryInterface $factory=null)
	purge (int $userId)
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
	populateState ($ordering='a.date_time', $direction='desc')
	getStoreId ($id='')
	getListQuery ()
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)

Membres hérités additionnels
Fonctions membres publiques statiques hérités de BaseModel
static	addIncludePath ($path='', $prefix='')
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()
Attributs protégés statiques hérités de BaseModel
static	$paths

Description détaillée

Messages Component Messages Model

Depuis

1.6

Documentation des constructeurs et destructeur

__construct()

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

Override parent constructor.

Paramètres

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

Voir également

Depuis

3.2

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

Documentation des fonctions membres

getListQuery()

getListQuery ( )

protected

Build an SQL query to load the list data.

Renvoie

Depuis

1.6

Références $db, $id, $query, $state, $this, $user, elseif, Joomla\Database\getDatabase(), Joomla\CMS\MVC\Model\getState(), Factory\getUser(), et ParameterType\INTEGER.

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.

Renvoie

string A store id.

Depuis

1.6

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

populateState()

populateState (   $ordering = 'a.date_time',   $direction = 'desc'  )

protected

Method to auto-populate the model state.

This method should only be called once per instantiation and is designed to be called on the first call to the getState() method unless the model configuration flag to ignore the request is set.

Note. Calling getState in this method will result in recursion.

Paramètres

string	$ordering	An optional ordering field.
string	$direction	An optional direction (asc|desc).

Renvoie

void

Depuis

1.6

Références $direction, $ordering, et Joomla\CMS\MVC\Model\populateState().

purge()

purge

(

int

$userId

)

Purge the messages table of old messages for the given user ID.

Paramètres

int

$userId

The user id

Renvoie

void

Depuis

4.2.0

Références $config, $db, $query, $userId, Joomla\Database\getDatabase(), Factory\getDate(), et ParameterType\INTEGER.

---

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

• com_messages/src/Model/MessagesModel.php