Class AdminModelHelp

Description

Admin Component Help Model

  • since: 1.6

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

JObject
   |
   --JModelLegacy
      |
      --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 27)

The search string

  • since: 1.6
  • access: protected
string $lang_tag = null (line 43)

The iso language tag

  • since: 1.6
  • access: protected
string $latest_version_check = null (line 59)

URL for the latest version check

  • since: 1.6
  • access: protected
string $page = null (line 35)

The page to be viewed

  • since: 1.6
  • access: protected
array $toc = null (line 51)

Table of contents

  • since: 1.6
  • access: protected

Inherited Variables

Inherited from JModelLegacy

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

Inherited from JObject

JObject::$_errors
Methods
getHelpSearch (line 68)

Method to get the help search string

  • return: Help search string
  • since: 1.6
  • access: public
string &getHelpSearch ()
getLangTag (line 103)

Method to get the lang tag

  • return: lang iso tag
  • since: 1.6
  • access: public
string getLangTag ()
getLatestVersionCheck (line 182)

Method to get the latest version check

  • return: Latest Version Check URL
  • access: public
string &getLatestVersionCheck ()
getPage (line 85)

Method to get the page

  • return: The page
  • since: 1.6
  • access: public
string &getPage ()
getToc (line 125)

Method to get the toc

  • return: Table of contents
  • access: public
array &getToc ()

Inherited Methods

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