Properties

$meta_description

$meta_description

$meta_keyword

$meta_keyword

$meta_robots

$meta_robots

$_widgets

$_widgets

$_early_scriptfiles

$_early_scriptfiles

$_late_scriptfiles

$_late_scriptfiles

$_words

$_words

$_model

$_model

$_parameters

$_parameters

$_cache

$_cache

Methods

SetMetaKey()

SetMetaKey( $ss)

Parameters

$ss

SetMetaRobots()

SetMetaRobots( $ss)

Parameters

$ss

SetMetaDescription()

SetMetaDescription( $ss)

Parameters

$ss

getFlashNotice()

getFlashNotice(bool $remove) : string

Get flash notice message and remove from session if needed

Parameters

bool $remove

True if message should be removed from session,

                false by default

Returns

string —

Flash notice message

getFlashError()

getFlashError(bool $remove) : string

Get flash error message and remove from session if needed

Parameters

bool $remove

True if message should be removed from session,

                false by default

Returns

string —

Flash error message

render()

render()

addWidget()

addWidget(\RoxWidget $widget)

Widgets added this way will be asked for stylesheet and scriptfile information TODO: evtl not a good idea to do it this way.

Parameters

\RoxWidget $widget

setModel()

setModel( $model)

some view classes need to store a model object.

Parameters

$model

createWidget()

createWidget( $classname)

Parameters

$classname

__call()

__call( $key,  $args)

Parameters

$key
$args

__construct()

__construct()

__get()

__get( $key)

Parameters

$key

__set()

__set( $key,  $value)

Parameters

$key
$value

refresh_get()

refresh_get( $key)

Parameters

$key

__toString()

__toString()

getStylesheets()

getStylesheets()

don't forget to call $stylesheets = parent::$this->getStylesheets(); when reimplementing this method!!

getPage_meta_keyword()

getPage_meta_keyword()

getPage_meta_robots()

getPage_meta_robots()

getPage_meta_description()

getPage_meta_description()

init()

init()

getStylesheetPatches()

getStylesheetPatches()

getTopmenuItems()

getTopmenuItems()

Return a list of items to show in the sub menu. Each item is an array of keyword, url and translatable Word

getTopmenuActiveItem()

getTopmenuActiveItem()

getSubmenuItems()

getSubmenuItems()

getSubmenuActiveItem()

getSubmenuActiveItem()

body()

body()

topnav()

topnav()

topmenu()

topmenu()

quicksearch()

quicksearch()

A tiny wee quicksearch box

columnsArea()

columnsArea()

getPageTitle()

getPageTitle()

teaser()

teaser()

teaserContent()

teaserContent()

submenu()

submenu()

footer()

footer()

leftoverTranslationLinks()

leftoverTranslationLinks()

debugInfo()

debugInfo()

getColumnNames()

getColumnNames()

column_col1()

column_col1()

column_col2()

column_col2()

volunteerMenu()

volunteerMenu()

getCallbackOutput()

getCallbackOutput(string $controller, string $method) : string

shortcut to get callback variables for form

Parameters

string $controller

controller to callback to

string $method

method in controller

Returns

string

getRedirectedMem()

getRedirectedMem(string $array) : array

returns the redirected post vars, if any

Parameters

string $array

which saved array to return from the redirected mem

Returns

array

getCustomElements()

getCustomElements() : array

skeleton method of getCustomElements

Returns

array

getScriptfiles()

getScriptfiles() : array

returns all registered early load scripts these are the scripts to be loaded in the html head element

Returns

array

getLateLoadScriptfiles()

getLateLoadScriptfiles() : array

returns all registered late load scripts these are the scripts to be loaded at the end of the page

Returns

array

addEarlyLoadScriptFile()

addEarlyLoadScriptFile(string $file) : void

registers a script for early loading

Parameters

string $file
  • js file to early load

addLateLoadScriptFile()

addLateLoadScriptFile(string $file) : void

registers a script for late loading

Parameters

string $file
  • js file to early load

printHTML()

printHTML()

includeStylesheets()

includeStylesheets()

includeCustomElements()

includeCustomElements()

allows for outputting custom elements in the page <head> element

includeJsConfig()

includeJsConfig()

Inserts JavaScript configuration.

Reads [javascript] section in rox.ini and makes it available via bwroxConfig object in JavaScript.

includeScriptfiles()

includeScriptfiles()

includeLateScriptfiles()

includeLateScriptfiles() : void

outputs script tags that include script files called at the end of pages

head()

head()

getPagePermalink()

getPagePermalink()

statusMessage()

statusMessage()

getModel()

getModel()

Get the model object that was stored using setModel

showTemplate()

showTemplate( $rel_path,  $args)

Parameters

$rel_path
$args

set_layoutkit()

set_layoutkit(\unknown_type $layoutkit)

called by the framework, to inject some essential values.

.

Parameters

\unknown_type $layoutkit

getTemplatePrefix()

getTemplatePrefix( $classname)

Parameters

$classname

getAppname()

getAppname( $classname)

Parameters

$classname

get()

get( $key)

Parameters

$key

getValues()

getValues()

getWords()

getWords() : object

returns an instance of the MOD_words class

Returns

object

logWrite()

logWrite(string $string, string $type)

wrapper for calls to MOD_log::get->write()

Parameters

string $string
string $type

getLog()

getLog() : object

wrapper function for MOD_log::get()

Returns

object

getVersionInfo()

getVersionInfo() : string

returns the revision number saved in revision.txt

Returns

string

_column()

_column( $column_name)

Parameters

$column_name

getFlash()

getFlash(string $type, bool $remove) : string

Get flash message and remove from session if needed

Parameters

string $type

Type of flash, i.e. "error" or "notice"

bool $remove

True if message should be removed from session,

                false by default

Returns

string —

Flash message