Type to search columns, filters, options, and extensions.

to navigate · Enter to open · Esc to close

Documentation

DataTableRequest

Request DTOs used for server-side processing

DataTableRequest and related value objects wrap DataTables request payloads in typed PHP objects.

Main DTO

use Pentiminax\UX\DataTables\DataTableRequest\DataTableRequest;

$requestDto = DataTableRequest::fromRequest($request);

Fields:

FieldTypeDescription
draw?intRequest counter used to sync responses
columnsColumnsColumn metadata collection
startintPaging offset
lengthintRequested page size
search?SearchGlobal search payload
orderOrder[]Sort instructions

Nested DTOs

Columns

Methods:

MethodDescription
getColumnByName(string $name): ?ColumnResolve a column by configured name
getColumnByIndex(int $index): ?ColumnResolve a column by DataTables index

Column

Fields:

FieldTypeDescription
datamixedData key/path used by DataTables
namestringLogical column name
searchableboolWhether the column can be searched
orderableboolWhether the column can be ordered
search?SearchPer-column search payload
columnControl?ColumnControlAdvanced filter payload from Column Control

Order

Fields:

FieldTypeDescription
columnintColumn index to sort
dirstringSort direction (asc or desc)
namestringColumn name used for sorting

Fields:

FieldTypeDescription
value?stringSearch input value
regexboolWhether regex mode is requested

ColumnControl / ColumnControlSearch

Used when Column Control extension sends advanced column filters:

DTOShapeDescription
ColumnControlsearch: ?ColumnControlSearch, list: arrayColumn-level filter payload
ColumnControlSearchvalue: string, logic: string, type: stringSearch constraint details