Class LanguagesModelLanguages

Description

Languages Model Class

  • since: 1.6

Located in /administrator/components/com_languages/models/languages.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelList
         |
         --LanguagesModelLanguages
Method Summary
 LanguagesModelLanguages __construct ([array $config = array()])
 void cleanCache ([ $group = null], [ $client_id = 0])
 boolean delete (array $pks)
 string getListQuery ()
 string getStoreId ([string $id = ''])
 void populateState ([string $ordering = null], [string $direction = null])
 boolean setPublished (array $cid, [integer $value = 0])
Variables
Methods
Constructor __construct (line 28)

Constructor.

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

Redefinition of:
JModelList::__construct()
Constructor.
cleanCache (line 210)

Custom clean cache method, 2 places for 2 clients

  • since: 1.6
  • access: protected
void cleanCache ([ $group = null], [ $client_id = 0])
  • $group
  • $client_id

Redefinition of:
JModelLegacy::cleanCache()
Clean the cache
delete (line 180)

Method to delete records.

  • return: Returns true on success, false on failure.
  • since: 1.6
  • access: public
boolean delete (array $pks)
  • array $pks: An array of item primary keys.
getListQuery (line 109)

Method to build an SQL query to load the list data.

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

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

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

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.
setPublished (line 167)

Set the published language(s)

  • return: True on success, false otherwise.
  • since: 1.6
  • access: public
boolean setPublished (array $cid, [integer $value = 0])
  • array $cid: An array of language IDs.
  • integer $value: The value of the published 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:06:39 +0100 by phpDocumentor 1.4.3