Class SearchModelSearch

Description

Search Component Search Model

  • since: 1.5

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

JObject
   |
   --JModel
      |
      --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 39)

Search areas

array $_data = null (line 25)

Sezrch data array

object $_pagination = null (line 46)

Pagination object

integer $_total = null (line 32)

Search total

Inherited Variables

Inherited from JModel

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

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 53)

Constructor

  • since: 1.5
SearchModelSearch __construct ()

Redefinition of:
JModel::__construct()
Constructor
getAreas (line 188)

Method to get the search areas

  • since: 1.5
void getAreas ()
getData (line 122)

Method to get weblink item data for the category

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

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

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

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

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

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 84)

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::addIncludePath()

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