error
extends view
in
Error View Objekt
Table of Contents
| $errorMessage | Error message | string |
|---|---|---|
| $backController | Destination controller for "Back" button | string |
| $icon | Icon class name | string |
| $viewPath | Complete view path | string |
| $viewName | View file name | string |
| $viewHash | View file path hash | string |
| $formAction | Form action path | string |
| $bodyClass | <body> CSS class | string |
| $showHeader | Include header and footer in view::render | int |
| $viewVars | View vars | array |
| $jsFiles | View JS files | array |
| $jsFilesLate | View JS files | array |
| $jsFilesLocal | Local view files in core/js | array |
| $cssFiles | View CSS files | array |
| $messages | View messages | array |
| $jsVars | View JS vars | array |
| $jsLangVars | View JS language vars | array |
| $buttons | Toolbar buttons | array |
| $notifications | Notifications | notifications |
| $defaultViewVars | Default vars object | viewVars |
| $cache | Cache object | cache |
| $session | Session object | session |
| $config | Config | config |
| $events | Events | events |
| $language | Config | language |
| $rendered | View was already rendered | bool |
| $showPageToken | View was already rendered | bool |
| $rootUrls | Root urls for replacements | array |
| __construct() | Konstruktor | mixed |
| render() | Renders view | bool |
| __construct() | Konstruktor | mixed |
| initFileLib() | Inits file library | bool |
| addRootPath() | Checks item if included system paths | mixed |
| getJsFileType() | Checks path type of given JS file | int |
| prepareNotifications() | Initializes notifications | bool |
| addJsFiles() | Add JavScript files to view | mixed |
| addJsFilesLate() | Add JavScript files to view | mixed |
| addCssFiles() | Add CSS files variable to view | mixed |
| addJsVars() | Add new JS vars | mixed |
| mergeJsVars() | Merge new JS vars | mixed |
| overrideCssFiles() | Overrides CSS files variable to view | mixed |
| overrideJsFiles() | Overrides new JS vars | mixed |
| overrideJsLangVars() | Overrides new JS language vars | mixed |
| addJsLangVars() | Add new JS language vars | mixed |
| addFromLibrary() | Add js and css files from 3rd party library | bool |
| addButtons() | Add array of buttons to toolbar | mixed |
| addButton() | Add button to toolbar | void |
| prependjQuery() | Force to load jQuery in Pub-Controllers before other JS-Files if not already done | mixed |
| assign() | Assign new variable to view | mixed |
| addTopDescription() | Adds top description | mixed |
| addErrorMessage() | Add red error message | void |
| addNoticeMessage() | Add blue notification message | void |
| addMessage() | Add yellow message | void |
| setHelpLink() | Set help link data | bool |
| showHeaderFooter() | Include header and footer into view, | mixed |
| render() | Renders a set up view | bool |
| initAssigns() | Initializes basic view vars | bool |
| getViewPath() | Returns view path | string |
| setViewPath() | Sets view path | mixed |
| getViewVars() | Return assigned view vars | mixed |
| setViewVars() | Overrides assigned view vars | mixed |
| setFieldAutofocus() | Auto focus element | mixed |
| setActiveNavigationElement() | Set active navigation item | bool |
| wasRendered() | Check if view was already rendered | bool |
| getViewHash() | Returns Sha256-hash on view path | string |
| setViewHashDefault() | Returns Sha256-hash on view path | bool |
| setFormAction() | Set form action path | void |
| setActiveTab() | Set Active tab | void |
| setBodyClass() | Set <body>-tag CSS class | void |
| showPageToken() | Enables output of page token field | $this |
| addDataView() | Adds dataview object to view variables | mixed |
| addTabs() | Sets view to standard tab view, do not use if you want to include tabs in aother view!!! | mixed |
| addPager() | Add pager to view | mixed |
| addToolbarRight() | Add HTML items into toolbar right hand to pager | mixed |
| triggerFilesEvents() | Triggers events addJsFiles/addCssFiles for given type | mixed |
| addAjaxPageToken() | Add AJAX page token to view | bool |
| initCssFiles() | Initialize default CSS files | array |
| initJsFiles() | Initialize default JavaScript files | array |
| isBrowser() | Checks User Agent for a certain browser | bool |
| getJsExt() | Return JS file extension | string |
Properties
$errorMessage
Error message
protected
string
$errorMessage
$backController
Destination controller for "Back" button
protected
string
$backController
$icon
Icon class name
protected
string
$icon
$viewPath
Complete view path
protected
string
$viewPath
= ''
$viewName
View file name
protected
string
$viewName
= ''
$viewHash
View file path hash
protected
string
$viewHash
= ''
$formAction
Form action path
protected
string
$formAction
= ''
$bodyClass
<body> CSS class
protected
string
$bodyClass
= ''
$showHeader
Include header and footer in view::render
protected
int
$showHeader
$viewVars
View vars
protected
array
$viewVars
= []
$jsFiles
View JS files
protected
array
$jsFiles
= []
$jsFilesLate
View JS files
protected
array
$jsFilesLate
= []
$jsFilesLocal
Local view files in core/js
protected
array
$jsFilesLocal
= []
$cssFiles
View CSS files
protected
array
$cssFiles
= []
$messages
View messages
protected
array
$messages
= []
$jsVars
View JS vars
protected
array
$jsVars
= []
$jsLangVars
View JS language vars
protected
array
$jsLangVars
= []
$buttons
Toolbar buttons
protected
array
$buttons
= []
$notifications
Notifications
protected
notifications
$notifications
$defaultViewVars
Default vars object
protected
viewVars
$defaultViewVars
$cache
Cache object
protected
cache
$cache
$session
Session object
protected
session
$session
$config
Config
protected
config
$config
$events
Events
protected
events
$events
$language
Config
protected
language
$language
$rendered
View was already rendered
protected
bool
$rendered
= false
$showPageToken
View was already rendered
protected
bool
$showPageToken
= true
$rootUrls
Root urls for replacements
protected
array
$rootUrls
= []
Methods
__construct()
Konstruktor
public
__construct(
$errorMessage :
string
[, $backController :
string
= null ]
[, $icon :
string
= null ]
)
: mixed
Parameters
- $errorMessage : string
- $backController : string = null
- $icon : string = null
Return values
mixedrender()
Renders view
public
render(
[ $exit :
bool
= true ]
)
: bool
Parameters
- $exit : bool = true
Return values
bool__construct()
Konstruktor
public
__construct(
[ $viewName :
string
= '' ]
[, $module :
string
= false ]
)
: mixed
Parameters
- $viewName : string = ''
Viewname ohne Endung .php
- $module : string = false
Module-Key
Return values
mixedinitFileLib()
Inits file library
protected
initFileLib(
)
: bool
Return values
booladdRootPath()
Checks item if included system paths
private
addRootPath(
$item :
string
)
: mixed
Parameters
- $item : string
Tags
Return values
mixedgetJsFileType()
Checks path type of given JS file
private
getJsFileType(
$item :
string
, &$jsCorePath :
string
)
: int
Parameters
- $item : string
- $jsCorePath : string
Tags
Return values
intprepareNotifications()
Initializes notifications
protected
prepareNotifications(
)
: bool
Return values
booladdJsFiles()
Add JavScript files to view
public
addJsFiles(
$jsFiles :
array
)
: mixed
Parameters
- $jsFiles : array
Return values
mixedaddJsFilesLate()
Add JavScript files to view
public
addJsFilesLate(
$jsFilesLate :
array
)
: mixed
Parameters
- $jsFilesLate : array
Return values
mixedaddCssFiles()
Add CSS files variable to view
public
addCssFiles(
$cssFiles :
array
)
: mixed
Parameters
- $cssFiles : array
Return values
mixedaddJsVars()
Add new JS vars
public
addJsVars(
$jsVars :
mixed
)
: mixed
Parameters
- $jsVars : mixed
Return values
mixedmergeJsVars()
Merge new JS vars
protected
mergeJsVars(
$jsVar :
string
, $jsVars :
array
)
: mixed
Parameters
- $jsVar : string
- $jsVars : array
Return values
mixedoverrideCssFiles()
Overrides CSS files variable to view
public
overrideCssFiles(
$cssFiles :
array
)
: mixed
Parameters
- $cssFiles : array
Return values
mixedoverrideJsFiles()
Overrides new JS vars
public
overrideJsFiles(
$jsFiles :
mixed
)
: mixed
Parameters
- $jsFiles : mixed
Return values
mixedoverrideJsLangVars()
Overrides new JS language vars
public
overrideJsLangVars(
$jsVars :
array
)
: mixed
Parameters
- $jsVars : array
Return values
mixedaddJsLangVars()
Add new JS language vars
public
addJsLangVars(
$jsVars :
mixed
)
: mixed
Parameters
- $jsVars : mixed
Return values
mixedaddFromLibrary()
Add js and css files from 3rd party library
public
final addFromLibrary(
$lib :
string
[, $jsFiles :
array
= [] ]
[, $cssFiles :
array
= [] ]
)
: bool
Parameters
- $lib : string
- $jsFiles : array = []
- $cssFiles : array = []
Tags
Return values
booladdButtons()
Add array of buttons to toolbar
public
addButtons(
$buttons :
array
)
: mixed
Parameters
- $buttons : array
Array of fpcm/view/helper/helper items
Return values
mixedaddButton()
Add button to toolbar
public
addButton(
$button :
button
[, $pos :
type
= false ]
)
: void
Parameters
- $button : button
- $pos : type = false
prependjQuery()
Force to load jQuery in Pub-Controllers before other JS-Files if not already done
public
prependjQuery(
)
: mixed
Tags
Return values
mixedassign()
Assign new variable to view
public
assign(
$varName :
string
, $varValue :
mixes
)
: mixed
Parameters
- $varName : string
- $varValue : mixes
Return values
mixedaddTopDescription()
Adds top description
public
addTopDescription(
$descr :
string
[, $params :
array
= [] ]
)
: mixed
Parameters
- $descr : string
- $params : array = []
Tags
Return values
mixedaddErrorMessage()
Add red error message
public
addErrorMessage(
$messageText :
string
[, $params :
string
= [] ]
)
: void
Parameters
- $messageText : string
- $params : string = []
addNoticeMessage()
Add blue notification message
public
addNoticeMessage(
$messageText :
string
[, $params :
string
= [] ]
)
: void
Parameters
- $messageText : string
- $params : string = []
addMessage()
Add yellow message
public
addMessage(
$messageText :
string
[, $params :
string
= [] ]
)
: void
Parameters
- $messageText : string
- $params : string = []
setHelpLink()
Set help link data
public
setHelpLink(
$entry :
string
, $chapter :
int
)
: bool
Parameters
- $entry : string
- $chapter : int
Return values
boolshowHeaderFooter()
Include header and footer into view,
public
showHeaderFooter(
$showHeader :
int
)
: mixed
Parameters
- $showHeader : int
Tags
Return values
mixedrender()
Renders a set up view
public
render(
)
: bool
Return values
boolinitAssigns()
Initializes basic view vars
protected
initAssigns(
)
: bool
Return values
boolgetViewPath()
Returns view path
public
getViewPath(
)
: string
Return values
stringsetViewPath()
Sets view path
public
setViewPath(
$viewName :
string
[, $module :
string
= false ]
)
: mixed
Parameters
- $viewName : string
- $module : string = false
Return values
mixedgetViewVars()
Return assigned view vars
public
getViewVars(
[ $var :
string
= false ]
)
: mixed
Parameters
- $var : string = false
Return values
mixedsetViewVars()
Overrides assigned view vars
public
setViewVars(
$viewVars :
array
)
: mixed
Parameters
- $viewVars : array
Return values
mixedsetFieldAutofocus()
Auto focus element
public
setFieldAutofocus(
$elementId :
string
)
: mixed
Parameters
- $elementId : string
Return values
mixedsetActiveNavigationElement()
Set active navigation item
public
setActiveNavigationElement(
$elementId :
string
)
: bool
Parameters
- $elementId : string
Return values
boolwasRendered()
Check if view was already rendered
public
wasRendered(
)
: bool
Return values
boolgetViewHash()
Returns Sha256-hash on view path
public
getViewHash(
)
: string
Tags
Return values
stringsetViewHashDefault()
Returns Sha256-hash on view path
public
setViewHashDefault(
$viewHash :
string
)
: bool
Parameters
- $viewHash : string
Tags
Return values
boolsetFormAction()
Set form action path
public
setFormAction(
$controller :
string
[, $params :
array
= [] ]
[, $isLink :
bool
= false ]
)
: void
Parameters
- $controller : string
- $params : array = []
- $isLink : bool = false
setActiveTab()
Set Active tab
public
setActiveTab(
$tab :
int
)
: void
Parameters
- $tab : int
Tags
setBodyClass()
Set <body>-tag CSS class
public
setBodyClass(
$bodyClass :
int
)
: void
Parameters
- $bodyClass : int
Tags
showPageToken()
Enables output of page token field
public
showPageToken(
$showPageToken :
bool
)
: $this
Parameters
- $showPageToken : bool
Return values
$thisaddDataView()
Adds dataview object to view variables
public
addDataView(
$dataView :
dataView
)
: mixed
Parameters
- $dataView : dataView
Return values
mixedaddTabs()
Sets view to standard tab view, do not use if you want to include tabs in aother view!!!
public
addTabs(
$tabsId :
string
, $tabs :
array
[, $tabsClass :
string
= '' ]
)
: mixed
Parameters
- $tabsId : string
- $tabs : array
- $tabsClass : string = ''
Tags
Return values
mixedaddPager()
Add pager to view
public
addPager(
$pager :
pager
)
: mixed
Parameters
- $pager : pager
Return values
mixedaddToolbarRight()
Add HTML items into toolbar right hand to pager
public
addToolbarRight(
$data :
string
)
: mixed
Parameters
- $data : string
Tags
Return values
mixedtriggerFilesEvents()
Triggers events addJsFiles/addCssFiles for given type
public
triggerFilesEvents(
[ $type :
string
= 'theme' ]
)
: mixed
Parameters
- $type : string = 'theme'
Return values
mixedaddAjaxPageToken()
Add AJAX page token to view
public
addAjaxPageToken(
$name :
string
)
: bool
Parameters
- $name : string
Tags
Return values
boolinitCssFiles()
Initialize default CSS files
private
initCssFiles(
)
: array
Return values
arrayinitJsFiles()
Initialize default JavaScript files
private
initJsFiles(
)
: array
Return values
arrayisBrowser()
Checks User Agent for a certain browser
public
static isBrowser(
$key :
string
)
: bool
Parameters
- $key : string
Tags
Return values
boolgetJsExt()
Return JS file extension
public
final static getJsExt(
)
: string