[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_messages/src/Model/ -> MessagesModel.php (summary)

(no description)

Copyright: (C) 2008 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 223 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

MessagesModel:: (5 methods):
  __construct()
  populateState()
  getStoreId()
  getListQuery()
  purge()


Class: MessagesModel  - X-Ref

Messages Component Messages Model

__construct($config = array()   X-Ref
Override parent constructor.

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

populateState($ordering = 'a.date_time', $direction = 'desc')   X-Ref
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: string  $ordering   An optional ordering field.
param: string  $direction  An optional direction (asc|desc).
return: void

getStoreId($id = '')   X-Ref
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: string  $id  A prefix for the store id.
return: string    A store id.

getListQuery()   X-Ref
Build an SQL query to load the list data.

return: \Joomla\Database\DatabaseQuery

purge(int $userId)   X-Ref
Purge the messages table of old messages for the given user ID.

param: int  $userId  The user id
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer