Documentation

view
in package

Default view object

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2020, Stefan Seehafer

license

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

Table of Contents

INCLUDE_HEADER_FULL  = 0b1
INCLUDE_HEADER_NONE  = 0b100
INCLUDE_HEADER_SIMPLE  = 0b10
JS_FILES_CACHE  = 'themejsfiles/'
JS_FILETYP_FILE  = 0b10
JS_FILETYP_FILE_EXT  = 0b1
JS_FILETYP_URL  = 0b100
PATH_COMPONENTS  = '{$components}'
PATH_MODULE  = '{$module}'
ROOTURL_CORE_JS  = '{$coreJs}'
ROOTURL_CORE_THEME  = '{$coreTheme}'
ROOTURL_LIB  = '{$lib}'
ROOTURL_UNIQUE  = '{$unique}'
$bodyClass  : string
<body> CSS class
$buttons  : array<string|int, mixed>
Toolbar buttons
$cache  : cache
Cache object
$config  : config
Config
$cssFiles  : array<string|int, mixed>
View CSS files
$defaultViewVars  : viewVars
Default vars object
$events  : events
Events
$formAction  : string
Form action path
$fullJsVarsNoheader  : bool
Include full js vars if no header included
$jsFiles  : array<string|int, mixed>
View JS files
$jsFilesLate  : array<string|int, mixed>
View JS files
$jsFilesLocal  : array<string|int, mixed>
Local view files in core/js
$jsLangVars  : array<string|int, mixed>
View JS language vars
$jsVars  : array<string|int, mixed>
View JS vars
$language  : language
Config
$messages  : array<string|int, mixed>
View messages
$module  : string
Root urls for replacements
$navigationActiveModule  : string
Active nagivation item
$notifications  : notifications
Notifications
$rendered  : bool
View was already rendered
$rootUrls  : array<string|int, mixed>
Root urls for replacements
$session  : session
Session object
$showHeader  : int
Include header and footer in view::render
$showPageToken  : bool
View was already rendered
$viewHash  : string
View file path hash
$viewName  : string
View file name
$viewPath  : string
Complete view path
$viewVars  : array<string|int, mixed>
View vars
__construct()  : mixed
Konstruktor
addAjaxPageToken()  : bool
Add AJAX page token to view
addButton()  : void
Add button to toolbar
addButtons()  : mixed
Add array of buttons to toolbar
addCssFiles()  : mixed
Add CSS files variable to view
addDataView()  : mixed
Adds dataview object to view variables
addErrorMessage()  : void
Add red error message
addFromLibrary()  : bool
Add js and css files from 3rd party library
addFromModule()  : bool
Add js and css files from modules
addJsFiles()  : mixed
Add JavScript files to view
addJsFilesLate()  : mixed
Add JavScript files to view
addJsLangVars()  : mixed
Add new JS language vars
addJsVars()  : mixed
Add new JS vars
addMessage()  : void
Add yellow message
addNoticeMessage()  : void
Add blue notification message
addOffCanvas()  : mixed
Add off canvas widget to view
addPager()  : mixed
Add pager to view
addTabs()  : mixed
Sets view to standard tab view, do not use if you want to include tabs in another view!!!
addToolbarRight()  : mixed
Add HTML items into toolbar right hand to pager
addTopDescription()  : mixed
Adds top description
assign()  : mixed
Assign new variable to view
getJsExt()  : string
Return JS file extension
getViewHash()  : string
Returns Sha256-hash on view path
getViewPath()  : string
Returns view path
getViewVars()  : mixed
Return assigned view vars
includeForms()  : mixed
Add path for default forms.php view file
includeFullJsVarsNoheader()  : mixed
Include full js var set if no header is included
isBrowser()  : bool
Checks User Agent for a certain browser
overrideCssFiles()  : mixed
Overrides CSS files variable to view
overrideJsFiles()  : mixed
Overrides new JS vars
overrideJsLangVars()  : mixed
Overrides new JS language vars
prependjQuery()  : mixed
Force to load jQuery in Pub-Controllers before other JS-Files if not already done
render()  : void
Renders view
setActiveNavigationElement()  : bool
Set active navigation item
setActiveTab()  : void
Set Active tab
setBodyClass()  : void
Set <body>-tag CSS class
setFieldAutofocus()  : mixed
Auto focus element
setFormAction()  : void
Set form action path
setHelpLink()  : bool
Set help link data
setViewHashDefault()  : bool
Returns Sha256-hash on view path
setViewPath()  : mixed
Sets view path
setViewVars()  : mixed
Overrides assigned view vars
showHeaderFooter()  : mixed
Include header and footer into view,
showPageToken()  : $this
Enables output of page token field
triggerFilesEvents()  : mixed
Triggers events addJsFiles/addCssFiles for given type
wasRendered()  : bool
Check if view was already rendered
initAssigns()  : bool
Initializes basic view vars
initFileLib()  : bool
Inits file library
mergeJsVars()  : mixed
Merge new JS vars
prepareNotifications()  : bool
Initializes notifications
addRootPath()  : mixed
Checks item if included system paths
getJsFileType()  : int
Checks path type of given JS file
initCssFiles()  : array<string|int, mixed>
Initialize default CSS files
initJsFiles()  : array<string|int, mixed>
Initialize default JavaScript files

