Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JSearch

Description
Description | Variables (details) | Methods (details)

Base search class

  • since: 1.5
  • author: Andrew Eddie

Located in /joomla/application/search.php (line 26) 

Class JObject   (Subpackage Base)

Class JSearch   (Subpackage Application)
Variable Summary
Description | Variables (details) | Methods (details)
Variable int $count
Variable int $limit
Variable int $limitstart
Variable string $matchType
Variable string $needle
Variable string $ordering
Variable array $results
Method Summary
Description | Variables (details) | Methods (details)
Constructor JSearch __construct ( $needle,  $matchType,  $ordering,  $areas, [ $limitstart = 0], [ $limit = 0])
Method void addResultCount (int $n)
Method void addResults (array $array)
Method array getAreas ()
Method string getMatchType ()
Method string getNeedle ()
Method string getOrdering ()
Method int getQueryLimit ()
Method int getQueryLimitStart ()
Method int getResultCount ()
Method array getResults ()
Method void setLimit (int $value)
Method void setLimitStart (int $value)
Variables
Description | Variables (details) | Methods (details)
int $count = null (line 56)
  • var: The number of results already returned
int $limit = null (line 51)
  • var: The total number of rows to return
int $limitstart = null (line 46)
  • var: The pagination for the complete result set
string $matchType = null (line 41)
  • var: The match type: all|any|exact
string $needle = null (line 31)
  • var: The text or phrase to search for
string $ordering = null (line 36)
  • var: The ordering for the search
array $results = null (line 61)
  • var: An array of results
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 78)

Constructor

JSearch __construct ( $needle,  $matchType,  $ordering,  $areas,  $limitstart,  $limit)
  • $needle
  • $matchType
  • $ordering
  • $areas
  • $limitstart
  • $limit
Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
addResultCount (line 138)

Adds the total number of returns of the current search plugin to the

running total and determines the limit and limitstart for the query

void addResultCount (int $n)
  • int $n
addResults (line 201)
void addResults (array $array)
  • array $array: An array of object results
getAreas (line 129)
array getAreas ()
getMatchType (line 115)
string getMatchType ()
getNeedle (line 122)
string getNeedle ()
getOrdering (line 108)
string getOrdering ()
getQueryLimit (line 193)

Returns the limit for the next search query

int getQueryLimit ()
getQueryLimitStart (line 184)

Returns the limit start for the next search query

int getQueryLimitStart ()
getResultCount (line 176)
int getResultCount ()
getResults (line 208)
array getResults ()
setLimit (line 101)
void setLimit (int $value)
  • int $value
setLimitStart (line 94)
void setLimitStart (int $value)
  • int $value

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 21:20:37 +0000 by phpDocumentor 1.3.1