Docs For Class SearchHelper

Description

Search component helper.

since: 1.5

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

Method Summary

static void addSubmenu (string $vName)

static boolean checkNoHtml (object $object, string $searchTerm, array $fields)

static JObject getActions ()

static void limitSearchWord ( &$searchword)

static void logSearch (string $search_term)

static string prepareSearchContent (string $text, string $searchword)

static string remove_accents (string $str)

static void santiseSearchWord ( &$searchword, $searchphrase)

static string _smartSubstr (string $text, integer $searchword)

Methods

static addSubmenu (line 27)

Configure the Linkbar.

since: 1.6
access: public

static void addSubmenu (string $vName)

string $vName: The name of the active view.

static checkNoHtml (line 177)

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 $object, string $searchTerm, array $fields)

object $object: The object to check
string $searchTerm: Search words to check for
array $fields: List of object variables to check against

static getActions (line 37)

Gets a list of the actions that can be performed.

access: public

static JObject getActions ()

static limitSearchWord (line 102)

since: 1.5
access: public

static void limitSearchWord ( &$searchword)

&$searchword

static logSearch (line 137)

Logs a search term

deprecated: 4.0 Use JSearchHelper::logSearch() instead
since: 1.5
access: public

static void logSearch (string $search_term)

string $search_term: The term being searched

static prepareSearchContent (line 154)

Prepares results from search for display

since: 1.5
access: public

static string prepareSearchContent (string $text, string $searchword)

string $text: The source string
string $searchword: The searchword to select around

static remove_accents (line 230)

Transliterates given text to ASCII//TRANSLIT.

Simulates glibc transliteration style even if libiconv is used by PHP

since: 3.2
access: public

static string remove_accents (string $str)

string $str: String to remove accents from

static santiseSearchWord (line 53)

access: public

static void santiseSearchWord ( &$searchword, $searchphrase)

&$searchword
$searchphrase

static _smartSubstr (line 248)

returns substring of characters around a searchword

since: 1.5
access: public

static string _smartSubstr (string $text, integer $searchword)

string $text: The source string
integer $searchword: Number of chars to return