Constants

INCLUDE_HEADER_FULL

public mixed INCLUDE_HEADER_FULL = 0b1

INCLUDE_HEADER_NONE

public mixed INCLUDE_HEADER_NONE = 0b100

INCLUDE_HEADER_SIMPLE

public mixed INCLUDE_HEADER_SIMPLE = 0b10

JS_FILES_CACHE

public mixed JS_FILES_CACHE = 'themejsfiles/'

JS_FILETYP_FILE

public mixed JS_FILETYP_FILE = 0b10

JS_FILETYP_FILE_EXT

public mixed JS_FILETYP_FILE_EXT = 0b1

JS_FILETYP_URL

public mixed JS_FILETYP_URL = 0b100

PATH_COMPONENTS

public mixed PATH_COMPONENTS = '{$components}'

PATH_MODULE

public mixed PATH_MODULE = '{$module}'

ROOTURL_CORE_JS

public mixed ROOTURL_CORE_JS = '{$coreJs}'

ROOTURL_CORE_THEME

public mixed ROOTURL_CORE_THEME = '{$coreTheme}'

ROOTURL_LIB

public mixed ROOTURL_LIB = '{$lib}'

ROOTURL_UNIQUE

public mixed ROOTURL_UNIQUE = '{$unique}'

Properties

$bodyClass

<body> CSS class

protected string $bodyClass = ''
Tags
since
4.2

$buttons

Toolbar buttons

protected array<string|int, mixed> $buttons = []

$cssFiles

View CSS files

protected array<string|int, mixed> $cssFiles = []

$defaultViewVars

Default vars object

protected viewVars $defaultViewVars

$formAction

Form action path

protected string $formAction = ''

$fullJsVarsNoheader

Include full js vars if no header included

protected bool $fullJsVarsNoheader = false
Tags
since
5.0.0-b3

$jsFiles

View JS files

protected array<string|int, mixed> $jsFiles = []

$jsFilesLate

View JS files

protected array<string|int, mixed> $jsFilesLate = []
Tags
since
4.5

$jsFilesLocal

Local view files in core/js

protected array<string|int, mixed> $jsFilesLocal = []
Tags
since
4.1

$jsLangVars

View JS language vars

protected array<string|int, mixed> $jsLangVars = []

$jsVars

View JS vars

protected array<string|int, mixed> $jsVars = []

$messages

View messages

protected array<string|int, mixed> $messages = []

$module

Root urls for replacements

protected string $module = null
Tags
since
4.5-b7

