User Tools

Site Tools


Sidebar

Dokumentation

vortex:apidoc:display

Display

Display

Filename : /classes/display/display.php
Extends :

Description

Handles all output to screen for the Vortex. Parses HTML-templates and injects code snippets and data before presenting it to the browser.
Prior to version 1.4 this class used the Smarty framework but aiming to minimize the Vortex footprint and dependencies it now implements a custom parser for .t2 template files.

Fields

Methods

__construct()

Definition : public function __construct()

Returns :

Description
Constructs a new Display instance

Parameters

addWarning( $warning )

Definition : public function addWarning( $warning )

Returns :

Description
Add a warning to this output to be shown at the top of the screen

Parameters

$warning

Type : Warning
Default value :

Description
Warning to be displayed

assign( $var, $value )

Definition : public function assign( $var, $value )

Returns :

Description
Assigns the value to the named variable

Parameters

$value

Type : String/Array
Default value :

Description
Value to assign to the variable

$var

Type : String
Default value :

Description
Name of the variable to assign data to

assignText()

Definition : public function assignText()

Returns :

Description
Assign the language translations to the template engine

Parameters

display()

Definition : public function display()

Returns :

Description
Assign standard variables, output menu and headers and echo templated content to the browser

Parameters

escapeJavaScript( $str )

Definition : public function escapeJavaScript( $str )

Returns : String

Description
Return the string with javascript escaped to work

Parameters

$str

Type : String
Default value :

Description
String to escape

get_template_vars( $varname )

Definition : public function get_template_vars( $varname = null )

Returns : String/Array

Description
DEPRECATED, no functionallity implemented.

Parameters

parse( $caller )

Definition : public function parse( $caller )

Returns :

Description
Parse REQUEST input to the VORTEX

Parameters

$caller

Type : Object
Default value :

Description
The instance of the caller of this method, for callback functionallity

setmainscreen( $template, $final )

Definition : public function setmainscreen( $template, $final = false )

Returns :

Description
Set which template to use as mainscreen

Parameters

$final

Type : boolean
Default value : false

Description
If final is set to true no changes will be permitted in the future

$template

Type : String
Default value :

Description
T2 template to use as mainscreen

showMenu( $display )

Definition : public function showMenu( $display = true )

Returns :

Description
Set whether to display the menu

Parameters

$display

Type : boolean
Default value : true

Description
Whether to display the menu or not

toggleBorders( $borders )

Definition : public function toggleBorders( $borders = true )

Returns :

Description
Toggle whether the borders should be displayed or not

Parameters

$borders

Type : boolean
Default value : true

Description
Whether the borders should display or not

translate( $file )

Definition : public function translate( $file )

Returns : String

Description
Get the translation of the supplied T2 template file after all template transformations.

Parameters

$file

Type : String
Default value :

Description
Name of the .T2 template file to translate

vortex/apidoc/display.txt · Last modified: 2019/06/28 07:06 by hubbe