Class FormBlock

Base class for form type blocks.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait

Icybee\FormBlock

Direct known subclasses

Icybee\ConfigBlock, Icybee\EditBlock

Indirect known subclasses

Abstract
Namespace: Icybee
Located at vendor/icybee/icybee/lib/blocks/form.php

Methods summary

`protected static`	# `add_assets( Brickrouge\Document $document )` Adds assets to the document. Adds assets to the document. The method doesn't add any asset. Parameters `$document` `Brickrouge\Document` $document
`public`	# `__construct( Icybee\Module $module, array $attributes = array() )` Constructor. Constructor. Parameters `$module` `Icybee\Module` $module `$attributes` `array` $attributes
`abstract protected boolean`	# `get_permission( )` Returns whether the user has permission to display this block. Returns whether the user has permission to display this block. Returns `boolean`
`abstract protected`	# `access_control( )` Controls the access to the block. Controls the access to the block. Throws `Exception` if the used has no permission to access the block.
`protected array`	# `alter( array $params )` Alters the various parameters of the block. Alters the various parameters of the block. For each parameter the method checks if a `alter_<param>` method exists. If the method exists the following methods are invoked to alter the value of the parameter: `fire_before_<param>`: Fires the `alter_<param>:before` event. `alter_<param>`: Alters the values of the parameter. `fire_<param>`: Fires the `alter_<param>` event. Parameters `$params` `array` $params The parameters to alter. Returns `array`
`public Brickrouge\Form`	# `render( )` Renders the block into a `Brickrouge\Form` element. Renders the block into a `Brickrouge\Form` element. The method invokes the `Icybee\FormBlock::alter()` method to alter the attribute for the `Brickrouge\Form` element, and invokes the `Icybee\FormBlock::alter_element()` method to alter the `Brickrouge\Form` element with the following properties: `module`: The module creating the block. `attributes`: The attributes of the `Brickrouge\Form` element. `actions`: The actions of the `Brickrouge\Form` element. `children`: The children of the `Brickrouge\Form` element. `values`: The values of the `Brickrouge\Form` element. Returns `Brickrouge\Form`
`public string`	# `__toString( )` Renders the block into a HTML string. Renders the block into a HTML string. The method invokes the `Icybee\FormBlock::render()` method. Returns `string`
`protected array`	# `lazy_get_attributes( )` Returns the attributes for the `Brickrouge\Form` element. Returns the attributes for the `Brickrouge\Form` element. The following attributes are defined: The destination of the operation: The module id. The form renderer: An instance of `Brickrouge\Renderer\Simple` with the `Icybee\Element\Group` group class. Groups: The `primary` group. id: `editor. action: An empty string. class: `form-primary edit`. name: The identifier of the module. Returns `array`
`protected array`	# `alter_attributes( array $attributes, array $params )` Alters the attributes of the `Brickrouge\Form` element. Alters the attributes of the `Brickrouge\Form` element. The method returns the attributes as is. Parameters `$attributes` `array` $attributes The attributes to alter. `$params` `array` $params The alter parameters. Returns `array`
`protected`	# `fire_before_alter_attributes( array $payload )` Fires the `alter_attributes:before` event of class `Icybee\FormBlock\BeforeAlterAttributesEvent`. Fires the `alter_attributes:before` event of class `Icybee\FormBlock\BeforeAlterAttributesEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected`	# `fire_alter_attributes( array $payload )` Fires the `alter_attributes` event of class `Icybee\FormBlock\AlterAttributesEvent`. Fires the `alter_attributes` event of class `Icybee\FormBlock\AlterAttributesEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected array`	# `lazy_get_values( )` Returns the values for the `Brickrouge\Form` element. Returns the values for the `Brickrouge\Form` element. The method returns the values defined in the initial attributes or an empty array if they were not defined. Returns `array`
`protected array`	# `alter_values( array $values, array $params )` Alerts the values for the `Brickrouge\Form` element. Alerts the values for the `Brickrouge\Form` element. The method returns the values as is. Parameters `$values` `array` $values The values to alter. `$params` `array` $params The alter parameters. Returns `array`
`protected`	# `fire_before_alter_values( array $payload )` Fires the `alter_values:before` event of class `Icybee\FormBlock\BeforeAlterValuesEvent`. Fires the `alter_values:before` event of class `Icybee\FormBlock\BeforeAlterValuesEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected`	# `fire_alter_values( array $payload )` Fires the `alter_values` event of class `Icybee\FormBlock\AlterValuesEvent`. Fires the `alter_values` event of class `Icybee\FormBlock\AlterValuesEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected array`	# `lazy_get_children( )` Returns the children of the `Brickrouge\Form` element. Returns the children of the `Brickrouge\Form` element. The method returns the children defined in the initial attributes or an empty array if they were not defined. Returns `array`
`protected array`	# `alter_children( array $children, array $params )` Alters the children for the `Brickrouge\Form` element. Alters the children for the `Brickrouge\Form` element. The method returns the children as is. Parameters `$children` `array` $children The children to alter. `$params` `array` $params The alter parameters. Returns `array`
`protected`	# `fire_before_alter_children( array $payload )` Fires the `alter_children:before` event of class `Icybee\FormBlock\BeforeAlterChildrenEvent`. Fires the `alter_children:before` event of class `Icybee\FormBlock\BeforeAlterChildrenEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected`	# `fire_alter_children( array $payload )` Fires the `alter_children` event of class `Icybee\FormBlock\AlterChildrenEvent`. Fires the `alter_children` event of class `Icybee\FormBlock\AlterChildrenEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected array`	# `lazy_get_actions( )` Returns the actions for the `Brickrouge\Form` element. Returns the actions for the `Brickrouge\Form` element. The method returns an array with a `Send` button. The button can be overrode using the `primary` key. Returns `array`
`protected array`	# `alter_actions( array $actions, array $params )` Alters the actions for the `Brickrouge\Form` element. Alters the actions for the `Brickrouge\Form` element. The method returns the actions as is. Parameters `$actions` `array` $actions The actions to alter. `$params` `array` $params The alter parameters. Returns `array`
`protected`	# `fire_before_alter_actions( array $payload )` Fires the `alter_actions:before` event of class `Icybee\FormBlock\BeforeAlterActionsEvent`. Fires the `alter_actions:before` event of class `Icybee\FormBlock\BeforeAlterActionsEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected`	# `fire_alter_actions( array $payload )` Fires the `alter_actions` event of class `Icybee\FormBlock\AlterActionsEvent`. Fires the `alter_actions` event of class `Icybee\FormBlock\AlterActionsEvent`. Parameters `$payload` `array` $payload The properties of the event.
`protected Brickrouge\Form`	# `lazy_get_element( )` Returns the `Brickrouge\Form` element. Returns the `Brickrouge\Form` element. Returns `Brickrouge\Form`
`protected Brickrouge\Form`	# `alter_element( Brickrouge\Form $element, array $params )` Alters the `Brickrouge\Form` element. Alters the `Brickrouge\Form` element. The method return the element as is. Parameters `$element` `Brickrouge\Form` $element The element to alter. `$params` `array` $params The alter parameters. Returns `Brickrouge\Form`

