Class Column

Representation of a column of the manager element.

This is the base class for all the columns.

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

Extended by

Icybee\ManageBlock\Column

Direct known subclasses

Icybee\ManageBlock\BooleanColumn, Icybee\ManageBlock\DateTimeColumn, Icybee\Modules\Files\ManageBlock\MimeColumn, Icybee\Modules\Forms\ManageBlock\ModelIdColumn, Icybee\Modules\Images\ManageBlock\SurfaceColumn, Icybee\Modules\Nodes\ManageBlock\TitleColumn, Icybee\Modules\Nodes\ManageBlock\TranslationsColumn, Icybee\Modules\Nodes\ManageBlock\URLColumn, Icybee\Modules\Sites\ManageBlock\LanguageColumn, Icybee\Modules\Sites\ManageBlock\StatusColumn, Icybee\Modules\Sites\ManageBlock\TimezoneColumn, Icybee\Modules\Sites\ManageBlock\TitleColumn, Icybee\ManageBlock\EditColumn, Icybee\Modules\Sites\ManageBlock\URLColumn, Icybee\Modules\Taxonomy\Terms\ManageBlock\PopularityColumn, Icybee\Modules\Taxonomy\Terms\ManageBlock\TermColumn, Icybee\Modules\Taxonomy\Terms\ManageBlock\VidColumn, Icybee\Modules\Taxonomy\Vocabulary\ManageBlock\ScopeColumn, Icybee\Modules\Taxonomy\Vocabulary\ManageBlock\VocabularyColumn, Icybee\Modules\Users\ManageBlock\EmailColumn, Icybee\Modules\Users\ManageBlock\RolesColumn, Icybee\Modules\Users\ManageBlock\UserColumn, Icybee\Modules\Users\ManageBlock\UsernameColumn, Icybee\ManageBlock\KeyColumn, Icybee\ManageBlock\SizeColumn, Icybee\Modules\Comments\ManageBlock\AuthorColumn, Icybee\Modules\Comments\ManageBlock\CommentColumn, Icybee\Modules\Comments\ManageBlock\NodeColumn, Icybee\Modules\Comments\ManageBlock\StatusColumn, Icybee\Modules\Files\ManageBlock\DownloadColumn

Indirect known subclasses

Icybee\ManageBlock\DateColumn, Icybee\Modules\Contents\ManageBlock\IsHomeExcludedColumn, Icybee\Modules\Files\ManageBlock\SizeColumn, Icybee\Modules\Images\ManageBlock\TitleColumn, Icybee\Modules\Nodes\ManageBlock\IsOnlineColumn, Icybee\Modules\Pages\ManageBlock\IsNavigationExcluded, Icybee\Modules\Pages\ManageBlock\TitleColumn, Icybee\Modules\Pages\ManageBlock\URLColumn, Icybee\Modules\Users\ManageBlock\IsActivatedColumn, Icybee\Modules\Users\ManageBlock\LoggedAtColumn

Namespace: Icybee\ManageBlock
Located at vendor/icybee/icybee/lib/blocks/manage/column.php

Methods summary

`public`	# `__construct( Icybee\ManageBlock $manager, mixed $id, array $options = array() )`
`protected`	# `set_filtering( )`
`protected`	# `set_label( mixed $value )`
`protected`	# `get_label( )`
`protected boolean`	# `get_is_filtering( )` Returns `true` if the column is filtering the records. Returns `true` if the column is filtering the records. Returns `boolean`
`protected mixed\|null`	# `get_filter_value( )` Returns the value used by the column to filter the records. Returns the value used by the column to filter the records. Returns `mixed\|null`
`public string`	# `t( string $native, array $args = array(), array $options = array() )` Translates and formats the specified string. Translates and formats the specified string. Parameters `$native` `string` $native `$args` `array` $args `$options` `array` $options Returns `string`
`protected array`	# `resolve_default_values( )` Returns the default values for the column initialization. Returns the default values for the column initialization. Returns `array`
`public Icybee\ManageBlock\Column`	# `modify_options( array $options )` Modifies the options of the column. Modifies the options of the column. Parameters `$options` `array` $options Returns `Icybee\ManageBlock\Column`
`public array`	# `alter_filters( array $filters, array $modifiers )` Updates the filters for the records according to the specified modifiers. Updates the filters for the records according to the specified modifiers. Note: The filters are returned as is, subclasses shoudl override the method according to their needs. Parameters `$filters` `array` $filters `$modifiers` `array` $modifiers Returns `array` The updated filters.
`public ICanBoogie\ActiveRecord\Query`	# `alter_query_with_filter( ICanBoogie\ActiveRecord\Query $query, mixed $filter_value )` Alters the query according to the filter value specified. Alters the query according to the filter value specified. The method does a simple `{$this->id} = {$filter_value}`, subclasses might want to override the method according to the kind of filter they provide. Parameters `$query` `ICanBoogie\ActiveRecord\Query` $query `$filter_value` `mixed` $filter_value Returns `ICanBoogie\ActiveRecord\Query`
`public ICanBoogie\ActiveRecord\Query`	# `alter_query_with_order( ICanBoogie\ActiveRecord\Query $query, integer $order_direction )` Alters the ORDER clause of the query according to the column identifier and the order direction. Alters the ORDER clause of the query according to the column identifier and the order direction. The implementation of the method is simple, subclasses might want to override the method to support complexer ordering. Parameters `$query` `ICanBoogie\ActiveRecord\Query` $query `$order_direction` `integer` $order_direction Returns `ICanBoogie\ActiveRecord\Query`
`public array[]ActiveRecord`	# `alter_records( array $records )` Alters the records. Alters the records. Note: The records are returned as is, subclasses might override the method according to their needs. Parameters `$records` `array` $records Returns `array[]ActiveRecord`
`protected array\|null`	# `get_options( )` Returns the options available for the filter. Returns the options available for the filter. Returns `array\|null`
`public`	# `render_options( )` Renders the column's options. Renders the column's options.
`public string`	# `render_header( )` Renders the column's header. Renders the column's header. Returns `string`
`public string`	# `render_cell( mixed $record )` Renders a column cell. Renders a column cell. Parameters `$record` `mixed` $record Returns `string`
`public`	# `add_assets( Brickrouge\Document $document )` Adds assets to the document. Adds assets to the document. Subclasses might implement this method to add assets to the document. Parameters `$document` `Brickrouge\Document` $document

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

`integer`	`ORDER_ASC`	`1`	#
`integer`	`ORDER_DESC`	`-1`	#

Properties summary

`public mixed`	`$id`	#
`public mixed`	`$title`	#
`public mixed`	`$class`	#
`public mixed`	`$filters`	#
`public mixed`	`$reset`	#
`public boolean`	`$orderable`	#
`public mixed`	`$order`	#
`public integer`	`$default_order`	#
`public boolean`	`$discreet`	#
`protected string`	`$header_renderer`	#
`protected string`	`$cell_renderer`	#
`public mixed`	`$manager`	#

Magic properties

`public read-only mixed`	`$filter_value`		# The value used by the column to filter the records. The value used by the column to filter the records.
`public read-only boolean`	`$is_filtering`		# `true` if the column is currently filtering the records. `false` otherwise. `true` if the column is currently filtering the records. `false` otherwise.

Magic properties inherited from ICanBoogie\Object