Class AdminModelHelp

Description

Admin Component Help Model

  • since: 1.6

Located in /administrator/components/com_admin/models/help.php (line 20)

JObject
   |
   --JModel
      |
      --AdminModelHelp
Variable Summary
string $help_search
string $lang_tag
string $page
array $toc
Method Summary
string &getHelpSearch ()
string &getLangTag ()
string &getPage ()
array &getToc ()
Variables
string $help_search = null (line 25)
  • var: the search string
  • access: protected
string $lang_tag = null (line 35)
  • var: the iso language tag
  • access: protected
string $latest_version_check = null (line 45)
  • var: url for the latest version check
  • access: protected
string $page = null (line 30)
  • var: the page to be viewed
  • access: protected
array $toc = null (line 40)
  • var: Table of contents
  • access: protected

Inherited Variables

Inherited from JModel

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

Inherited from JObject

JObject::$_errors
Methods
getHelpSearch (line 51)

Method to get the help search string

  • return: Help search string
string &getHelpSearch ()
getLangTag (line 75)

Method to get the lang tag

  • return: lang iso tag
string &getLangTag ()
getLatestVersionCheck (line 140)

Method to get the latest version check;

  • return: Latest Version Check URL
string &getLatestVersionCheck ()
getPage (line 62)

Method to get the page

  • return: page
string &getPage ()
getToc (line 93)

Method to get the toc

  • return: Table of contents
array &getToc ()

Inherited Methods

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