\webSearch

Summary

Methods
Properties
Constants
prepareData()
render()
setup()
getType()
getName()
getVersion()
getDependencies()
highlightWords()
$introText
$searchForm
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$moduleKey
$pluginVersion
$moduleType
$dependencies
N/A

Properties

$introText

$introText : 

Type

$searchForm

$searchForm : 

Type

$moduleKey

$moduleKey : 

Type

$pluginVersion

$pluginVersion : 

Type

$moduleType

$moduleType : 

Type

$dependencies

$dependencies : 

Type

Methods

prepareData()

prepareData() : mixed

Launches the data processing step of all modules, executing their own prepareData() function

Returns

mixed

render()

render(  $mainTemplate) : mixed

Launches the rendering step of all modules, executing their own render() function

Parameters

$mainTemplate

Returns

mixed

setup()

setup() 

getType()

getType() : string

must return one or several plugin types separated by comas current possible values are "backend, frontend, authentification"

Returns

string —

coma separated list of current module execution context types

getName()

getName() 

getVersion()

getVersion() 

getDependencies()

getDependencies() 

highlightWords()

highlightWords(string  $text, array  $words) : string

Returns the given text with tags to highlight the specified words.

Parameters

string $text
array $words

Returns

string