Class SearchModelSearch

Description

Search Component Search Model

  • since: 1.5

Located in /components/com_search/models/search.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --SearchModelSearch
Variable Summary
 integer $_areas
 array $_data
 object $_pagination
 integer $_total
Method Summary
 SearchModelSearch __construct ()
 void getAreas ()
 array getData ()
 integer getPagination ()
 integer getTotal ()
 void setAreas ([array $active = array()], [array $search = array()])
 void setSearch (string $keyword, [string $match = 'all'], [string $ordering = 'newest'])
Variables
integer $_areas = null (line 40)

Search areas

  • access: protected
array $_data = null (line 26)

Search data array

  • access: protected
object $_pagination = null (line 47)

Pagination object

  • access: protected
integer $_total = null (line 33)

Search total

  • 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
Constructor __construct (line 54)

Constructor

  • since: 1.5
  • access: public
SearchModelSearch __construct ()

Redefinition of:
JModelLegacy::__construct()
Constructor
getAreas (line 194)

Method to get the search areas

  • since: 1.5
  • access: public
void getAreas ()
getData (line 127)

Method to get weblink item data for the category

  • access: public
array getData ()
getPagination (line 178)

Method to get a pagination object of the weblink items for the category

  • access: public
integer getPagination ()
getTotal (line 167)

Method to get the total number of weblink items for the category

  • access: public
integer getTotal ()
setAreas (line 115)

Method to set the search areas

  • access: public
void setAreas ([array $active = array()], [array $search = array()])
  • array $active: Active areas
  • array $search: Search areas
setSearch (line 85)

Method to set the search parameters

  • access: public
void setSearch (string $keyword, [string $match = 'all'], [string $ordering = 'newest'])
  • string $keyword: search string
  • string $match: mathcing option, exact|any|all
  • string $ordering: ordering option, newest|oldest|popular|alpha|category

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:12:39 +0100 by phpDocumentor 1.4.3