Class PlgSearchContent

Description
Description | Vars | Methods (details)

Content Search plugin

  • since: 1.6

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

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgSearchContent
Method Summary
Description | Vars | Methods (details)
void onContentSearch (string $text, [string $phrase = ''], [string $ordering = ''], [mixed $areas = null])
array onContentSearchAreas ()
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from JPlugin

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

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
Description | Vars Methods (details)
onContentSearch (line 43)

Content 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 the search it to be restricted to areas, null if search all
onContentSearchAreas (line 26)
  • 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:56:50 +0100 by phpDocumentor 1.4.3