Class FinderModelSearch

Description

Search model class for the Finder package.

  • since: 2.5

Located in /components/com_finder/models/search.php (line 27)

JObject
   |
   --JModel
      |
      --JModelList
         |
         --FinderModelSearch
Variable Summary
Method Summary
array getResults ()
array getResultsData ()
integer getResultsTotal ()
string getStoreId ([string $id = ''], [boolean $page = true])
JDatabaseQuery getTermsQuery (array $terms)
integer getTotal ()
void populateState ([string $ordering = null], [string $direction = null])
mixed retrieve (string $id, [boolean $persistent = true])
boolean store (string $id, mixed $data, [boolean $persistent = true])
Variables
string $context = 'com_finder.search' (line 35)

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.
array $excludedTerms = array() (line 53)

An array of all excluded terms ids.

  • since: 2.5
  • access: protected
array $includedTerms = array() (line 61)

An array of all included terms ids.

  • since: 2.5
  • access: protected
FinderIndexerQuery $query (line 45)

The query object is an instance of FinderIndexerQuery which contains and models the entire search query including the text input; static and dynamic taxonomy filters; date filters; etc.

  • since: 2.5
  • access: protected

Redefinition of:
JModelList::$query
An internal cache for the last query used.
array $requiredTerms = array() (line 69)

An array of all required terms ids.

  • since: 2.5
  • access: protected

Inherited Variables

Inherited from JModelList

JModelList::$cache
JModelList::$filter_fields

Inherited from JModel

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

Inherited from JObject

JObject::$_errors
Methods
getExcludedLinkIds (line 970)

Method to get an array of link ids that match excluded terms.

  • return: An array of links ids.
  • since: 2.5
  • throws: Exception on database error.
  • access: protected
array getExcludedLinkIds ()
getListQuery (line 218)

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.
getQuery (line 202)

Method to get the query object.

  • return: A query object.
  • since: 2.5
  • access: public
FinderIndexerQuery getQuery ()
getResults (line 79)

Method to get the results of the query.

  • return: An array of FinderIndexerResult objects.
  • since: 2.5
  • throws: Exception on database error.
  • access: public
array getResults ()
getResultsData (line 628)

Method to get the results for the search query.

  • return: An array of result data objects.
  • since: 2.5
  • throws: Exception on database error.
  • access: protected
array getResultsData ()
getResultsTotal (line 330)

Method to get the total number of results for the search query.

  • return: The results total.
  • since: 2.5
  • throws: Exception on database error.
  • access: protected
integer getResultsTotal ()
getStoreId (line 1089)

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 = ''], [boolean $page = true])
  • string $id: An identifier string to generate the store id. [optional]
  • boolean $page: True to store the data paged, false to store all data. [optional]

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

Method to get a subquery for filtering link ids mapped to specific terms ids.

  • return: A database object.
  • since: 2.5
  • access: protected
JDatabaseQuery getTermsQuery (array $terms)
  • array $terms: An array of search term ids.
getTotal (line 162)

Method to get the total number of results.

  • return: The total number of results.
  • since: 2.5
  • throws: Exception on database error.
  • access: public
integer getTotal ()

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

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.
retrieve (line 1243)

Method to retrieve data from cache.

  • return: The cached data if found, null otherwise.
  • since: 2.5
  • access: protected
mixed retrieve (string $id, [boolean $persistent = true])
  • string $id: The cache store id.
  • boolean $persistent: Flag to enable the use of external cache. [optional]
store (line 1280)

Method to store data in cache.

  • return: True on success, false on failure.
  • since: 2.5
  • access: protected
boolean store (string $id, mixed $data, [boolean $persistent = true])
  • string $id: The cache store id.
  • mixed $data: The data to cache.
  • boolean $persistent: Flag to enable the use of external cache. [optional]

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