[ Index ]

PHP Cross Reference of Joomla 2.5.4 DE

title

Body

[close]

/components/com_finder/models/ -> search.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License: GNU General Public License version 2 or later; see LICENSE
File Size: 1293 lines (36 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

FinderModelSearch:: (12 methods):
  getResults()
  getTotal()
  getQuery()
  getListQuery()
  getResultsTotal()
  getResultsData()
  getExcludedLinkIds()
  getTermsQuery()
  getStoreId()
  populateState()
  retrieve()
  store()


Class: FinderModelSearch  - X-Ref

Search model class for the Finder package.

getResults()   X-Ref
Method to get the results of the query.

return: array  An array of FinderIndexerResult objects.

getTotal()   X-Ref
Method to get the total number of results.

return: integer  The total number of results.

getQuery()   X-Ref
Method to get the query object.

return: FinderIndexerQuery  A query object.

getListQuery()   X-Ref
Method to build a database query to load the list data.

return: JDatabaseQuery  A database query.

getResultsTotal()   X-Ref
Method to get the total number of results for the search query.

return: integer  The results total.

getResultsData()   X-Ref
Method to get the results for the search query.

return: array  An array of result data objects.

getExcludedLinkIds()   X-Ref
Method to get an array of link ids that match excluded terms.

return: array  An array of links ids.

getTermsQuery($terms)   X-Ref
Method to get a subquery for filtering link ids mapped to specific
terms ids.

param: array  $terms  An array of search term ids.
return: JDatabaseQuery  A database object.

getStoreId($id = '', $page = true)   X-Ref
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.

param: string   $id    An identifier string to generate the store id. [optional]
param: boolean  $page  True to store the data paged, false to store all data. [optional]
return: string  A store id.

populateState($ordering = null, $direction = null)   X-Ref
Method to auto-populate the model state.  Calling getState in this method will result in recursion.

param: string  $ordering   An optional ordering field. [optional]
param: string  $direction  An optional direction. [optional]
return: void

retrieve($id, $persistent = true)   X-Ref
Method to retrieve data from cache.

param: string   $id          The cache store id.
param: boolean  $persistent  Flag to enable the use of external cache. [optional]
return: mixed  The cached data if found, null otherwise.

store($id, $data, $persistent = true)   X-Ref
Method to store data in cache.

param: string   $id          The cache store id.
param: mixed    $data        The data to cache.
param: boolean  $persistent  Flag to enable the use of external cache. [optional]
return: boolean  True on success, false on failure.



Generated: Tue Apr 3 11:40:28 2012 Cross-referenced by PHPXref 0.7.1