RenderableInterface extends RootRenderableInterface

Base interface which all Form Parts except the FormDefinition must adhere to (i.e. all elements which are NOT the root of a Form).

Table of Contents

Methods

getIdentifier()  : string

The identifier of this renderable

getIndex()  : int

Get the index inside the parent renderable

getLabel()  : string

Get the label which shall be displayed next to the form element

getParentRenderable()  : CompositeRenderableInterface|null

Return the parent renderable

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

getTemplateName()  : string

Get the template name of the renderable

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.

isEnabled()  : bool

Returns whether this renderable is enabled

onRemoveFromParentRenderable()  : mixed

This function is called after a renderable has been removed from its parent renderable. The function should make sure to clean up the internal state, like resetting $this->parentRenderable or deregistering the renderable of the form.

registerInFormIfPossible()  : mixed

Register this element at the parent form, if there is a connection to the parent form.

setIndex()  : mixed

Set the index of this renderable inside the parent renderable

setParentRenderable()  : mixed

Set the new parent renderable. You should not call this directly; it is automatically called by addRenderable.