Docs For Class PlgSearchCategories

PlgSearchCategories

Description

Categories Search plugin

since: 1.6

Located in /plugins/search/categories/categories.php (line 21)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgSearchCategories

Variable Summary

boolean $autoloadLanguage

Method Summary

void onContentSearch (string $text, [string $phrase = ''], [string $ordering = ''], [mixed $areas = null])

array onContentSearchAreas ()

Variables

boolean $autoloadLanguage = true (line 29)

Load the language file on instantiation.

since: 3.1
access: protected

Redefinition of:

JPlugin::$autoloadLanguage: Affects constructor behavior. If true, language files will be loaded automatically.

Inherited Variables

Inherited from JPlugin

JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

onContentSearch (line 54)

Categories Search method

The sql must return the following fields that are used in a common display routine: href, title, section, created, text, browsernav

access: public

void onContentSearch (string $text, [string $phrase = ''], [string $ordering = ''], [mixed $areas = null])

string $text: Target search string
string $phrase: mathcing option, exact|any|all
string $ordering: ordering option, newest|oldest|popular|alpha|category
mixed $areas: An array if restricted to areas, null if search all

onContentSearchAreas (line 34)

return: An array of search areas
access: public

array onContentSearchAreas ()

Inherited Methods

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

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 14:55:16 +0100 by phpDocumentor 1.4.3