RootRenderableInterface
Base interface which all parts of a form must adhere to.
Scope: frontend This class is NOT meant to be sub classed by developers.
Table of Contents
Methods
- getIdentifier() : string
- The identifier of this renderable
- getLabel() : string
- Get the label which shall be displayed next to the form element
- getRendererClassName() : string
- Get the renderer class name to be used to display this form; must implement RendererInterface
- getRenderingOptions() : array<string|int, mixed>
- Get all rendering options
- getType() : string
- Abstract "type" of this Renderable. Is used during the rendering process to determine the template file or the View PHP class being used to render the particular element.
Methods
getIdentifier()
The identifier of this renderable
public
getIdentifier() : string
Return values
stringgetLabel()
Get the label which shall be displayed next to the form element
public
getLabel() : string
Return values
stringgetRendererClassName()
Get the renderer class name to be used to display this form; must implement RendererInterface
public
getRendererClassName() : string
Return values
string —the renderer class name
getRenderingOptions()
Get all rendering options
public
getRenderingOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —associative array of rendering options
getType()
Abstract "type" of this Renderable. Is used during the rendering process to determine the template file or the View PHP class being used to render the particular element.
public
getType() : string