Class ContentModelArticles

Description

This models supports retrieving lists of articles.

  • since: 1.6

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

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

Constructor.

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

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

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 150)

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

  • since: 1.6
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 587)
  • access: public
void getStart ()

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

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 64)

Method to auto-populate the model state.

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

  • since: 1.6
  • access: protected
void populateState ([ $ordering = 'ordering'], [ $direction = 'ASC'])
  • $ordering
  • $direction

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

Redefined in descendants as:

Inherited Methods

Inherited From JModelList

JModelList::__construct()
JModelList::getItems()
JModelList::getListQuery()
JModelList::getPagination()
JModelList::getStart()
JModelList::getStoreId()
JModelList::getTotal()
JModelList::getUserStateFromRequest()
JModelList::populateState()
JModelList::_getListQuery()

Inherited From JModel

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

Inherited From JObject

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

Documentation generated on Mon, 25 Jun 2012 13:52:24 -0500 by phpDocumentor 1.4.4