PHP Class Backend\Core\Engine\Base\Widget

Inheritance: extends KernelLoader

Public Properties

Property	Type	Description
$tpl	Backend\Core\Engine\TwigTemplate	A reference to the current template

Property	Type	Description
$header	Backend\Core\Engine\Header	The header object
$rights	array	Required rights needed for this widget.

Method	Description
__construct ( Symfony\Component\HttpKernel\KernelInterface $kernel )	The constructor will set some properties, it populates the parameter array with urldecoded values for ease of use.
getColumn ( ) : string	Get the column
getPosition ( ) : mixed	Get the position
getTemplatePath ( ) : mixed	Get the template path
isAllowed ( ) : boolean	Is this widget allowed for this user?
redirect ( string $url, integer $code = 302 )	Redirect to a given URL

Method	Description
display ( string $template = null )	Display, this wil output the template to the browser If no template is specified we build the path form the current module and action
setColumn ( string $column )	Set column for the widget
setPosition ( integer $position )	Set the position for the widget

The constructor will set some properties, it populates the parameter array with urldecoded values for ease of use.

public __construct ( Symfony\Component\HttpKernel\KernelInterface $kernel )
$kernel	Symfony\Component\HttpKernel\KernelInterface

Display, this wil output the template to the browser If no template is specified we build the path form the current module and action

protected display ( string $template = null )
$template	string	The template to use.

Get the column

public getColumn ( ) : string
return	string

Get the position

public getPosition ( ) : mixed
return	mixed

Get the template path

public getTemplatePath ( ) : mixed
return	mixed

Is this widget allowed for this user?

public isAllowed ( ) : boolean
return	boolean

Redirect to a given URL

public redirect ( string $url, integer $code = 302 )
$url	string	The URL whereto will be redirected.
$code	integer	The redirect code, default is 302 which means this is a temporary redirect.

Set column for the widget

protected setColumn ( string $column )
$column	string	Possible values are: left, middle, right.

Set the position for the widget

protected setPosition ( integer $position )
$position	integer	The position for the widget.

The header object

protected Header,Backend\Core\Engine $header
return	Backend\Core\Engine\Header

Required rights needed for this widget.

protected array $rights
return	array

A reference to the current template

public TwigTemplate,Backend\Core\Engine $tpl
return	Backend\Core\Engine\TwigTemplate