Kotchasan

DataTable extends KBase

in package

• Kotchasan

Class for managing data presentation from a Model in table format.

Tags

see

https://www.kotchasan.com/

Table of Contents

$actions  : array<string|int, mixed>

If specified, checkboxes and action buttons will be shown.

$addNew  : array<string|int, mixed>

The button for adding new data.

$autoSearch  : bool

Specify the search behavior from the search box.

$buttons  : array<string|int, mixed>

Buttons to be added at the end of each row.

$cols  : array<string|int, mixed>

List of all columns.

$comment  : string

Text, such as Notes, is displayed next to the table.

$commentClass  : string

Note class name

$defaultFilters  : array<string|int, mixed>

List of main query commands for data selection.

$defaultSort  : string|null

The default column name used for sorting.

$enableJavascript  : bool

Enables the usage of DataTable's JavaScript.

$entriesList  : array<string|int, mixed>

Options for the number of entries to be displayed per page.

$filters  : array<string|int, mixed>

Data display filters.

$headers  : array<string|int, mixed>

List of header names for columns.

$hideCheckbox  : bool

Determines whether to hide the checkbox.

$hideColumns  : array<string|int, mixed>

List of columns that should not be displayed.

$page  : int

The current page being displayed.

$perPage  : int|null

The number of items per page.

$search  : string

The search text.

$searchColumns  : array<string|int, mixed>

List of fields that can be searched.

$searchForm  : bool|string

Determines the display of the search form.

$sort  : string|null

The column name used for sorting.

$cfg  : object

Config class instance.

$request  : Request

Server request class instance.

$sorts  : array<string|int, mixed>

The active sorting information.

$action  : string

URL for receiving actions such as delete.

$actionCallback  : string

Name of the Javascript function to call after sending data from action.

$actionConfirm  : string

Name of the JavaScript function called after clicking an action.

$border  : bool

Displays the table with borders.

$cache  : bool

Database cache.

$checkCol  : int

Column index of the checkbox.

$class  : string

Table class.

$columns  : array<string|int, mixed>

$datas  : array<string|int, mixed>

All data of the table in array format.

$debug  : bool

Displays the query on the screen.

$dragColumn  : int

Specifies the column that allows drag and drop for table reordering.

$explain  : bool

Displays the query's explain plan.

$fields  : array<string|int, mixed>

List of fields to query.

$fullWidth  : bool

Displays the table with 100% width.

$id  : string

Table ID.

$javascript  : array<string|int, mixed>

Javascript code.

$model  : QueryBuilder

Name of the Model to retrieve data from.

$onAddRow  : string

Name of the JavaScript function called when adding a new row (pmButton).

$onBeforeDelete  : string

Name of the JavaScript function called before deleting a row (pmButton).

$onChanged  : string

Name of the JavaScript function called after loading data via Ajax.

$onCreateButton  : array<string|int, mixed>

A method for preparing button rendering.

$onCreateFooter  : array<string|int, mixed>

A method to call when creating the footer.

$onCreateHeader  : array<string|int, mixed>

A method to call when creating the header.

$onDelete  : string

Name of the JavaScript function called after deleting a row (pmButton).

$onInitRow  : string

Name of the JavaScript function called to handle a new row.

$onRow  : array<string|int, mixed>

Method to handle each row's data before displaying.

$params  : array<string|int, mixed>

Array data to be sent to $url when called by Ajax.

$pmButton  : bool

Displays buttons for adding and deleting rows.

$primaryKey  : string

The primary key column name for data identification.

$responsive  : bool

Displays the table in responsive mode.

$showCaption  : bool

Displays the table caption.

$uri  : Uri

The current URI of the web page.

$url  : string

URL for reading data using Ajax.

__construct()  : mixed

Constructor.

render()  : string

Render the component.

script()  : mixed

Adds a JavaScript script to the table.

addAction()  : string|null

Adds an action element based on the provided item configuration.

addFilter()  : string

Adds a filter element based on the provided item configuration.

button()  : string

Generates HTML markup for a button element.

tbody()  : string

Generates HTML markup for the table body (<tbody>).

td()  : string

Generates HTML markup for a table cell (<td>) or header cell (<th>).

th()  : string

Generates HTML markup for a table header cell (<th>).