Class ContentModelArticles

Description

This models supports retrieving lists of articles.

  • since: 1.6

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

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --ContentModelArticles
Direct descendents
Class Description
 class ContentModelArchive Content Component Archive Model
 class ContentModelFeatured Frontpage Component Model
Method Summary
 ContentModelArticles __construct ([array $config = array()])
 mixed getItems ()
 integer getStart ()
 string getStoreId ([string $id = ''])
 void populateState ([string $ordering = 'ordering'], [string $direction = 'ASC'])
Variables
Methods
Constructor __construct (line 29)

Constructor.

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

Redefinition of:
JModelList::__construct()
Constructor.
getItems (line 544)

Method to get a list of articles.

Overriden to inject convert the attribs field into a JParameter object.

  • return: An array of objects on success, false on failure.
  • since: 1.6
  • access: public
mixed getItems ()

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

Redefined in descendants as:
getListQuery (line 171)

Get the master query for retrieving a list of articles subject to the model state.

  • 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:
getStart (line 685)

Method to get the starting number of items for the data set.

  • return: The starting number of items available in the data set.
  • since: 12.2
  • access: public
integer getStart ()

Redefinition of:
JModelList::getStart()
Method to get the starting number of items for the data set.
getStoreId (line 141)

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.

Redefined in descendants as:
populateState (line 74)

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.

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

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

Redefined in descendants as:

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:03 +0100 by phpDocumentor 1.4.3