Section extends AbstractSection implements FormElementInterface

A Section, being part of a bigger Page

This class contains multiple FormElements ().

Please see for an in-depth explanation.

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

Table of Contents

Interfaces

FormElementInterface
A base form element interface, which can be the starting point for creating custom (PHP-based) Form Elements.

Properties

$identifier  : string
The identifier of this renderable
$index  : int
The position of this renderable inside the parent renderable.
$label  : string
The label of this renderable
$parentRenderable  : CompositeRenderableInterface|null
The parent renderable
$properties  : array<string|int, mixed>
$renderables  : array<string|int, RenderableInterface>
array of child renderables
$renderingOptions  : array<string|int, mixed>
associative array of rendering options
$request  : ServerRequestInterface|null
$templateName  : string
The name of the template file of the renderable.
$type  : 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.
$validatorResolver  : ValidatorResolver|null
$variants  : array<string|int, mixed>
associative array of rendering variants

Methods

__construct()  : mixed
Constructor. Needs the identifier and type of this element
addElement()  : mixed
Add a new form element at the end of the section
addValidator()  : mixed
Add a validator to the element.
addVariant()  : mixed
Adds the specified variant to this form element
applyVariant()  : mixed
Apply the specified variant to this form element regardless of their conditions
createElement()  : FormElementInterface
Create a form element with the given $identifier and attach it to this section/page.
createValidator()  : ValidatorInterface
Create a validator for the element.
createVariant()  : RenderableVariantInterface
getDefaultValue()  : mixed
Get the default value with which the Form Element should be initialized during display.
getElements()  : array<string|int, FormElementInterface>
Get the child Form Elements
getElementsRecursively()  : array<string|int, FormElementInterface>
Get the child Form Elements
getIdentifier()  : string
Get the identifier of the element
getIndex()  : int
Get the index of the renderable
getLabel()  : string
Get the label of the renderable
getParentRenderable()  : CompositeRenderableInterface|null
Get the parent renderable
getProperties()  : array<string|int, mixed>
Get all element-specific configuration properties
getRenderablesRecursively()  : array<string|int, RenderableInterface>
Returns all RenderableInterface instances of this composite renderable recursively
getRendererClassName()  : string
Get the classname of the renderer
getRenderingOptions()  : array<string|int, mixed>
Get all rendering options
getRequest()  : ServerRequestInterface|null
getRootForm()  : FormDefinition
Get the root form this element belongs to
getTemplateName()  : string
Get the templateName name of the renderable
getType()  : string
Get the type of the renderable
getUniqueIdentifier()  : string
Returns a unique identifier of this element.
getValidators()  : SplObjectStorage
Get all validators on the element
getVariants()  : array<string|int, RenderableVariantInterface>
Get all rendering variants
initializeFormElement()  : mixed
Will be called as soon as the element is (tried to be) added to a form
isEnabled()  : bool
Returns whether this renderable is enabled
isRequired()  : bool
Whether or not this element is required
moveElementAfter()  : mixed
Move FormElement $element after $referenceElement
moveElementBefore()  : mixed
Move FormElement $element before $referenceElement.
onRemoveFromParentRenderable()  : mixed
This function is called after a renderable has been removed from its parent renderable.
registerInFormIfPossible()  : mixed
Register this element at the parent form, if there is a connection to the parent form.
removeElement()  : mixed
Remove $elementToRemove from this Section/Page
setDataType()  : mixed
Set the datatype
setDefaultValue()  : mixed
Set the default value with which the Form Element should be initialized during display.
setIdentifier()  : mixed
Set the identifier of the element
setIndex()  : mixed
Set the index of the renderable
setLabel()  : mixed
Set the label which shall be displayed next to the form element
setOptions()  : mixed
Set multiple properties of this object at once.
setParentRenderable()  : mixed
Set the parent renderable
setProperty()  : mixed
Set an element-specific configuration property.
setRenderingOption()  : mixed
Set the rendering option $key to $value.
setRequest()  : void
addRenderable()  : mixed
Add a renderable to the list of child renderables.
moveRenderableAfter()  : mixed
Move $renderableToMove after $referenceRenderable
moveRenderableBefore()  : mixed
Move $renderableToMove before $referenceRenderable
removeRenderable()  : mixed
Remove a renderable from this renderable.

Properties

$identifier

The identifier of this renderable

protected string $identifier

$index

The position of this renderable inside the parent renderable.

protected int $index = 0

$label

The label of this renderable

