Class SearchHelper

Description

Search component helper.

Located in /administrator/components/com_search/helpers/search.php (line 16)


	
			
Method Summary
static void addSubmenu (string $vName)
static boolean checkNoHtml (object The $object, string $searchTerm, array $fields)
static JObject getActions ()
static void limitSearchWord ( &$searchword)
static void logSearch ( $search_term)
static string prepareSearchContent (string $text, string $searchword)
static void santiseSearchWord ( &$searchword,  $searchphrase)
static string _smartSubstr (string $text, int $searchword, string 2)
Methods
static method addSubmenu (line 24)

Configure the Linkbar.

  • since: 1.6
  • access: public
static void addSubmenu (string $vName)
  • string $vName: The name of the active view.
static method checkNoHtml (line 171)

Checks an object for search terms (after stripping fields of HTML)

  • return: True if searchTerm is in object, false otherwise
  • access: public
static boolean checkNoHtml (object The $object, string $searchTerm, array $fields)
  • object The $object: object to check
  • string $searchTerm: Search words to check for
  • array $fields: List of object variables to check against
static method getActions (line 34)

Gets a list of the actions that can be performed.

  • access: public
static JObject getActions ()
static method limitSearchWord (line 89)
static void limitSearchWord ( &$searchword)
  • &$searchword
static method logSearch (line 111)
static void logSearch ( $search_term)
  • $search_term
static method prepareSearchContent (line 151)

Prepares results from search for display

  • access: public
static string prepareSearchContent (string $text, string $searchword)
  • string $text: The source string
  • string $searchword: The searchword to select around
static method santiseSearchWord (line 49)
static void santiseSearchWord ( &$searchword,  $searchphrase)
  • &$searchword
  • $searchphrase
static method _smartSubstr (line 204)

returns substring of characters around a searchword

static string _smartSubstr (string $text, int $searchword, string 2)
  • string 2: The searchword to select around
  • string $text: The source string
  • int $searchword: Number of chars to return

Documentation generated on Mon, 25 Jun 2012 13:59:25 -0500 by phpDocumentor 1.4.4