Documentation

viewVars
in package
Uses escapeHelper

Defaul view vars

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2022, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

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

Properties

$buttons

public array<string|int, mixed> $buttons

$currentModule

public string $currentModule

$dateTimeMask

public string $dateTimeMask

$dateTimeZone

public string $dateTimeZone

$deprecationNotice

public string $deprecationNotice

$filesCss

public array<string|int, mixed> $filesCss

$filesECMAFiles

public array<string|int, mixed> $filesECMAFiles

$filesJs

public array<string|int, mixed> $filesJs

$filesJsLate

public array<string|int, mixed> $filesJsLate

$formActionTarget

public string $formActionTarget

$frontEndLink

public string $frontEndLink

$includeForms

public string $includeForms

$messages

public array<string|int, mixed> $messages

$notificationString

public string $notificationString

$profileMenuButtons

public array<string|int, mixed> $profileMenuButtons

$showOffCanvas

public bool $showOffCanvas

$showPageToken

public bool $showPageToken

$toolbarItemRight

public string $toolbarItemRight

$varsJs

public array<string|int, mixed> $varsJs

$vars

Var values

private array<string|int, mixed> $vars = []

Methods

__call()

Return a view helper object

public __call(string $name, array<string|int, mixed> $arguments) : helper
Parameters
$name : string
$arguments : array<string|int, mixed>
Return values
helper —

__get()

Magic Getter

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

__set()

Magic setter

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

accordion()

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

alert()

public alert(string $type) : alert
Parameters
$type : string
Return values
alert —

badge()

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

button()

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

calcSize()

Calculates bytes sizes

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

checkbox()

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

controllerLink()

Returns controller link

public controllerLink(string $controller[, array<string|int, mixed> $params = [] ]) : string
Parameters
$controller : string
$params : array<string|int, mixed> = []
Tags
see
tools::getControllerLink
since
4.2
Return values
string —

dateText()

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

defaultBoxHalf()

Prints default box values

public final defaultBoxHalf() : void
Tags
since
4.5
Return values
void —

dropdown()

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

escape()

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

escapeVal()

Escapes given values

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

getIncludePath()

Return view include path

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

icon()

Returns icon view helper object

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

as own funktion

Return values
icon —

input()

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

pager()

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

select()

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

tabItem()

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

textarea()

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

textInput()

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

translate()

Returns result of language variable

public translate(string $var[, array<string|int, mixed> $params = [] ]) : string
Parameters
$var : string
$params : array<string|int, mixed> = []
Return values
string —

wrapper()

public wrapper(string $el, string $class, mixed $item) : wrapper
Parameters
$el : string
$class : string
$item : mixed
Return values
wrapper —

write()

Write result of language variable

public write(string $var[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
$var : string
$params : array<string|int, mixed> = []
Return values
mixed —

writeMonth()

Displays month name by ID

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

Search results