Yioop_V9.5_Source_Code_Documentation

HelpbuttonHelper extends Helper
in package

This is a helper class is used to draw help button for context sensitive help.

Tags
author

Eswara Rajesh Pinapala

Table of Contents

$back_params  : string
Query parameters as json array for page just came from
$is_help_initialized  : bool
Whether or not setupHelpParams() has been previously called
$localization_data  : array<string|int, mixed>
jaavscript locatization strings
$script  : string
Javascript needed to open a help button page
__construct()  : mixed
The constructor at this point initializes the all the required code for Wiki Help initialization.
clean()  : string
Used to clean strings that might be tainted as originate from the user
render()  : string
This method is used to render the help button, given a help point CSRF token and target controller name.
setupHelpParams()  : mixed
This Helper method is used to setup params needed for Context-Sensitive help to work. This gets executed if there is at least one help button rendered on the page. This is executed only once with the help of "is_help_initialized" variable.

Properties

$back_params

Query parameters as json array for page just came from

public string $back_params

$is_help_initialized

Whether or not setupHelpParams() has been previously called

public bool $is_help_initialized

$localization_data

jaavscript locatization strings

public array<string|int, mixed> $localization_data

$script

Javascript needed to open a help button page

public string $script

Methods

__construct()

The constructor at this point initializes the all the required code for Wiki Help initialization.

public __construct() : mixed
Return values
mixed —

clean()

Used to clean strings that might be tainted as originate from the user

public clean(mixed $value[, mixed $default = null ]) : string
Parameters
$value : mixed

tainted data

$default : mixed = null

if $value is not set default value is returned, this isn't used much since if the error_reporting is E_ALL or -1 you would still get a Notice.

Return values
string —

the clean input matching the type provided

render()

This method is used to render the help button, given a help point CSRF token and target controller name.

public render( $help_point_id,  $csrf_token_value[, mixed $as_html = false ]) : string
Parameters
$help_point_id :

used to set as help button id

$csrf_token_value :

CSRF token to make api call/open edit link

$as_html : mixed = false
Return values
string —

button html.

setupHelpParams()

This Helper method is used to setup params needed for Context-Sensitive help to work. This gets executed if there is at least one help button rendered on the page. This is executed only once with the help of "is_help_initialized" variable.

public setupHelpParams() : mixed
Return values
mixed — 

        

        
    




    

    

                

    

        

            
Search results