CompositeRenderableInterface extends RenderableInterface

Interface which all Form Parts must adhere to **when they have sub elements**.

This includes especially "FormDefinition" and "Page".

Scope: frontend This class is NOT meant to be sub classed by developers.

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
getRenderablesRecursively()  : array<string|int, RenderableInterface>
Returns all RenderableInterface instances of this composite renderable recursively
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.

Methods

getIdentifier()

The identifier of this renderable

public getIdentifier() : string
Return values
string

getIndex()

Get the index inside the parent renderable

public getIndex() : int
Return values
int

getLabel()

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

public getLabel() : string
Return values
string

getRenderablesRecursively()

Returns all RenderableInterface instances of this composite renderable recursively

public getRenderablesRecursively() : array<string|int, RenderableInterface>
Internal
Return values
array<string|int, RenderableInterface>

getRendererClassName()

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

getTemplateName()

Get the template name of the renderable

public getTemplateName() : string
Return values
string

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
Return values
string

isEnabled()

Returns whether this renderable is enabled

public isEnabled() : bool
Return values
bool

onRemoveFromParentRenderable()

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.

public onRemoveFromParentRenderable() : mixed
Internal

registerInFormIfPossible()

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

public registerInFormIfPossible() : mixed
Internal

setIndex()

Set the index of this renderable inside the parent renderable

public setIndex(int $index) : mixed
Parameters
$index : int
Internal

setParentRenderable()

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

public setParentRenderable(CompositeRenderableInterface $renderable) : mixed

This method should also register itself at the parent form, if possible.

Parameters
$renderable : CompositeRenderableInterface
Internal 

        

        
    




    

    

                            

            

                        
    

        On this page

        
    


            

                    

        

    

        

            
Search results