Class LanguagesModelInstalled

Description

Languages Component Languages Model

  • since: 1.6

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

JObject
   |
   --JModel
      |
      --JModelList
         |
         --LanguagesModelInstalled
Variable Summary
object client $client
array $data
boolean|JExeption $ftp
int $langlist
string $option
string $path
int $total
object user $user
Method Summary
integer compareLanguages (object $lang1, object $lang2)
object &getClient ()
array &getData ()
array getFolders ()
object &getFtp ()
string getLanguageList ()
object &getOption ()
string getPath ()
string getStoreId ([string $id = ''])
integer getTotal ()
void populateState ([ $ordering = null], [ $direction = null])
boolean publish ( $cid)
Variables
object client $client = null (line 24)
  • var: object
  • access: protected
array $data = null (line 44)
  • var: languages description
  • access: protected
boolean|JExeption $ftp = null (line 34)
  • var: True, if FTP settings should be shown, or an exeption
  • access: protected
int $langlist = null (line 54)
  • var: total number pf languages installed
  • access: protected
string $option = null (line 39)
  • var: option name
  • access: protected

Redefinition of:
JModel::$option
The URL option for the component.
string $path = null (line 59)
  • var: language path
  • access: protected
int $total = null (line 49)
  • var: total number pf languages
  • access: protected
object user $user = null (line 29)
  • var: object
  • access: protected

Inherited Variables

Inherited from JModelList

JModelList::$cache
JModelList::$context
JModelList::$filter_fields
JModelList::$query

Inherited from JModel

JModel::$event_clean_cache
JModel::$name
JModel::$state
JModel::$_db
JModel::$__state_set

Inherited from JObject

JObject::$_errors
Methods
compareLanguages (line 366)

Method to compare two languages in order to sort them

  • since: 1.6
  • access: protected
integer compareLanguages (object $lang1, object $lang2)
  • object $lang1: the first language
  • object $lang2: the second language
getClient (line 112)

Method to get the client object

  • since: 1.6
  • access: public
object &getClient ()
getData (line 155)

Method to get Languages item data

  • since: 1.6
  • access: public
array &getData ()
getFolders (line 330)

Method to get the folders

  • return: Languages folders
  • since: 1.6
  • access: protected
array getFolders ()
getFtp (line 127)

Method to get the ftp credentials

  • since: 1.6
  • access: public
object &getFtp ()
getLanguageList (line 233)

Method to get installed languages data.

  • return: An SQL query
  • since: 1.6
  • access: protected
string getLanguageList ()
getOption (line 142)

Method to get the option

  • since: 1.6
  • access: public
object &getOption ()
getPath (line 347)

Method to get the path

  • return: The path to the languages folders
  • since: 1.6
  • access: protected
string getPath ()
getStoreId (line 98)

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.
getTotal (line 266)

Method to get the total number of Languages items

  • since: 1.6
  • access: public
integer getTotal ()

Redefinition of:
JModelList::getTotal()
Method to get the total number of items for the data set.
populateState (line 69)

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 = null], [ $direction = null])
  • $ordering
  • $direction

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

Method to set the default language

  • since: 1.6
  • access: public
boolean publish ( $cid)
  • $cid

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:55:51 -0500 by phpDocumentor 1.4.4