Class FinderModelFilters

Description

Filters model class for Finder.

  • since: 2.5

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

JObject
   |
   --JModel
      |
      --JModelList
         |
         --FinderModelFilters
Method Summary
FinderModelFilters __construct ([array $config = array()])
string getStoreId ([string $id = ''])
void populateState ([string $ordering = null], [string $direction = null])
Variables
Methods
Constructor __construct (line 31)

Constructor.

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

Redefinition of:
JModelList::__construct()
Constructor.
getListQuery (line 55)

Build an SQL query to load the list data.

  • return: A JDatabaseQuery object
  • 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 103)

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: 2.5
  • access: protected
string getStoreId ([string $id = ''])
  • string $id: A prefix for the store id. [optional]

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

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

  • since: 2.5
  • access: protected
void populateState ([string $ordering = null], [string $direction = null])
  • string $ordering: An optional ordering field. [optional]
  • string $direction: An optional direction. [optional]

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