Class ListView

A listview element.

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

Extended by

Brickrouge\Element implements ArrayAccess, IteratorAggregate, Brickrouge\HTMLStringInterface

Extended by

Brickrouge\ListView

Direct known subclasses

Icybee\Modules\Cache\ManageBlock, Icybee\Modules\Modules\ManageBlock

Indirect known subclasses

Icybee\Modules\Modules\InactivesBlock

Namespace: Brickrouge
Located at vendor/icybee/icybee/lib/element/listview.php

Methods summary

`public`	# `__construct( array $attributes = array() )` Parameters `$attributes` `string` $type Type of the element, it can be one of the custom types (`TYPE_*`) or any HTML type. Overrides `Brickrouge\Element::__construct`
`protected array`	# `alter_class_names( array $class_names )` Adds the following class names: Adds the following class names: `listview` Parameters `$class_names` `array` $class_names Returns `array` Overrides `Brickrouge\Element::alter_class_names`
`protected Icybee\ListView\Column`	# `get_columns( )` Returns the columns of the listview. Returns the columns of the listview. Returns `Icybee\ListView\Column`
`protected`	# `resolve_columns( array $columns )`
`protected array[]mixed`	# `get_entries( )` Returns the entries to display. Returns the entries to display. Returns `array[]mixed`
`protected string\|null`	# `render_inner_html( )` Returns the HTML representation of the element's content. Returns the HTML representation of the element's content. The children of the element are ordered before they are rendered using the `Brickrouge\Element::render_children()` method. According to their types, the following methods can be invoked to render the inner HTML of elements: `Brickrouge\Element::render_inner_html_for_select()` `Brickrouge\Element::render_inner_html_for_textarea()` `Brickrouge\Element::render_inner_html_for_checkbox_group()` `Brickrouge\Element::render_inner_html_for_radio_group()` Returns `string\|null` The content of the element. The element is to be considered _self-closing_ if `null` is returned. Overrides `Brickrouge\Element::render_inner_html`
`protected`	# `render_head( )`
`protected`	# `render_foot( )`
`protected Brickrouge\Element`	# `render_body( )` Renders body. Renders body. Returns `Brickrouge\Element` An `Brickrouge\Element` instance representing a `tbody` element. Its children are the rendered rows returned by `Brickrouge\ListView::render_rows()`.
`protected array[string]mixed`	# `render_cells( array $columns )` Renders the cells of the columns. Renders the cells of the columns. The method returns an array with the following layout: [<column_id>][] => <cell_content> Parameters `$columns` `array` $columns The columns to render. Returns `array[string]mixed`
`protected array[string]mixed`	# `alter_rendered_cells( array $rendered_cells )` Alters the rendering cells. Alters the rendering cells. Note: The method returns the rendered cells as is. Parameters `$rendered_cells` `array` $rendered_cells Returns `array[string]mixed`
`protected array[]array`	# `columns_to_rows( array $rendered_cells )` Convert rendered cells to rows. Convert rendered cells to rows. Parameters `$rendered_cells` `array` $rendered_cells Returns `array[]array`
`protected array[]Element`	# `render_rows( array $rows )` Renders the specified rows. Renders the specified rows. The rows are rendered as an array of `Brickrouge\Element` instances representing `TR` elements. Parameters `$rows` `array` $rows Returns `array[]Element`

Methods inherited from Brickrouge\Element

__toString(), add_assets(), add_class(), adopt(), alter_attributes(), alter_dataset(), auto_element_id(), decorate(), decorate_with_description(), decorate_with_inline_help(), decorate_with_label(), decorate_with_legend(), getIterator(), get_attributes(), get_class(), get_dataset(), get_ordered_children(), handle_assets(), has_class(), lazy_get_id(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), remove_class(), render(), render_attributes(), render_child(), render_children(), 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(), validate()

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

Constants summary

`string`	`COLUMNS`	`'#listview-columns'`	#
`string`	`ENTRIES`	`'#listview-entries'`	#

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 array[string]ListViewColumn`	`$columns`	# Columns use to display the data of the records. Columns use to display the data of the records.

Properties inherited from Brickrouge\Element

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

Magic properties inherited from Brickrouge\Element

$class, $dataset, $id

Magic properties inherited from ICanBoogie\Object