class View extends AbstractView (View source)

Properties

static protected $requestInstance from AbstractView
static protected $requestInstances from AbstractView
protected $scopeItems from AbstractView
$controller from AbstractView
protected $template from AbstractView
protected $outputAssets from AbstractView
protected $viewPath
protected $innerContentFile
protected $themeHandle
protected $themeObject
protected $themeRelativePath
protected $themeAbsolutePath
protected $viewPkgHandle
protected $themePkgHandle
protected $viewRootDirectoryName

Methods

getViewTemplate()

No description

addScopeItems($items)

No description

static 
getRequestInstance()

No description

__construct(mixed $mixed = false)

No description

static 
setRequestInstance(View $v)

No description

static 
revertRequestInstance()

No description

start($state)

Begin the render.

startRender()

No description

constructView($path = false)

No description

setupRender()

No description

finishRender($contents)

No description

action($action)

A shortcut to posting back to the current page with a task and optional parameters. Only works in the context of.

addHeaderAsset($asset)

No description

addFooterAsset($asset)

No description

addOutputAsset($asset)

No description

requireAsset($assetType, $assetHandle = false)

No description

setController($controller)

No description

setViewTemplate($template)

No description

post($key, $defaultValue = null)

Returns the value of the item in the POST array.

onBeforeGetContents()

No description

postProcessViewContents($contents)

No description

onAfterGetContents()

No description

getScopeItems()

No description

render($state = false)

No description

renderViewContents($scopeItems)

No description

static string
url(string $action, string $task = null) deprecated

url is a utility function that is used inside a view to setup urls w/tasks and parameters.

setThemeByPath($path, $theme = null, $wrapper = FILENAME_THEMES_VIEW)

No description

renderError($title, $error, $errorObj = null)

No description

addHeaderItem($item)

No description

addFooterItem($item)

No description

static View
getInstance()

Get an instance of the View.

setPackageHandle($pkgHandle)

No description

getThemeDirectory()

No description

getViewPath()

No description

string
getThemePath()

gets the relative theme path for use in templates.

getThemeHandle()

No description

setInnerContentFile($innerContentFile)

No description

mixed
getInnerContentFile()

No description

setViewRootDirectoryName($directory)

No description

inc($file, $args = [])

No description

setViewTheme($theme)

No description

getViewTemplateFile()

No description

loadViewThemeObject()

Load all the theme-related variables for which theme to use for this request. May update the themeHandle property on the view based on themeByRoute settings.

string
renderInnerContents($scopeItems)

Render the file set to $this->innerContentFile

string
renderTemplate($scopeItems, $innerContent)

Render the file set to $this->template

markHeaderAssetPosition()

Function responsible for outputting header items.

markFooterAssetPosition()

Function responsible for outputting footer items.

getAssetsToOutput()

No description

postProcessAssets($assets)

No description

replaceEmptyAssetPlaceholders($pageContent)

No description

replaceAssetPlaceholders($outputAssets, $pageContent)

No description

outputAssetIntoView($item)

No description

static 
element($_file, $args = null, $_pkgHandle = null)

No description

Details

getViewTemplate()

addScopeItems($items)

Parameters

$items

static getRequestInstance()

__construct(mixed $mixed = false)

Parameters

mixed $mixed object to view

static protected setRequestInstance(View $v)

Parameters

View $v

static protected revertRequestInstance()

start($state)

Begin the render.

Parameters

$state

startRender()

protected constructView($path = false)

Parameters

$path

setupRender()

finishRender($contents)

Parameters

$contents

action($action)

A shortcut to posting back to the current page with a task and optional parameters. Only works in the context of.

Parameters

$action

addHeaderAsset($asset)

Parameters

$asset

addFooterAsset($asset)

Parameters

$asset

addOutputAsset($asset)

Parameters

$asset

requireAsset($assetType, $assetHandle = false)

Parameters

$assetType
$assetHandle

setController($controller)

Parameters

$controller

setViewTemplate($template)

Parameters

$template

post($key, $defaultValue = null)

Returns the value of the item in the POST array.

Parameters

$key
$defaultValue

protected onBeforeGetContents()

postProcessViewContents($contents)

Parameters

$contents

protected onAfterGetContents()

getScopeItems()

render($state = false)

Parameters

$state

renderViewContents($scopeItems)

Parameters

$scopeItems

static string url(string $action, string $task = null) deprecated

deprecated

url is a utility function that is used inside a view to setup urls w/tasks and parameters.

Parameters

string $action
string $task

Return Value

string $url

setThemeByPath($path, $theme = null, $wrapper = FILENAME_THEMES_VIEW)

Parameters

$path
$theme
$wrapper

renderError($title, $error, $errorObj = null)

Parameters

$title
$error
$errorObj

addHeaderItem($item)

Parameters

$item

addFooterItem($item)

Parameters

$item

static View getInstance()

Get an instance of the View.

Note: In versions before 8.5.0a3, this method may return 'false' if it's called after the page is rendered (for example in middleware).

Return Value

View

setPackageHandle($pkgHandle)

Parameters

$pkgHandle

getThemeDirectory()

getViewPath()

string getThemePath()

gets the relative theme path for use in templates.

Return Value

string $themePath

getThemeHandle()

setInnerContentFile($innerContentFile)

Parameters

$innerContentFile

mixed getInnerContentFile()

Return Value

mixed

setViewRootDirectoryName($directory)

Parameters

$directory

inc($file, $args = [])

Parameters

$file
$args

setViewTheme($theme)

Parameters

$theme

getViewTemplateFile()

protected loadViewThemeObject()

Load all the theme-related variables for which theme to use for this request. May update the themeHandle property on the view based on themeByRoute settings.

protected string renderInnerContents($scopeItems)

Render the file set to $this->innerContentFile

Parameters

$scopeItems

Return Value

string

protected string renderTemplate($scopeItems, $innerContent)

Render the file set to $this->template

Parameters

$scopeItems
$innerContent

Return Value

string

markHeaderAssetPosition()

Function responsible for outputting header items.

markFooterAssetPosition()

Function responsible for outputting footer items.

protected getAssetsToOutput()

protected postProcessAssets($assets)

Parameters

$assets

protected replaceEmptyAssetPlaceholders($pageContent)

Parameters

$pageContent

protected replaceAssetPlaceholders($outputAssets, $pageContent)

Parameters

$outputAssets
$pageContent

protected outputAssetIntoView($item)

Parameters

$item

static element($_file, $args = null, $_pkgHandle = null)

Parameters

$_file
$args
$_pkgHandle