PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of ArticlesModel.php

(no description)

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

Defines 1 class

ArticlesModel:: (7 methods):
  __construct()
  getFilterForm()
  populateState()
  getStoreId()
  getListQuery()
  getTransitions()
  getItems()

Class: ArticlesModel - X-Ref

Methods supporting a list of article records.

__construct($config = array() X-Ref

Constructor.

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

getFilterForm($data = array() X-Ref

Get the filter form

param: array    $data      data
param: boolean  $loadData  load current data
return: \Joomla\CMS\Form\Form|null  The Form object or null if the form can't be found

populateState($ordering = 'a.id', $direction = 'desc') X-Ref

Method to auto-populate the model state.

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

getTransitions() X-Ref

Method to get all transitions at once for all articles

return: array|boolean

getItems() X-Ref

Method to get a list of articles.
Overridden to add item type alias.

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

PHP Cross Reference of Joomla 4.2.2 documentation

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

Defines 1 class