HtmlView
Extends AbstractViewJoomla Framework HTML View Class
| since |
2.0.0 |
|---|---|
| package |
Joomla Framework |
Methods
__construct
Method to instantiate the view.
__construct(\Joomla\Renderer\RendererInterface renderer) : mixed
| since |
2.0.0 |
|---|
Arguments
- renderer
\Joomla\Renderer\RendererInterfaceThe renderer object.
Response
mixed
__toString
Magic toString method that is a proxy for the render method.
__toString() : string
| since |
2.0.0 |
|---|
Response
string
addData
Adds an object to the data array
addData(string key, mixed value) : $this
| since |
2.0.0 |
|---|
Arguments
- key
stringThe array key- value
mixedThe data value to add
Response
$this
clearData
Resets the internal data array
clearData() : $this
| since |
2.0.0 |
|---|
Response
$this
getData
Retrieves the data array
getData() : array
| since |
2.0.0 |
|---|
Response
array
getLayout
Method to get the view layout.
getLayout() : string
| since |
2.0.0 |
|---|
Response
stringThe layout name.
getRenderer
Retrieves the renderer object
getRenderer() : \Joomla\Renderer\RendererInterface
| since |
2.0.0 |
|---|
Response
\Joomla\Renderer\RendererInterface
removeData
Removes an object to the data array
removeData(string key) : $this
| since |
2.0.0 |
|---|
Arguments
- key
stringThe array key to remove
Response
$this
render
Method to render the view.
render() : string
| since |
2.0.0 |
|---|
Response
stringThe rendered view.
setData
Sets additional data to the data array
setData(array data) : $this
| since |
2.0.0 |
|---|
Arguments
- data
arrayData to merge into the existing data array
Response
$this
setLayout
Method to set the view layout.
setLayout(string layout) : $this
| since |
2.0.0 |
|---|
Arguments
- layout
stringThe layout name.
Response
$this
setRenderer
Sets the renderer object
setRenderer(\Joomla\Renderer\RendererInterface renderer) : $this
| since |
2.0.0 |
|---|
Arguments
- renderer
\Joomla\Renderer\RendererInterfaceThe renderer object.
Response
$this
Properties
layout
The view layout.
| since |
2.0.0 |
|---|
Type(s)
string
renderer
The renderer object
| since |
2.0.0 |
|---|
Type(s)
\Joomla\Renderer\RendererInterface
data
The data array to pass to the renderer
| since |
2.0.0 |
|---|
Type(s)
array