$navigationActiveModule

Active nagivation item

protected string $navigationActiveModule = ''
Tags
since
5.0.0-a4

$rendered

View was already rendered

protected bool $rendered = false

$rootUrls

Root urls for replacements

protected array<string|int, mixed> $rootUrls = []
Tags
since
4.1

$showHeader

Include header and footer in view::render

protected int $showHeader

$showPageToken

View was already rendered

protected bool $showPageToken = true

$viewHash

View file path hash

protected string $viewHash = ''

$viewName

View file name

protected string $viewName = ''

$viewPath

Complete view path

protected string $viewPath = ''

$viewVars

View vars

protected array<string|int, mixed> $viewVars = []

Methods

__construct()

Konstruktor

public __construct([string $viewName = '' ][, string $module = null ]) : mixed
Parameters
$viewName : string = ''

Viewname ohne Endung .php

$module : string = null

Module-Key

Return values
mixed

addAjaxPageToken()

Add AJAX page token to view

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

addButton()

Add button to toolbar

public addButton(button $button[, type $pos = false ]) : void
Parameters
$button : button
$pos : type = false
Return values
void

addButtons()

Add array of buttons to toolbar

public addButtons(array<string|int, mixed> $buttons) : mixed
Parameters
$buttons : array<string|int, mixed>

Array of fpcm/view/helper/helper items

Return values
mixed

addCssFiles()

Add CSS files variable to view

public addCssFiles(array<string|int, mixed> $cssFiles) : mixed
Parameters
$cssFiles : array<string|int, mixed>
Return values
mixed

addDataView()

Adds dataview object to view variables

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

addErrorMessage()

Add red error message

public addErrorMessage(string $messageText[, string $params = [] ]) : void
Parameters
$messageText : string
$params : string = []
Return values
void

addFromLibrary()

Add js and css files from 3rd party library

public final addFromLibrary(string $lib[, array<string|int, mixed> $jsFiles = [] ][, array<string|int, mixed> $cssFiles = [] ]) : bool
Parameters
$lib : string
$jsFiles : array<string|int, mixed> = []
$cssFiles : array<string|int, mixed> = []
Tags
since
4.5
Return values
bool

addFromModule()

Add js and css files from modules

public final addFromModule([array<string|int, mixed> $jsFiles = [] ][, array<string|int, mixed> $cssFiles = [] ][, null|string $moduleKey = null ]) : bool
Parameters
$jsFiles : array<string|int, mixed> = []
$cssFiles : array<string|int, mixed> = []
$moduleKey : null|string = null
Tags
since
4.5-b7
Return values
bool

addJsFiles()

Add JavScript files to view

public addJsFiles(array<string|int, mixed> $jsFiles) : mixed
Parameters
$jsFiles : array<string|int, mixed>
Return values
mixed

addJsFilesLate()

Add JavScript files to view

public addJsFilesLate(array<string|int, mixed> $jsFilesLate) : mixed
Parameters
$jsFilesLate : array<string|int, mixed>
Return values
mixed

addJsLangVars()

Add new JS language vars

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

addJsVars()

Add new JS vars

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

addMessage()

Add yellow message

public addMessage(string $messageText[, string $params = [] ]) : void
Parameters
$messageText : string
$params : string = []
Return values
void

addNoticeMessage()

Add blue notification message

public addNoticeMessage(string $messageText[, string $params = [] ]) : void
Parameters
$messageText : string
$params : string = []
Return values
void

addOffCanvas()

Add off canvas widget to view

public addOffCanvas(string $headline, array<string|int, mixed> $filePath) : mixed
Parameters
$headline : string
$filePath : array<string|int, mixed>
Tags
since
5.0.0-b6
Return values
mixed

addPager()

Add pager to view

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

addTabs()

Sets view to standard tab view, do not use if you want to include tabs in another view!!!