protected string $label = ''

$properties

protected array<string|int, mixed> $properties = []

$renderingOptions

associative array of rendering options

protected array<string|int, mixed> $renderingOptions = []

$request

protected ServerRequestInterface|null $request = null

$templateName

The name of the template file of the renderable.

protected string $templateName = ''

$type

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.

protected string $type

$variants

associative array of rendering variants

protected array<string|int, mixed> $variants = []

Methods

__construct()

Constructor. Needs the identifier and type of this element

public __construct(string $identifier, string $type) : mixed
Parameters
$identifier : string

The Section identifier

$type : string

The Section type

Tags
throws
IdentifierNotValidException

if the identifier was no non-empty string

createElement()

Create a form element with the given $identifier and attach it to this section/page.

public createElement(string $identifier, string $typeName) : FormElementInterface
  • Create Form Element object based on the given $typeName
  • set defaults inside the Form Element (based on the parent form's field defaults)
  • attach Form Element to this Section/Page
  • return the newly created Form Element object
Parameters
$identifier : string

Identifier of the new form element

$typeName : string

type of the new form element

Tags
throws
TypeDefinitionNotFoundException
throws
TypeDefinitionNotValidException
Return values
FormElementInterface —

the newly created form element

getDefaultValue()

Get the default value with which the Form Element should be initialized during display.

public getDefaultValue() : mixed

Note: This is currently not used for section elements

Return values
mixed —

the default value for this Form Element

getIdentifier()

Get the identifier of the element

public getIdentifier() : string
Return values
string

getIndex()

Get the index of the renderable

public getIndex() : int
Internal
Return values
int

getLabel()

Get the label of the renderable

public getLabel() : string
Return values
string

getProperties()

Get all element-specific configuration properties

public getProperties() : array<string|int, mixed>
Return values
array<string|int, mixed>

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 classname of the renderer

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

getRequest()

public getRequest() : ServerRequestInterface|null
Return values
ServerRequestInterface|null

getTemplateName()

Get the templateName name of the renderable

public getTemplateName() : string
Return values
string

getType()

Get the type of the renderable

public getType() : string
Return values
string

getUniqueIdentifier()

Returns a unique identifier of this element.

public getUniqueIdentifier() : string

While element identifiers are only unique within one form, this includes the identifier of the form itself, making it "globally" unique

Return values
string —

the "globally" unique identifier of this element

getValidators()

Get all validators on the element

public getValidators() : SplObjectStorage
Internal
Return values
SplObjectStorage

initializeFormElement()

Will be called as soon as the element is (tried to be) added to a form

public initializeFormElement() : mixed
Internal
Tags
see
registerInFormIfPossible()

isEnabled()

Returns whether this renderable is enabled

public isEnabled() : bool
Return values
bool

isRequired()

Whether or not this element is required

public isRequired() : bool
Return values
bool

onRemoveFromParentRenderable()

This function is called after a renderable has been removed from its parent renderable.

public onRemoveFromParentRenderable() : mixed

This just passes the event down to all child renderables of this composite renderable.

Internal

registerInFormIfPossible()

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

public registerInFormIfPossible() : mixed
Internal

setDataType()

Set the datatype

public setDataType(string $dataType) : mixed
Parameters
$dataType : string

setDefaultValue()

Set the default value with which the Form Element should be initialized during display.

public setDefaultValue(mixed $defaultValue) : mixed

Note: This is currently ignored for section elements

Parameters
$defaultValue : mixed

the default value for this Form Element

setIdentifier()

Set the identifier of the element

public setIdentifier(string $identifier) : mixed
Parameters
$identifier : string

setIndex()

Set the index of the renderable

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

setLabel()

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

public setLabel(string $label) : mixed
Parameters
$label : string

setOptions()

Set multiple properties of this object at once.

public setOptions(array<string|int, mixed> $options[, bool $resetValidators = false ]) : mixed

Every property which has a corresponding set* method can be set using the passed $options array.

Parameters
$options : array<string|int, mixed>
$resetValidators : bool = false

setProperty()

Set an element-specific configuration property.

public setProperty(string $key, mixed $value) : mixed
Parameters
$key : string
$value : mixed

setRenderingOption()

Set the rendering option $key to $value.

public setRenderingOption(string $key, mixed $value) : mixed
Parameters
$key : string
$value : mixed

setRequest()

public setRequest(ServerRequestInterface|null $request) : void
Parameters
$request : ServerRequestInterface|null 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results