Magic methods summary

Properties summary

`protected Icybee\Module`	`$module`	# Module requesting the block. Module requesting the block.
`protected array`	`$initial_attributes`	# Attributes provided during construct. Attributes provided during construct.

Magic properties

`public array`	`$actions`	# The actions for the `Brickrouge\Form` element. The actions for the `Brickrouge\Form` element.
`public array`	`$attributes`	# The attributes for the `Brickrouge\Form` element. The attributes for the `Brickrouge\Form` element.
`public Brickrouge\Form`	`$element`	# The `Brickrouge\Form` element. The `Brickrouge\Form` element.
`public array`	`$values`	# The values for the `Brickrouge\Form` element. The values for the `Brickrouge\Form` element.

Magic properties inherited from ICanBoogie\Object

$prototype

Namespaces

Classes

Constants

Functions

Class FormBlock

Direct known subclasses

Indirect known subclasses

Methods summary

Parameters

Parameters

Returns

Throws

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Methods inherited from ICanBoogie\Object

Methods inherited from ICanBoogie\ToArrayRecursive

Methods used from ICanBoogie\ToArrayRecursiveTrait

Methods used from ICanBoogie\PrototypeTrait

Magic methods summary

Properties summary

Magic properties

Magic properties inherited from ICanBoogie\Object