Class plgSearchContacts

Description

Contacts Search plugin

  • since: 1.6

Located in /plugins/search/contacts/contacts.php (line 17)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgSearchContacts
Method Summary
plgSearchContacts __construct ( &$subject, array $config, object $subject)
void onContentSearch (string $text, [string $phrase = ''], [string $ordering = ''], [ $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 27)

Constructor

  • since: 1.5
  • access: public
plgSearchContacts __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 53)

Contacts 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 = ''], [ $areas = null])
  • string $text: Target search string
  • string $phrase: matching option, exact|any|all
  • string $ordering: ordering option, newest|oldest|popular|alpha|category
  • $areas
onContentSearchAreas (line 36)
  • 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 13:53:24 -0500 by phpDocumentor 1.4.4