Documentation

view
in

Default view object

Table of Contents

INCLUDE_HEADER_FULL 0b1
INCLUDE_HEADER_SIMPLE 0b10
INCLUDE_HEADER_NONE 0b100
ROOTURL_CORE_JS '{$coreJs}'
ROOTURL_CORE_THEME '{$coreTheme}'
ROOTURL_LIB '{$lib}'
ROOTURL_UNIQUE '{$unique}'
PATH_COMPONENTS '{$components}'
JS_FILETYP_URL 0b100
JS_FILETYP_FILE 0b10
JS_FILETYP_FILE_EXT 0b1
JS_FILES_CACHE 'themejsfiles/'
$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
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

Constants

INCLUDE_HEADER_FULL

mixed $INCLUDE_HEADER_FULL = 0b1

INCLUDE_HEADER_SIMPLE

mixed $INCLUDE_HEADER_SIMPLE = 0b10

INCLUDE_HEADER_NONE

mixed $INCLUDE_HEADER_NONE = 0b100

ROOTURL_CORE_JS

mixed $ROOTURL_CORE_JS = '{$coreJs}'

ROOTURL_CORE_THEME

mixed $ROOTURL_CORE_THEME = '{$coreTheme}'

ROOTURL_LIB

mixed $ROOTURL_LIB = '{$lib}'

ROOTURL_UNIQUE

mixed $ROOTURL_UNIQUE = '{$unique}'

PATH_COMPONENTS

mixed $PATH_COMPONENTS = '{$components}'

JS_FILETYP_URL

mixed $JS_FILETYP_URL = 0b100

JS_FILETYP_FILE

mixed $JS_FILETYP_FILE = 0b10

JS_FILETYP_FILE_EXT

mixed $JS_FILETYP_FILE_EXT = 0b1

JS_FILES_CACHE

mixed $JS_FILES_CACHE = 'themejsfiles/'

Properties

$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 = []

$defaultViewVars

Default vars object

protected viewVars $defaultViewVars

$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( [ $viewName : string = '' ] [, $module : string = false ] ) : mixed
Parameters
$viewName : string = ''

Viewname ohne Endung .php

$module : string = false

Module-Key

Return values
mixed

initFileLib()

Inits file library

protected initFileLib( ) : bool
Return values
bool

addRootPath()

Checks item if included system paths

private addRootPath( $item : string ) : mixed
Parameters
$item : string
Tags
since
Return values
mixed

getJsFileType()

Checks path type of given JS file

private getJsFileType( $item : string , &$jsCorePath : string ) : int
Parameters
$item : string
$jsCorePath : string
Tags
since
Return values
int

prepareNotifications()

Initializes notifications

protected prepareNotifications( ) : bool
Return values
bool

addJsFiles()

Add JavScript files to view

public addJsFiles( $jsFiles : array ) : mixed
Parameters
$jsFiles : array
Return values
mixed

addJsFilesLate()

Add JavScript files to view

public addJsFilesLate( $jsFilesLate : array ) : mixed
Parameters
$jsFilesLate : array
Return values
mixed

addCssFiles()

Add CSS files variable to view

public addCssFiles( $cssFiles : array ) : mixed
Parameters
$cssFiles : array
Return values
mixed

addJsVars()

Add new JS vars

public addJsVars( $jsVars : mixed ) : mixed
Parameters
$jsVars : mixed
Return values
mixed

mergeJsVars()

Merge new JS vars

protected mergeJsVars( $jsVar : string , $jsVars : array ) : mixed
Parameters
$jsVar : string
$jsVars : array
Return values
mixed

overrideCssFiles()

Overrides CSS files variable to view

public overrideCssFiles( $cssFiles : array ) : mixed
Parameters
$cssFiles : array
Return values
mixed

overrideJsFiles()

Overrides new JS vars

public overrideJsFiles( $jsFiles : mixed ) : mixed
Parameters
$jsFiles : mixed
Return values
mixed

overrideJsLangVars()

Overrides new JS language vars

public overrideJsLangVars( $jsVars : array ) : mixed
Parameters
$jsVars : array
Return values
mixed

addJsLangVars()

