Documentation

Template
in package

Table of Contents

Properties

$addRaceRadarChartJS  : int|null
$ajaxRefreshInterval  : int|false
$jsAlerts  : array<string|int, string>
$jsSources  : array<string|int, string>
$listjsInclude  : string|null
Defines a listjs_include.js function to call at the end of the HTML body.
$menuItems  : array<string|int, array{Link: string, Text: string}>|null
$pageRenderer  : Closure|null
Holds the Renderer for the skeleton middle panel.
$pageTopic  : string|null
$spaceView  : bool
$subMenuBar  : string|null
$ajaxJS  : array<string, mixed>

Methods

addJavascriptForAjax()  : string
addJavascriptSource()  : void
Registers a JS target for inclusion at the end of the HTML body.
display()  : void
Displays the template HTML. Stores any ajax-enabled elements for future comparison, and outputs modified elements in XML for ajax if requested.
displayForceTakenDamage()  : string
displayTakenDamage()  : string
doAn()  : string
getInstance()  : self
Return the Smr\Template in the DI container.
addJavascriptAlert()  : void
checkDisableAJAX()  : bool
Check if the HTML includes input elements where the user is able to input data (i.e. we don't want to AJAX update a form that they may have already started filling out).
convertHtmlToAjaxXml()  : string
displayDamage()  : string

Properties

$addRaceRadarChartJS

public int|null $addRaceRadarChartJS = null

$ajaxRefreshInterval

public int|false $ajaxRefreshInterval = false

$jsAlerts

public array<string|int, string> $jsAlerts = []

$jsSources

public array<string|int, string> $jsSources = []

$listjsInclude

Defines a listjs_include.js function to call at the end of the HTML body.

public string|null $listjsInclude = null

$menuItems

public array<string|int, array{Link: string, Text: string}>|null $menuItems = null

$pageRenderer

Holds the Renderer for the skeleton middle panel.

public Closure|null $pageRenderer = null

$pageTopic

public string|null $pageTopic = null
Hooks
public set

$spaceView

public bool $spaceView = false

$subMenuBar

public string|null $subMenuBar = null

$ajaxJS

private array<string, mixed> $ajaxJS = []

Methods

addJavascriptForAjax()

public addJavascriptForAjax(string $varName, mixed $obj) : string
Parameters
$varName : string
$obj : mixed
Return values
string

addJavascriptSource()

Registers a JS target for inclusion at the end of the HTML body.

public addJavascriptSource(string $src) : void
Parameters
$src : string

display()

Displays the template HTML. Stores any ajax-enabled elements for future comparison, and outputs modified elements in XML for ajax if requested.

public display(Closure $renderer[, bool $outputXml = false ]) : void
Parameters
$renderer : Closure
$outputXml : bool = false

displayForceTakenDamage()

public displayForceTakenDamage(ForceTakenDamage $damageTaken[, int $kamikaze = 0 ]) : string
Parameters
$damageTaken : ForceTakenDamage
$kamikaze : int = 0
Return values
string

doAn()

public static doAn(string $wordAfter) : string
Parameters
$wordAfter : string
Return values
string

getInstance()

Return the Smr\Template in the DI container.

public static getInstance() : self

If one does not exist yet, it will be created. This is the intended way to construct this class.

Return values
self

addJavascriptAlert()

protected addJavascriptAlert(string $string) : void
Parameters
$string : string

checkDisableAJAX()

Check if the HTML includes input elements where the user is able to input data (i.e. we don't want to AJAX update a form that they may have already started filling out).

protected checkDisableAJAX(string $html) : bool
Parameters
$html : string
Return values
bool

convertHtmlToAjaxXml()

protected convertHtmlToAjaxXml(string $str, bool $returnXml) : string
Parameters
$str : string
$returnXml : bool
Return values
string

displayDamage()

private displayDamage(array<string|int, array{int, string, string, string}> $damageTypes) : string
Parameters
$damageTypes : array<string|int, array{int, string, string, string}>
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results