Référence de la classe SearchHelper

Fonctions membres publiques statiques
static	addSubmenu ($vName)
static	getActions ()
static	santiseSearchWord (&$searchword, $searchphrase)
static	limitSearchWord (&$searchword)
static	logSearch ($searchTerm)
static	prepareSearchContent ($text, $searchword)
static	checkNoHtml ($object, $searchTerm, $fields)
static	remove_accents ($str)
static	_smartSubstr ($text, $searchword)

Description détaillée

Search component helper.

Depuis

1.5

Documentation des fonctions membres

_smartSubstr()

static _smartSubstr (   $text,   $searchword  )

static

Returns substring of characters around a searchword.

Paramètres

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

Renvoie

string

Depuis

1.5

Références $lang, et $text.

addSubmenu()

static addSubmenu (   $vName )

static

Configure the Linkbar.

Paramètres

string

$vName

The name of the active view.

Renvoie

void

Depuis

1.6

Référencé par SearchController\display().

checkNoHtml()

static checkNoHtml (   $object,   $searchTerm,   $fields  )

static

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

Paramètres

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

Renvoie

boolean True if searchTerm is in object, false otherwise.

Références $field, $fields, et $text.

Référencé par PlgSearchContent\onContentSearch().

getActions()

static getActions ( )

static

Gets a list of the actions that can be performed.

Renvoie

JObject

Obsolète:

3.2 Use JHelperContent::getActions() instead.

limitSearchWord()

static limitSearchWord ( &  $searchword )

static

Does search word need to be limited?

Paramètres

string

&$searchword

Search word to be checked.

Renvoie

boolean True if search word should be limited; false otherwise.

Depuis

1.5

Références $lang, et $upper_limit.

Référencé par SearchViewSearch\display().

logSearch()

static logSearch (   $searchTerm )

static

Logs a search term.

Paramètres

string

$searchTerm

The term being searched.

Renvoie

void

Depuis

1.5

Obsolète:

4.0 Use ::logSearch() instead.

Références logSearch().

Référencé par FinderViewSearch\display().

prepareSearchContent()

static prepareSearchContent (   $text,   $searchword  )

static

Prepares results from search for display.

Paramètres

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

Renvoie

string

Depuis

1.5

Références $text.

Référencé par SearchViewSearch\highLight().

remove_accents()

static remove_accents (   $str )

static

Transliterates given text to ASCII.

Paramètres

string

$str

String to remove accents from.

Renvoie

string

Depuis

3.2

Référencé par SearchViewSearch\highLight().

santiseSearchWord()

static santiseSearchWord ( &  $searchword,   $searchphrase  )

static

Sanitise search word.

Paramètres

string	&$searchword	Search word to be sanitised.
string	$searchphrase	Either 'all', 'any' or 'exact'.

Renvoie

boolean True if search word needs to be sanitised.

Références $lang.

Référencé par SearchViewSearch\display().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• administrator/components/com_search/helpers/search.php