Class ContentModelArticles

Description

Methods supporting a list of article records.

  • since: 1.6

Located in /administrator/components/com_content/models/articles.php (line 20)

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --ContentModelArticles
Direct descendents
Class Description
 class ContentModelFeatured About Page Model
Method Summary
 ContentModelArticles __construct ([array $config = array()])
 mixed getItems ()
 string getStoreId ([string $id = ''])
 void populateState ([string $ordering = null], [string $direction = null])
Variables
Methods
Constructor __construct (line 30)

Constructor.

ContentModelArticles __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings.

Redefinition of:
JModelList::__construct()
Constructor.

Redefined in descendants as:
getAuthors (line 341)

Build a list of authors

  • since: 1.6
  • access: public
JDatabaseQuery getAuthors ()
getItems (line 369)

Method to get a list of articles.

Overridden to add a check for access levels.

  • return: An array of data items on success, false on failure.
  • since: 1.6.1
  • access: public
mixed getItems ()

Redefinition of:
JModelList::getItems()
Method to get an array of data items.
getListQuery (line 160)

Build an SQL query to load the list data.

  • since: 1.6
  • access: protected
JDatabaseQuery getListQuery ()

Redefinition of:
JModelList::getListQuery()
Method to get a JDatabaseQuery object for retrieving the data set from a database.

Redefined in descendants as:
getStoreId (line 140)

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.

  • return: A store id.
  • since: 1.6
  • access: protected
string getStoreId ([string $id = ''])
  • string $id: A prefix for the store id.

Redefinition of:
JModelList::getStoreId()
Method to get a store id based on the model configuration state.
populateState (line 80)

Method to auto-populate the model state.

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

  • since: 1.6
  • access: protected
void populateState ([string $ordering = null], [string $direction = null])
  • string $ordering: An optional ordering field.
  • string $direction: An optional direction (asc|desc).

Redefinition of:
JModelList::populateState()
Method to auto-populate the model state.

Inherited Methods

Inherited From JModelList

 JModelList::__construct()
 JModelList::getActiveFilters()
 JModelList::getFilterForm()
 JModelList::getItems()
 JModelList::getListQuery()
 JModelList::getPagination()
 JModelList::getStart()
 JModelList::getStoreId()
 JModelList::getTotal()
 JModelList::getUserStateFromRequest()
 JModelList::loadForm()
 JModelList::loadFormData()
 JModelList::populateState()
 JModelList::preprocessForm()
 JModelList::_getListQuery()

Inherited From JModelLegacy

 JModelLegacy::__construct()
 JModelLegacy::addIncludePath()
 JModelLegacy::addTablePath()
 JModelLegacy::cleanCache()
 JModelLegacy::getDbo()
 JModelLegacy::getInstance()
 JModelLegacy::getName()
 JModelLegacy::getState()
 JModelLegacy::getTable()
 JModelLegacy::loadHistory()
 JModelLegacy::populateState()
 JModelLegacy::setDbo()
 JModelLegacy::setState()
 JModelLegacy::_createFileName()
 JModelLegacy::_createTable()
 JModelLegacy::_getList()
 JModelLegacy::_getListCount()

Inherited From JObject

 JObject::__construct()
 JObject::def()
 JObject::get()
 JObject::getError()
 JObject::getErrors()
 JObject::getProperties()
 JObject::set()
 JObject::setError()
 JObject::setProperties()
 JObject::__toString()

Documentation generated on Tue, 19 Nov 2013 14:54:01 +0100 by phpDocumentor 1.4.3