Documentation

viewVars
in
Uses escapeHelper

Defaul view vars

Table of Contents

$vars Var values array
$version string
$self string
$dateTimeMask string
$dateTimeZone string
$currentModule string
$themePath string
$frontEndLink string
$basePath string
$notificationString string
$helpLink string
$formActionTarget string
$langCode string
$bodyClass string
$toolbarItemRight string
$toolbarArea string
$ipAddress string
$loginTime int
$permissions permissions
$navigation navigationList
$navigationActiveModule array
$messages array
$filesJs array
$filesJsLate array
$filesCss array
$varsJs array
$buttons array
$loggedIn bool
$fullWrapper bool
$showPageToken bool
$currentUser author
$pager pager
__get() Magic Getter mixed|null
__set() Magic setter mixed
__call() Return a view helper object helper
getIncludePath() Return view include path string
write() Write result of language variable mixed
translate() Returns result of language variable string
writeMonth() Displays month name by ID mixed
controllerLink() Returns controller link string
calcSize() Calculates bytes sizes string
pageTokenField() Returns page token field view helper object pageTokenField
icon() Returns icon view helper object icon
defaultBoxHalf() Prints default box values void
badge() badge
boolSelect() boolSelect
boolToText() boolToText
button() button
checkbox() checkbox
clearArticleCacheButton() clearArticleCacheButton
dateText() dateText
dateTimeInput() dateTimeInput
deleteButton() deleteButton
editButton() editButton
escape() escape
hiddenInput() hiddenInput
input() input
linkButton() linkButton
openButton() openButton
pager() pager
passwordInput() passwordInput
radiobutton() radiobutton
radiocheck() radiocheck
resetButton() resetButton
saveButton() saveButton
select() select
shorthelpButton() shorthelpButton
submitButton() submitButton
tabItem() tabItem
textInput() textInput
textarea() textarea
escapeVal() Escapes given values void

Properties

$vars

Var values

private array $vars = []

$dateTimeMask

public string $dateTimeMask

$dateTimeZone

public string $dateTimeZone

$currentModule

public string $currentModule

$frontEndLink

public string $frontEndLink

$notificationString

public string $notificationString

$formActionTarget

public string $formActionTarget

$toolbarItemRight

public string $toolbarItemRight

$navigationActiveModule

public array $navigationActiveModule

$showPageToken

public bool $showPageToken

Methods

__get()

Magic Getter

public __get( $name : string ) : mixed|null
Parameters
$name : string
Return values
mixed|null

__set()

Magic setter

public __set( $name : string , $value : mixed ) : mixed
Parameters
$name : string
$value : mixed
Return values
mixed

__call()

Return a view helper object

public __call( $name : string , $arguments : array ) : helper
Parameters
$name : string
$arguments : array
Return values
helper

getIncludePath()

Return view include path

public getIncludePath( $view : string ) : string
Parameters
$view : string
Return values
string

write()

Write result of language variable

public write( $var : string [, $params : array = [] ] ) : mixed
Parameters
$var : string
$params : array = []
Return values
mixed

translate()

Returns result of language variable

public translate( $var : string [, $params : array = [] ] ) : string
Parameters
$var : string
$params : array = []
Return values
string

writeMonth()

Displays month name by ID

public writeMonth( $monthId : int ) : mixed
Parameters
$monthId : int
Tags
see
Return values
mixed

controllerLink()

Returns controller link

public controllerLink( $controller : string [, $params : array = [] ] ) : string
Parameters
$controller : string
$params : array = []
Tags
see
since
Return values
string

calcSize()

Calculates bytes sizes

public calcSize( $value : int [, $decimals : int = 2 ] [, $delimDec : string = ',' ] [, $delimTousands : string = '.' ] ) : string
Parameters
$value : int
$decimals : int = 2
$delimDec : string = ','
$delimTousands : string = '.'
Tags
see
since
Return values
string

icon()

Returns icon view helper object

public final icon( $icon : string [, $prefix : string = 'fa' ] [, $useFa : bool = true ] ) : icon
Parameters
$icon : string
$prefix : string = 'fa'
$useFa : bool = true
Tags
since

as own funktion

Return values
icon

defaultBoxHalf()

Prints default box values

public final defaultBoxHalf( ) : void
Tags
since

badge()

public badge( $name : string , $id : string ) : badge
Parameters
$name : string
$id : string
Return values
badge

button()

public button( $name : string , $id : string ) : button
Parameters
$name : string
$id : string
Return values
button

checkbox()

public checkbox( $name : string , $id : string ) : checkbox
Parameters
$name : string
$id : string
Return values
checkbox

dateText()

public dateText( $timespan : int , $format : string ) : dateText
Parameters
$timespan : int
$format : string
Return values
dateText

escape()

public escape( $value : mixed , $mode : int ) : escape
Parameters
$value : mixed
$mode : int
Return values
escape

input()

public input( $name : string , $id : string ) : input
Parameters
$name : string
$id : string
Return values
input

pager()

public pager( $actionLink : string , $currentPage : int , $currentPageItemsCount : int , $itemsPerPage : int , $maxItemCount : int ) : pager
Parameters
$actionLink : string
$currentPage : int
$currentPageItemsCount : int
$itemsPerPage : int
$maxItemCount : int
Return values
pager

select()

public select( $name : string , $id : string ) : select
Parameters
$name : string
$id : string
Return values
select

tabItem()

public tabItem( $name : string , $id : string ) : tabItem
Parameters
$name : string
$id : string
Return values
tabItem

textInput()

public textInput( $name : string , $id : string ) : textInput
Parameters
$name : string
$id : string
Return values
textInput

textarea()

public textarea( $name : string , $id : string ) : textarea
Parameters
$name : string
$id : string
Return values
textarea

escapeVal()

Escapes given values

public escapeVal( $value : string [, $mode : int = null ] ) : void
Parameters
$value : string
$mode : int = null

Search results