Autodoc
  • Namespace
  • Class
  • Tree

Namespaces

  • BlueTihi
    • Context
  • Brickrouge
    • Element
      • Nodes
    • Renderer
    • Widget
  • ICanBoogie
    • ActiveRecord
    • AutoConfig
    • CLDR
    • Composer
    • Core
    • Event
    • Exception
    • HTTP
      • Dispatcher
      • Request
    • I18n
      • Translator
    • Mailer
    • Modules
      • Taxonomy
        • Support
      • Thumbnailer
        • Versions
    • Object
    • Operation
      • Dispatcher
    • Prototype
    • Routes
    • Routing
      • Dispatcher
    • Session
  • Icybee
    • ActiveRecord
      • Model
    • ConfigOperation
    • Document
    • EditBlock
    • Element
      • ActionbarContextual
      • ActionbarSearch
      • ActionbarToolbar
    • FormBlock
    • Installer
    • ManageBlock
    • Modules
      • Articles
      • Cache
        • Collection
        • ManageBlock
      • Comments
        • ManageBlock
      • Contents
        • ManageBlock
      • Dashboard
      • Editor
        • Collection
      • Files
        • File
        • ManageBlock
      • Forms
        • Form
        • ManageBlock
      • I18n
      • Images
        • ManageBlock
      • Members
      • Modules
        • ManageBlock
      • Nodes
        • ManageBlock
        • Module
      • Pages
        • BreadcrumbElement
        • LanguagesElement
        • ManageBlock
        • NavigationBranchElement
        • NavigationElement
        • Page
        • PageController
      • Registry
      • Search
      • Seo
      • Sites
        • ManageBlock
      • Taxonomy
        • Terms
          • ManageBlock
        • Vocabulary
          • ManageBlock
      • Users
        • ManageBlock
        • NonceLogin
        • Roles
      • Views
        • ActiveRecordProvider
        • Collection
        • View
    • Operation
      • ActiveRecord
      • Constructor
      • Module
      • Widget
    • Rendering
  • None
  • Patron
  • PHP

Classes

  • AdminDecorator
  • AdminIndexController
  • BlockController
  • BlockDecorator
  • ConfigBlock
  • ConfigController
  • ConfigOperation
  • Core
  • DeleteBlock
  • DeleteController
  • Document
  • DocumentDecorator
  • EditBlock
  • EditController
  • FormBlock
  • Hooks
  • InterlockBlock
  • Kses
  • ManageBlock
  • Module
  • Modules
  • StatsDecorator

Constants

  • OPERATION_SAVE_MODE
  • OPERATION_SAVE_MODE_CONTINUE
  • OPERATION_SAVE_MODE_DISPLAY
  • OPERATION_SAVE_MODE_LIST
  • OPERATION_SAVE_MODE_NEW

Functions

  • slugize
  • start
  • strip_stopwords

Class EditBlock

A record editor.

ICanBoogie\Object implements ICanBoogie\ToArrayRecursive uses ICanBoogie\ToArrayRecursiveTrait, ICanBoogie\PrototypeTrait
Extended by Icybee\FormBlock
Extended by Icybee\EditBlock

Direct known subclasses

Icybee\Modules\Comments\EditBlock, Icybee\Modules\Nodes\EditBlock, Icybee\Modules\Sites\EditBlock, Icybee\Modules\Taxonomy\Terms\EditBlock, Icybee\Modules\Taxonomy\Vocabulary\EditBlock, Icybee\Modules\Users\ConfigBlock, Icybee\Modules\Users\EditBlock, Icybee\Modules\Users\Roles\EditBlock

Indirect known subclasses

Icybee\Modules\Articles\EditBlock, Icybee\Modules\Contents\EditBlock, Icybee\Modules\Files\EditBlock, Icybee\Modules\Forms\EditBlock, Icybee\Modules\Images\EditBlock, Icybee\Modules\Members\EditBlock, Icybee\Modules\Pages\EditBlock

Namespace: Icybee
Located at vendor/icybee/icybee/lib/blocks/edit.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

Overrides

Icybee\FormBlock::add_assets
public
# __construct( Icybee\Module $module, array $attributes = array(), array $params = array() )

Constructor.

Constructor.

Parameters

$module
Icybee\Module
$module
$attributes
array
$attributes
$params
array
$params

Overrides

Icybee\FormBlock::__construct
protected array
# alter( array $params )

Adds the key and record properties to the alter parameters.

Adds the key and record properties to the alter parameters.

Parameters

$params
array
$params The parameters to alter.

Returns

array

Overrides

Icybee\FormBlock::alter
public Brickrouge\Form
# render( )

If the record to edit is locked by another user a Icybee\InterlockBlock is returned instead of the Brickrouge\Form element.

If the record to edit is locked by another user a Icybee\InterlockBlock is returned instead of the Brickrouge\Form element.

Returns

Brickrouge\Form

Overrides

