\Orpheus\RenderingRendering

The rendering class

This class is the core for custom rendering use.

Summary

Methods

Properties

Constants

render()
display()
getMenuItems()
showMenu()
doShow()
doRender()
doDisplay()
getDefaultRendering()
useLayout()
endCurrentLayout()

No public properties found

No constants found

pushToStack()
getCurrentRendering()
pullFromStack()

$SHOWMODEL
$rendering
$menusConf
$renderingStack
$current
$layoutStack

N/A

show()
checkRendering()

No private properties found

N/A

abstract

File: orpheus-rendering\src\Rendering\Rendering.php
Package: Default
Class hierarchy: \Orpheus\Rendering\Rendering

Properties

$SHOWMODEL

$SHOWMODEL : string

The default model to show

Type

string

$rendering

$rendering : \Orpheus\Rendering\Rendering

The current Rendering

Type

\Orpheus\Rendering\Rendering

$menusConf

$menusConf : array

The configuration of the menu

Type

array

$renderingStack

$renderingStack : array

The current rendering stack

Type

array

$current

$current : \Orpheus\Rendering\Rendering

The current global rendering

Type

\Orpheus\Rendering\Rendering

$layoutStack

$layoutStack : array

The rendering layout stack

Type

array

Methods

render()

render(string  $layout = null, array  $env = array()) : string

Render the model

Parameters

string	$layout	The layout to use, default use is defined by child
array	$env	An environment variable, commonly an array but depends on the rendering class used

Returns

string —

The generated rendering.

Render the model using $env. This function does not display the result, see display().

display()

display(string  $layout = null, array  $env = array())

Display rendering

Parameters

string

$layout

The layout to use

array

$env

An environment variable

Display the model rendering using $env.

getMenuItems()

getMenuItems(string  $menu) : array<mixed,string>

Get menu items

Parameters

string

$menu

The menu to get items

Returns

array<mixed,string> —

The menu items

showMenu()

showMenu(string  $menu, string  $layout = null, string  $active = null)

Show the $menu

Parameters

string	$menu	The menu name
string	$layout	the layout to use
string	$active	Active item

doShow()

doShow()

Call the show function

doRender()

doRender(string  $layout = null, array  $env = array()) : string

Call the render function

Parameters

string	$layout	The model to use
array	$env	An environment variable

Returns

string —

The generated rendering

doDisplay()

doDisplay(string  $layout = null, array  $env = null) : boolean

Call the display function

Parameters

string	$layout	The model to use. Default value is null (behavior depending on renderer)
array	$env	An array containing environment variables. Default value is null ($GLOBALS)

Returns

boolean

getDefaultRendering()

getDefaultRendering()

useLayout()

useLayout(string  $layout)

Use layout until the next endCurrentLayout()

Parameters

string

$layout

The layout to use.

endCurrentLayout()

endCurrentLayout(array  $env = array()) : boolean

End the current layout

Parameters

array

$env

The environement to render the layout

Returns

boolean —

False if there is no current layout

pushToStack()

pushToStack(string  $layout, array  $env)

Push rendering to stack

Parameters

string	$layout
array	$env

getCurrentRendering()

getCurrentRendering() : array

Get current rendering

Returns

array —

array($layout, $env);

pullFromStack()

pullFromStack()

Remove current rendering and get to previous one

show()

show(array  $env = null)

Show the rendering using a child rendering class

Parameters

array

$env

An environment variable

static