class RequestHtmlView extends AbstractDebuggerHtmlView (View source)

The SystemHtmlView class.

Traits

LayoutRenderableTrait
The BootableTrait class.

Constants

DEFAULT_MODEL

Methods

__construct(array $data = null, array $config = null, string|AbstractRenderer $renderer = null)

Method to instantiate the view.

from HtmlView
void
boot()

boot

from HtmlView
handleData()

handleData

mixed
getHandledData()

processData

Data
getData()

getData

setData(array $data)

setData

null
get(string $key, mixed $default = null)

get

$this
set(string $key, mixed $value)

set

string
render()

render

from HtmlView
string
__toString()

__toString

boolean
offsetExists(mixed $offset)

Is a property exists or not.

mixed
offsetGet(mixed $offset)

Get a property.

void
offsetSet(mixed $offset, mixed $value)

Set a value to property.

void
offsetUnset(mixed $offset)

Unset a property.

string
getName(int $backwards = 2)

getName

setName(string $name)

Method to set property name

getPackage(int $backwards = 4)

Method to get property Package

setPackage(AbstractPackage $package)

Method to set property package

Structure
getConfig()

Method to get property Config

setConfig(Structure $config)

Method to set property config

Structure
__get(string $name)

__get

getModel(string $name = null)

Method to get property Model

setModel(ModelRepository $model, bool $default = null, string $customName = null)

Method to set property model

addModel(string $name, ModelRepository $model, string $default = null)

Method to add model with name.

removeModel(string $name)

removeModel

string
getLayout()

Method to get property Layout

setLayout(string $layout)

Method to set property layout

AbstractRenderer
getRenderer()

Method to get property Renderer

setRenderer(AbstractRenderer|string $renderer)

Method to set property renderer

registerPaths(bool $refresh = false)

registerPaths

registerMultilingualPaths(bool $refresh = false)

registerMultilingualPaths

array
dumpPaths(bool $multilingual = false)

dumpPaths

addPath(string $path, int $priority = 100)

addPath

addPaths(array $paths, int $priority = PriorityQueue::ABOVE_NORMAL)

addPaths

getRendererManager()

Method to get property RendererManager

setRendererManager(RendererManager $rendererManager)

Method to set property rendererManager

string
escape(string $output)

Method to escape output.

from HtmlView
addHelper(string $name, object|AbstractHelper $helper)

addHelper

from HtmlView
getHelperSet()

Method to get property HelperSet

from HtmlView
setHelperSet(HelperSet $helperSet)

Method to set property helperSet

from HtmlView

Details

in HtmlView at line line 43
__construct(array $data = null, array $config = null, string|AbstractRenderer $renderer = null)

Method to instantiate the view.

Parameters

array $data The data array.
array $config The view config.
string|AbstractRenderer $renderer The renderer engine.

in HtmlView at line line 58
void boot()

boot

Return Value

void

AbstractView handleData()

handleData

Return Value

AbstractView

mixed getHandledData()

processData

Return Value

mixed

Data getData()

getData

Return Value

Data

AbstractView setData(array $data)

setData

Parameters

array $data

Return Value

AbstractView Return self to support chaining.

null get(string $key, mixed $default = null)

get

Parameters

string $key
mixed $default

Return Value

null

$this set(string $key, mixed $value)

set

Parameters

string $key
mixed $value

Return Value

$this

in HtmlView at line line 92
string render()

render

Return Value

string

Exceptions

RuntimeException

string __toString()

__toString

Return Value

string

boolean offsetExists(mixed $offset)

Is a property exists or not.

Parameters

mixed $offset Offset key.

Return Value

boolean

mixed offsetGet(mixed $offset)

Get a property.

Parameters

mixed $offset Offset key.

Return Value

mixed The value to return.

Exceptions

InvalidArgumentException

void offsetSet(mixed $offset, mixed $value)

Set a value to property.

Parameters

mixed $offset Offset key.
mixed $value The value to set.

Return Value

void

Exceptions

InvalidArgumentException