Add new JS language vars

public addJsLangVars( $jsVars : mixed ) : mixed
Parameters
$jsVars : mixed
Return values
mixed

addFromLibrary()

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
since
Return values
bool

addButtons()

Add array of buttons to toolbar

public addButtons( $buttons : array ) : mixed
Parameters
$buttons : array

Array of fpcm/view/helper/helper items

Return values
mixed

addButton()

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
since
Return values
mixed

assign()

Assign new variable to view

public assign( $varName : string , $varValue : mixes ) : mixed
Parameters
$varName : string
$varValue : mixes
Return values
mixed

addTopDescription()

Adds top description

public addTopDescription( $descr : string [, $params : array = [] ] ) : mixed
Parameters
$descr : string
$params : array = []
Tags
since
Return values
mixed

addErrorMessage()

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
bool

showHeaderFooter()

Include header and footer into view,

public showHeaderFooter( $showHeader : int ) : mixed
Parameters
$showHeader : int
Tags
see
see
see
Return values
mixed

render()

Renders a set up view

public render( ) : bool
Return values
bool

initAssigns()

Initializes basic view vars

protected initAssigns( ) : bool
Return values
bool

getViewPath()

Returns view path

public getViewPath( ) : string
Return values
string

setViewPath()

Sets view path

public setViewPath( $viewName : string [, $module : string = false ] ) : mixed
Parameters
$viewName : string
$module : string = false
Return values
mixed

getViewVars()

Return assigned view vars

public getViewVars( [ $var : string = false ] ) : mixed
Parameters
$var : string = false
Return values
mixed

setViewVars()

Overrides assigned view vars

public setViewVars( $viewVars : array ) : mixed
Parameters
$viewVars : array
Return values
mixed

setFieldAutofocus()

Auto focus element

public setFieldAutofocus( $elementId : string ) : mixed
Parameters
$elementId : string
Return values
mixed

setActiveNavigationElement()

Set active navigation item

public setActiveNavigationElement( $elementId : string ) : bool
Parameters
$elementId : string
Return values
bool

wasRendered()

Check if view was already rendered

public wasRendered( ) : bool
Return values
bool

getViewHash()

Returns Sha256-hash on view path

public getViewHash( ) : string
Tags
since
Return values
string

setViewHashDefault()

Returns Sha256-hash on view path

public setViewHashDefault( $viewHash : string ) : bool
Parameters
$viewHash : string
Tags
since
Return values
bool

setFormAction()

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
since

setBodyClass()

Set <body>-tag CSS class

public setBodyClass( $bodyClass : int ) : void
Parameters
$bodyClass : int
Tags
since

showPageToken()

Enables output of page token field

public showPageToken( $showPageToken : bool ) : $this
Parameters
$showPageToken : bool
Return values
$this

addDataView()

Adds dataview object to view variables

public addDataView( $dataView : dataView ) : mixed
Parameters
$dataView : dataView
Return values
mixed

addTabs()

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
since
Return values
mixed

addPager()

Add pager to view

public addPager( $pager : pager ) : mixed
Parameters
$pager : pager
Return values
mixed

addToolbarRight()

Add HTML items into toolbar right hand to pager

public addToolbarRight( $data : string ) : mixed
Parameters
$data : string
Tags
since
Return values
mixed

triggerFilesEvents()

Triggers events addJsFiles/addCssFiles for given type

public triggerFilesEvents( [ $type : string = 'theme' ] ) : mixed
Parameters
$type : string = 'theme'
Return values
mixed

addAjaxPageToken()

Add AJAX page token to view

public addAjaxPageToken( $name : string ) : bool
Parameters
$name : string
Tags
since
Return values
bool

initCssFiles()

Initialize default CSS files

private initCssFiles( ) : array
Return values
array

initJsFiles()

Initialize default JavaScript files

private initJsFiles( ) : array
Return values
array

isBrowser()

Checks User Agent for a certain browser

public static isBrowser( $key : string ) : bool
Parameters
$key : string
Tags
static
Return values
bool

getJsExt()

Return JS file extension

public final static getJsExt( ) : string
Tags
since
Return values
string

Search results