public addTabs(string $tabsId, array<string|int, mixed> $tabs[, string $tabsClass = '' ][, int $active = -1 ]) : mixed
Parameters
$tabsId : string
$tabs : array<string|int, mixed>
$tabsClass : string = ''
$active : int = -1
Tags
since
4.3
Return values
mixed

addToolbarRight()

Add HTML items into toolbar right hand to pager

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

addTopDescription()

Adds top description

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

assign()

Assign new variable to view

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

getJsExt()

Return JS file extension

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

getViewHash()

Returns Sha256-hash on view path

public getViewHash() : string
Tags
since
4.1
Return values
string

getViewPath()

Returns view path

public getViewPath() : string
Return values
string

getViewVars()

Return assigned view vars

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

includeForms()

Add path for default forms.php view file

public includeForms(string $str) : mixed
Parameters
$str : string
Tags
since
5.0-dev
Return values
mixed

includeFullJsVarsNoheader()

Include full js var set if no header is included

public includeFullJsVarsNoheader(bool $fullJsVarsNoheader) : mixed
Parameters
$fullJsVarsNoheader : bool
Return values
mixed

isBrowser()

Checks User Agent for a certain browser

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

overrideCssFiles()

Overrides CSS files variable to view

public overrideCssFiles(array<string|int, mixed> $cssFiles) : mixed
Parameters
$cssFiles : array<string|int, mixed>
Return values
mixed

overrideJsFiles()

Overrides new JS vars

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

overrideJsLangVars()

Overrides new JS language vars

public overrideJsLangVars(array<string|int, mixed> $jsVars) : mixed
Parameters
$jsVars : array<string|int, mixed>
Return values
mixed

prependjQuery()

Force to load jQuery in Pub-Controllers before other JS-Files if not already done

public prependjQuery() : mixed
Tags
since
3.2.0
Return values
mixed

render()

Renders view

public render([bool $return = false ]) : void
Parameters
$return : bool = false
Return values
void

setActiveNavigationElement()

Set active navigation item

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

setActiveTab()

Set Active tab

public setActiveTab(int $tab) : void
Parameters
$tab : int
Tags
since
4.1
Return values
void

setBodyClass()

Set <body>-tag CSS class

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

setFieldAutofocus()

Auto focus element

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

setFormAction()

Set form action path

public setFormAction(string $controller[, array<string|int, mixed> $params = [] ][, bool $isLink = false ]) : void
Parameters
$controller : string
$params : array<string|int, mixed> = []
$isLink : bool = false
Return values
void

Set help link data

public setHelpLink(string $entry, int $chapter) : bool
Parameters
$entry : string
$chapter : int
Return values
bool

setViewHashDefault()

Returns Sha256-hash on view path

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

setViewPath()

Sets view path

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

setViewVars()

Overrides assigned view vars

public setViewVars(array<string|int, mixed> $viewVars) : mixed
Parameters
$viewVars : array<string|int, mixed>
Return values
mixed

showPageToken()

Enables output of page token field

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

triggerFilesEvents()

Triggers events addJsFiles/addCssFiles for given type

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

wasRendered()

Check if view was already rendered

public wasRendered() : bool
Return values
bool

initAssigns()

Initializes basic view vars

protected initAssigns() : bool
Return values
bool

initFileLib()

Inits file library

protected initFileLib() : bool
Return values
bool

mergeJsVars()

Merge new JS vars

protected mergeJsVars(string $jsVar, array<string|int, mixed> $jsVars) : mixed
Parameters
$jsVar : string
$jsVars : array<string|int, mixed>
Return values
mixed

prepareNotifications()

Initializes notifications

protected prepareNotifications() : bool
Return values
bool

addRootPath()

Checks item if included system paths

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

getJsFileType()

Checks path type of given JS file

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

initCssFiles()

Initialize default CSS files

private initCssFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>

initJsFiles()

Initialize default JavaScript files

private initJsFiles() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results