Class ContentModelArticle

Description

Content Component Article Model

  • since: 1.5

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

JObject
   |
   --JModelLegacy
      |
      --JModelItem
         |
         --ContentModelArticle
Direct descendents
Class Description
 class ContentModelForm Content Component Article Model
Variable Summary
 string $_context
Method Summary
 mixed getItem ([integer $pk = null])
 boolean hit ([integer $pk = 0])
 void populateState ()
 boolean storeVote ([integer $pk = 0], [integer $rate = 0])
Variables
string $_context = 'com_content.article' (line 26)

Model context string.

  • access: protected

Redefinition of:
JModelItem::$_context
Model context string.

Inherited Variables

Inherited from JModelItem

JModelItem::$_item

Inherited from JModelLegacy

JModelLegacy::$event_clean_cache
JModelLegacy::$name
JModelLegacy::$option
JModelLegacy::$state
JModelLegacy::$_db
JModelLegacy::$__state_set

Inherited from JObject

JObject::$_errors
Methods
getItem (line 71)

Method to get article data.

  • return: Menu item data object on success, false on failure.
  • access: public
mixed getItem ([integer $pk = null])
  • integer $pk: The id of the article.

Redefined in descendants as:
hit (line 268)

Increment the hit counter for the article.

  • return: True if successful; false otherwise and internal error set.
  • access: public
boolean hit ([integer $pk = 0])
  • integer $pk: Optional primary key of the article to increment.
populateState (line 37)

Method to auto-populate the model state.

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

  • since: 1.6
  • access: protected
void populateState ()

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

Redefined in descendants as:
storeVote (line 293)

Save user vote on article

  • return: Return true on success
  • access: public
boolean storeVote ([integer $pk = 0], [integer $rate = 0])
  • integer $pk: Joomla Article Id
  • integer $rate: Voting rate

Inherited Methods

Inherited From JModelItem

 JModelItem::getStoreId()

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