Class FinderModelSuggestions

Description

Suggestions model class for the Finder package.

  • since: 2.5

Located in /components/com_finder/models/suggestions.php (line 21)

JObject
   |
   --JModel
      |
      --JModelList
         |
         --FinderModelSuggestions
Variable Summary
string $context
Method Summary
array getItems ()
string getStoreId ([string $id = ''])
void populateState ()
Variables
string $context = 'com_finder.suggestions' (line 29)

Context string for the model type.

  • since: 2.5
  • access: protected

Redefinition of:
JModelList::$context
Context string for the model type. This is used to handle uniqueness when dealing with the getStoreId() method and caching data structures.

Inherited Variables

Inherited from JModelList

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

Inherited from JModel

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

Inherited from JObject

JObject::$_errors
Methods
getItems (line 38)

Method to get an array of data items.

  • return: An array of data items.
  • since: 2.5
  • access: public
array getItems ()

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

Method to build a database query to load the list data.

  • return: A database query
  • since: 2.5
  • access: protected
JDatabaseQuery getListQuery ()

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

Method to get a store id based on model the 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: 2.5
  • access: protected
string getStoreId ([string $id = ''])
  • string $id: An identifier string to generate the store id. [optional]

Redefinition of:
JModelList::getStoreId()
Method to get a store id based on the model configuration state.
populateState (line 109)

Method to auto-populate the model state. Calling getState in this method will result in recursion.

  • since: 2.5
  • access: protected
void populateState ()

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

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