[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/components/com_content/src/Model/ -> ArticlesModel.php (summary)

(no description)

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

Defines 1 class

ArticlesModel:: (7 methods):
  __construct()
  populateState()
  getStoreId()
  getListQuery()
  getItems()
  getStart()
  countItemsByMonth()


Class: ArticlesModel  - X-Ref

This models supports retrieving lists of articles.

__construct($config = array()   X-Ref
Constructor.

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

populateState($ordering = 'ordering', $direction = 'ASC')   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
Get the master query for retrieving a list of articles subject to the model state.

return: \Joomla\Database\DatabaseQuery

getItems()   X-Ref
Method to get a list of articles.

Overridden to inject convert the attribs field into a Registry object.

return: mixed  An array of objects on success, false on failure.

getStart()   X-Ref
Method to get the starting number of items for the data set.

return: integer  The starting number of items available in the data set.

countItemsByMonth()   X-Ref
Count Items by Month

return: mixed  An array of objects on success, false on failure.



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