Class DeleteBlock

A block to delete a record.

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

Extended by

Brickrouge\Element implements ArrayAccess, IteratorAggregate, Brickrouge\HTMLStringInterface

Extended by

Brickrouge\Form implements Brickrouge\Validator

Extended by

Icybee\DeleteBlock

Direct known subclasses

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

Indirect known subclasses

Icybee\Modules\Contents\DeleteBlock

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

Methods summary

`protected static`	# `add_assets( Brickrouge\Document $document )` Adds assets to the document. Adds assets to the document. Parameters `$document` `Icybee\Document` $document Overrides `Brickrouge\Element::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 Index 0 hold the key of the record to delete. Overrides `Brickrouge\Form::__construct`
`public string`	# `__toString( )` Renders the object into an HTML string. Renders the object into an HTML string. Before rendering the object form elements are altered according to the `Brickrouge\Form::VALUES` and `Brickrouge\Form::DISABLED` tags and previous validation errors. Returns `string` The HTML representation of the object See Element::__toString() Overrides `Brickrouge\Form::__toString`
`protected string`	# `get_title( )` Returns the localized title. Returns the localized title. Returns `string`
`protected Brickrouge\Element`	# `get_title_element( )` Returns the title element. Returns the title element. Returns `Brickrouge\Element`
`protected ICanBoogie\ActiveRecord`	# `lazy_get_record( )` Returns the record to delete. Returns the record to delete. Returns `ICanBoogie\ActiveRecord`
`protected string`	# `get_record_name( )` Returns the record name. Returns the record name. Returns `string`
`protected string`	# `get_question( )` Returns the localized confirmation question. Returns the localized confirmation question. Returns `string`
`protected Brickrouge\Element`	# `get_question_element( )` Returns the confirmation question element. Returns the confirmation question element. Returns `Brickrouge\Element`
`protected string`	# `render_preview( ICanBoogie\ActiveRecord $record )` Renders a preview of the record. Renders a preview of the record. Parameters `$record` `ICanBoogie\ActiveRecord` $record Returns `string`
`protected string`	# `get_preview( )` Returns a preview of the record. Returns a preview of the record. Returns `string`
`protected Brickrouge\Element`	# `get_preview_element( )` Returns the preview element. Returns the preview element. Returns `Brickrouge\Element`
`protected string`	# `render_dependencies( array $dependencies )` Renders the dependencies of the record. Renders the dependencies of the record. Parameters `$dependencies` `array` $dependencies Returns `string`
`protected string`	# `get_dependencies( )` Returns the dependencies of the record. Returns the dependencies of the record. Returns `string`
`protected Brickrouge\Element`	# `get_dependencies_element( )` Returns the dependencies element. Returns the dependencies element. Returns `Brickrouge\Element`
`protected string`	# `decorate( string $html )` Decorate the form as a block with a title, question and possible preview. Decorate the form as a block with a title, question and possible preview. Because at this level the method has no way of knowing the name of the record, it uses the localized string "record_name" which defaults to "this record". Parameters `$html` `string` $html The HTML to decorate. Returns `string` The decorated HTML. Overrides `Brickrouge\Element::decorate`

Methods inherited from Brickrouge\Form

__sleep(), alter_elements(), exists(), getIterator(), get_auto_name(), load(), offsetSet(), render_actions(), render_children(), render_errors(), render_hiddens(), render_inner_html(), save(), select_element_label(), validate(), validate_email(), validate_range(), validate_required_elements(), validate_string(), validate_url()

Methods inherited from Brickrouge\Element

add_class(), adopt(), alter_attributes(), alter_class_names(), alter_dataset(), auto_element_id(), decorate_with_description(), decorate_with_inline_help(), decorate_with_label(), decorate_with_legend(), get_attributes(), get_class(), get_dataset(), get_ordered_children(), handle_assets(), has_class(), lazy_get_id(), offsetExists(), offsetGet(), offsetUnset(), remove_class(), render(), render_attributes(), render_child(), render_class(), render_dataset(), render_inner_html_for_checkbox_group(), render_inner_html_for_radio_group(), render_inner_html_for_select(), render_inner_html_for_textarea(), render_outer_html(), set_class(), set_dataset()

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(), __wakeup(), get_prototype(), has_method(), has_property(), last_chance_get(), last_chance_set()

Magic methods summary

Constants summary

Constants inherited from Brickrouge\Form

ACTIONS, DISABLED, ERRORS, HIDDENS, LABEL_COMPLEMENT, NO_LOG, RENDERER, STORED_KEY_NAME, VALUES

Constants inherited from Brickrouge\Element

CHILDREN, DEFAULT_VALUE, DESCRIPTION, GROUP, GROUPS, INLINE_HELP, INNER_HTML, LABEL, LABEL_MISSING, LABEL_POSITION, LEGEND, OPTIONS, OPTIONS_DISABLED, REQUIRED, STATE, TYPE_CHECKBOX, TYPE_CHECKBOX_GROUP, TYPE_RADIO, TYPE_RADIO_GROUP, VALIDATOR, VALIDATOR_OPTIONS, WEIGHT, WIDGET_CONSTRUCTOR

Properties summary

`protected Icybee\Module`	`$module`	# Module associated with this block. Module associated with this block.
`protected integer`	`$key`	# Key of the record to delete. Key of the record to delete.

Properties inherited from Brickrouge\Form

$auto_name_index, $booleans, $hiddens, $name, $required, $validator, $validators

Properties inherited from Brickrouge\Element

$auto_element_id, $children, $class_names, $inner_html, $tag_name, $tags, $type

Magic properties

`public string`	`$title`		# The localized title of the block. `Icybee\DeleteBlock::get_title()` The localized title of the block. `Icybee\DeleteBlock::get_title()`
`public ICanBoogie\ActiveRecord`	`$record`		# The record to delete. get_record() The record to delete. get_record()
`public string`	`$record_name`		# The name of the record to delete. `Icybee\DeleteBlock::get_record_name()` The name of the record to delete. `Icybee\DeleteBlock::get_record_name()`

Magic properties inherited from Brickrouge\Element

$class, $dataset, $id

Magic properties inherited from ICanBoogie\Object