AbstractHtmlView

Extends \Joomla\View\AbstractView

Joomla Framework HTML View Class

abstract deprecated
since

1.0

deprecated

2.0 Will become BaseHtmlView in 2.0

Methods

__construct

Method to instantiate the view.

__construct(\Joomla\Model\ModelInterface $model) 
inherited
since

1.0

Arguments

$model

\Joomla\Model\ModelInterfaceThe model object.

__toString

Magic toString method that is a proxy for the render method.

__toString() : string
since

1.0

Response

string

escape

Method to escape output.

escape(string $output) : string
inherited deprecated
see \Joomla\View\ViewInterface::escape()
since

1.0

deprecated

2.0 Interface method is deprecated without replacement.

Arguments

$output

stringThe output to escape.

Response

stringThe escaped output.

getLayout

Method to get the view layout.

getLayout() : string
since

1.0

Response

stringThe layout name.

getPath

Method to get the layout path.

getPath(string $layout, string $ext = 'php') : mixed
deprecated
since

1.0

deprecated

2.0 In 2.0, a RendererInterface object will be required which will manage paths.

Arguments

$layout

stringThe base name of the layout file (excluding extension).

$ext

stringThe extension of the layout file (default: "php").

Response

mixedThe layout file name if found, false otherwise.

getPaths

Method to get the view paths.

getPaths() : \SplPriorityQueue
deprecated
since

1.0

deprecated

2.0 In 2.0, a RendererInterface object will be required which will manage paths.

Response

\SplPriorityQueueThe paths queue.

loadPaths

Method to load the paths queue.

loadPaths() : \SplPriorityQueue
deprecated
since

1.0

deprecated

2.0 In 2.0, a RendererInterface object will be required which will manage paths.

Response

\SplPriorityQueueThe paths queue.

render

Method to render the view.

render() : string
since

1.0

throws

\RuntimeException

Response

stringThe rendered view.

setLayout

Method to set the view layout.

setLayout(string $layout) : \Joomla\View\AbstractHtmlView
since

1.0

Arguments

$layout

stringThe layout name.

Response

\Joomla\View\AbstractHtmlViewMethod supports chaining.

setPaths

Method to set the view paths.

setPaths(\SplPriorityQueue $paths) : \Joomla\View\AbstractHtmlView
deprecated
since

1.0

deprecated

2.0 In 2.0, a RendererInterface object will be required which will manage paths.

Arguments

$paths

\SplPriorityQueueThe paths queue.

Response

\Joomla\View\AbstractHtmlViewMethod supports chaining.

Properties

layout

The view layout.

since

1.0

Type(s)

string

paths

The paths queue.

deprecated
since

1.0

deprecated

2.0 In 2.0, a RendererInterface object will be required which will manage paths.

Type(s)

\SplPriorityQueue

model

The model object.

inherited
since

1.0

Type(s)

\Joomla\Model\ModelInterface