Class plgSearchWeblinks

Description

Weblinks Search plugin

  • since: 1.6

Located in /plugins/search/weblinks/weblinks.php (line 19)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgSearchWeblinks
Method Summary
plgSearchWeblinks __construct ( &$subject, array $config, object $subject)
void onContentSearch (string $text, [string $phrase = ''], [string $ordering = ''], [mixed $areas = null])
Variables

Inherited Variables

Inherited from JPlugin

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

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

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

Constructor

  • since: 1.5
  • access: public
plgSearchWeblinks __construct ( &$subject, array $config, object $subject)
  • object $subject: The object to observe
  • array $config: An array that holds the plugin configuration
  • &$subject

Redefinition of:
JPlugin::__construct()
Constructor
onContentSearch (line 55)

Weblink Search method

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

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 38)
  • return: An array of search areas
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()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 14:01:34 -0500 by phpDocumentor 1.4.4