Tariqa  3.0
 All Data Structures Namespaces Files Functions Variables Enumerations
Navigation Class Reference
Inheritance diagram for Navigation:
BaseModule mModule

Public Member Functions

 __construct ($config, $search, $translationTable, $text=null)
 onExecute ()
 getHeaders ()
 getDefaultTemplateFile ()
 canProcessRequest ()
 setOnBeforeNavigate ($code)
 setOnAfterNavigate ($code)

Protected Attributes

 $text = '   '

Detailed Description

Class for generating the navigation for articles


Constructor & Destructor Documentation

__construct ( config,
search,
translationTable,
text = null 
)

Constructs the object

Parameters:
array$configThe configuration array
multiAjaxSearch$searchThe multi AJAX search for which the navigation is performed
array$translationTableThe translation table (used to translate the texts from the navigation
string$textThe text to display between the icons [OPTIONAL] public
Returns:
void

Member Function Documentation

Process the request that have the page set to ajax

Reimplemented from mModule.

Gets the default template file

Parameters:
param_type$param_nameparam_desc public
Returns:
string|null

Reimplemented from mModule.

Gets the applications headers set by the module public

Returns:
array

Reimplemented from mModule.

onExecute ( )

Render the module

Returns:
string

Reimplemented from mModule.

setOnAfterNavigate ( code)

Sets the javascript code to be executed after navigating

Parameters:
string$codeThe javascript code public
Returns:
void
setOnBeforeNavigate ( code)

Sets the javascript code to be executed before navigating

Parameters:
string$codeThe javascript code public
Returns:
void

Field Documentation

$text = '   ' [protected]

The documentation for this class was generated from the following file: