Class TagsModelTag

Description

Tags Component Tag Model

  • since: 3.1

Located in /components/com_tags/models/tag.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --TagsModelTag
Variable Summary
 array $items
 object $tag
Method Summary
 TagsModelTag __construct ([array $config = array()])
 object getItem ([integer $pk = null])
 mixed getItems ()
 string getListQuery ()
 boolean hit ([integer $pk = 0])
 void populateState ([string $ordering = 'c.core_title'], [string $direction = 'ASC'])
Variables
array $items = null (line 35)

The list of items associated with the tags.

  • since: 3.1
  • access: protected
object $tag = null (line 27)

The tags that apply.

  • since: 3.1
  • access: protected

Inherited Variables

Inherited from JModelList

JModelList::$cache
JModelList::$context
JModelList::$filterFormName
JModelList::$filter_fields
JModelList::$htmlFormName
JModelList::$query

Inherited from JModelLegacy

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

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 44)

Constructor.

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

Redefinition of:
JModelList::__construct()
Constructor.
getItem (line 254)

Method to get tag data for the current tag or tags

  • since: 3.1
  • access: public
object getItem ([integer $pk = null])
  • integer $pk: An optional ID
getItems (line 82)

Method to get a list of items for a list of tags.

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

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

Method to build an SQL query to load the list data of all items with a given tag.

  • return: An SQL query
  • since: 3.1
  • access: protected
string getListQuery ()

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

Increment the hit counter.

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

Method to auto-populate the model state.

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

  • since: 3.1
  • access: protected
void populateState ([string $ordering = 'c.core_title'], [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.

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