ColumnFilterWidget
extends CWidget
in package
ColumnFilterWidget provides column filtering functionality for GridViews.
It allows users to filter the visible columns in a grid based on the available and selected columns.
Table of Contents
Properties
- $ajaxUpdate : string|null
- $columnsData : mixed
- $filterableColumns : array<string|int, mixed>
- $filteredColumns : array<string|int, mixed>
- $modalId : string
- $model : CModel
Methods
- init() : void
- Initializes the widget by registering necessary client-side scripts.
- registerClientScript() : void
- Registers required script files
- renderActions() : void
- Renders the actions for filtering columns in a CLSGridView.
- run() : void
- Executes the widget by rendering the column filter actions.
Properties
$ajaxUpdate
public
string|null
$ajaxUpdate
target the related grid ID
$columnsData
public
mixed
$columnsData
Data related to the columns, potentially including column metadata or additional information needed for rendering.
$filterableColumns
public
array<string|int, mixed>
$filterableColumns
= []
An array of columns that can be filtered (shown or hidden) by the user.
$filteredColumns
public
array<string|int, mixed>
$filteredColumns
= []
An array of columns that are currently filtered and visible in the grid.
$modalId
public
string
$modalId
The ID of the modal dialog used for selecting columns to filter.
$model
public
CModel
$model
The data model associated with the grid view.
Methods
init()
Initializes the widget by registering necessary client-side scripts.
public
init() : void
registerClientScript()
Registers required script files
public
registerClientScript() : void
renderActions()
Renders the actions for filtering columns in a CLSGridView.
public
renderActions() : void
Tags
run()
Executes the widget by rendering the column filter actions.
public
run() : void