void offsetUnset(mixed $offset)

Unset a property.

Parameters

mixed $offset Offset key to unset.

Return Value

void

Exceptions

InvalidArgumentException

string getName(int $backwards = 2)

getName

Parameters

int $backwards

Return Value

string

AbstractView setName(string $name)

Method to set property name

Parameters

string $name

Return Value

AbstractView Return self to support chaining.

AbstractPackage getPackage(int $backwards = 4)

Method to get property Package

Parameters

int $backwards

Return Value

AbstractPackage

AbstractView setPackage(AbstractPackage $package)

Method to set property package

Parameters

AbstractPackage $package

Return Value

AbstractView Return self to support chaining.

Structure getConfig()

Method to get property Config

Return Value

Structure

AbstractView setConfig(Structure $config)

Method to set property config

Parameters

Structure $config

Return Value

AbstractView Return self to support chaining.

Structure __get(string $name)

__get

Parameters

string $name

Return Value

Structure

ModelRepository getModel(string $name = null)

Method to get property Model

Parameters

string $name

Return Value

ModelRepository

AbstractView setModel(ModelRepository $model, bool $default = null, string $customName = null)

Method to set property model

Parameters

ModelRepository $model
bool $default
string $customName

Return Value

AbstractView Return self to support chaining.

AbstractView addModel(string $name, ModelRepository $model, string $default = null)

Method to add model with name.

Parameters

string $name
ModelRepository $model
string $default

Return Value

AbstractView Return self to support chaining.

AbstractView removeModel(string $name)

removeModel

Parameters

string $name

Return Value

AbstractView

PackageRouter getRouter()

getRouter

Return Value

PackageRouter

string getLayout()

Method to get property Layout

Return Value

string

LayoutRenderableTrait setLayout(string $layout)

Method to set property layout

Parameters

string $layout

Return Value

LayoutRenderableTrait Return self to support chaining.

AbstractRenderer getRenderer()

Method to get property Renderer

Return Value

AbstractRenderer

LayoutRenderableTrait setRenderer(AbstractRenderer|string $renderer)

Method to set property renderer

Parameters

AbstractRenderer|string $renderer

Return Value

LayoutRenderableTrait Return self to support chaining.

LayoutRenderableTrait registerPaths(bool $refresh = false)

registerPaths

Parameters

bool $refresh

Return Value

LayoutRenderableTrait

LayoutRenderableTrait registerMultilingualPaths(bool $refresh = false)

registerMultilingualPaths

Parameters

bool $refresh

Return Value

LayoutRenderableTrait

array dumpPaths(bool $multilingual = false)

dumpPaths

Parameters

bool $multilingual

Return Value

array

LayoutRenderableTrait addPath(string $path, int $priority = 100)

addPath

Parameters

string $path
int $priority

Return Value

LayoutRenderableTrait

LayoutRenderableTrait addPaths(array $paths, int $priority = PriorityQueue::ABOVE_NORMAL)

addPaths

Parameters

array $paths
int $priority

Return Value

LayoutRenderableTrait

RendererManager getRendererManager()

Method to get property RendererManager

Return Value

RendererManager

LayoutRenderableTrait setRendererManager(RendererManager $rendererManager)

Method to set property rendererManager

Parameters

RendererManager $rendererManager

Return Value

LayoutRenderableTrait Return self to support chaining.

in HtmlView at line line 79
string escape(string $output)

Method to escape output.

Parameters

string $output The output to escape.

Return Value

string The escaped output.

in HtmlView at line line 109
HtmlView addHelper(string $name, object|AbstractHelper $helper)

addHelper

Parameters

string $name
object|AbstractHelper $helper

Return Value

HtmlView

in HtmlView at line line 121
HelperSet getHelperSet()

Method to get property HelperSet

Return Value

HelperSet

in HtmlView at line line 138
HtmlView setHelperSet(HelperSet $helperSet)

Method to set property helperSet

Parameters

HelperSet $helperSet

Return Value

HtmlView Return self to support chaining.