Icybee\FormBlock::render
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
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 ICanBoogie\ActiveRecord
# lazy_get_record( )

Returns the record being edited or null if its a new record.

Returns the record being edited or null if its a new record.

Returns

ICanBoogie\ActiveRecord
protected array
# lazy_get_attributes( )

Adds the following:

Adds the following:

  • The name of the operation: save.
  • The key of the operation: The key provided during construct.
  • The admin element group.

Returns

array

Overrides

Icybee\FormBlock::lazy_get_attributes
protected
# fire_before_alter_attributes( array $properties )

Fires the alter_attributes:before event of class Icybee\EditBlock\BeforeAlterAttributesEvent.

Fires the alter_attributes:before event of class Icybee\EditBlock\BeforeAlterAttributesEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_before_alter_attributes
protected
# fire_alter_attributes( array $properties )

Fires the alter_attributes event of class Icybee\EditBlock\AlterAttributesEvent.

Fires the alter_attributes event of class Icybee\EditBlock\AlterAttributesEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_alter_attributes
protected array
# lazy_get_values( )

Merges the values returned by the parent with the following arrays:

Merges the values returned by the parent with the following arrays:

  • An array with all the properties of the extended schema set to null.
  • An array with the properties of the record.
  • An array with the request params of the request.

Returns

array

Overrides

Icybee\FormBlock::lazy_get_values
protected
# fire_before_alter_values( array $properties )

Fires the alter_values:before event of class Icybee\EditBlock\BeforeAlterValuesEvent.

Fires the alter_values:before event of class Icybee\EditBlock\BeforeAlterValuesEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_before_alter_values
protected
# fire_alter_values( array $properties )

Fires the alter_values event of class Icybee\EditBlock\AlterValuesEvent.

Fires the alter_values event of class Icybee\EditBlock\AlterValuesEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_alter_values
protected
# fire_before_alter_children( array $properties )

Fires the alter_children:before event of class Icybee\EditBlock\BeforeAlterChildrenEvent.

Fires the alter_children:before event of class Icybee\EditBlock\BeforeAlterChildrenEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_before_alter_children
protected
# fire_alter_children( array $properties )

Fires the alter_children event of class Icybee\EditBlock\AlterChildrenEvent.

Fires the alter_children event of class Icybee\EditBlock\AlterChildrenEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_alter_children
protected array
# lazy_get_actions( )

Replaces the primary button with a button with the label "Save".

Replaces the primary button with a button with the label "Save".

Returns

array

Overrides

Icybee\FormBlock::lazy_get_actions
protected array
# alter_actions( array $actions, array $params )

Adds the save mode checkbox group of the actions as well as the action bar.

Adds the save mode checkbox group of the actions as well as the action bar.

Parameters

$actions
array
$actions The actions to alter.
$params
array
$params The alter parameters.

Returns

array

Overrides

Icybee\FormBlock::alter_actions
protected
# fire_before_alter_actions( array $properties )

Fires the alter_actions:before event of class Icybee\EditBlock\BeforeAlterActionsEvent.

Fires the alter_actions:before event of class Icybee\EditBlock\BeforeAlterActionsEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_before_alter_actions
protected
# fire_alter_actions( array $properties )

Fires the alter_actions event of class Icybee\EditBlock\AlterActionsEvent.

Fires the alter_actions event of class Icybee\EditBlock\AlterActionsEvent.

Parameters

$properties
array
$payload The properties of the event.

Overrides

Icybee\FormBlock::fire_alter_actions
protected Brickrouge\Form
# alter_element( Brickrouge\Form $element, array $params )

If the user doesn't have the permission to edit the record, the actions of the Brickrouge\Form element are set to null and the form is disabled.

If the user doesn't have the permission to edit the record, the actions of the Brickrouge\Form element are set to null and the form is disabled.

Parameters

$element
Brickrouge\Form
$element The element to alter.
$params
array
$params The alter parameters.

Returns

Brickrouge\Form

Overrides

Icybee\FormBlock::alter_element

Methods inherited from Icybee\FormBlock

__toString(), alter_attributes(), alter_children(), alter_values(), lazy_get_children(), lazy_get_element()

Methods inherited from ICanBoogie\Object

from(), resolve_facade_properties(), resolve_private_properties(), to_array(), to_json()

Methods inherited from ICanBoogie\ToArrayRecursive

to_array_recursive()

Methods used from ICanBoogie\ToArrayRecursiveTrait

to_array_recursive()

Methods used from ICanBoogie\PrototypeTrait

__call(), __get(), __set(), __sleep(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Properties summary

protected integer $key
#

The key of the record to edit.

The key of the record to edit.

Properties inherited from Icybee\FormBlock

$initial_attributes, $module

Magic properties inherited from Icybee\FormBlock

$actions, $attributes, $element, $values

Magic properties inherited from ICanBoogie\Object

$prototype

Autodoc API documentation generated by ApiGen 2.8.0