• Главная
• Yajra
• Datatables
• Engines
• BaseEngine

PHP Класс Yajra\Datatables\Engines\BaseEngine

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$request	Yajra\Datatables\Request	Datatables Request object.

Защищенные свойства (Protected)

Свойство	Тип	Описание
$appends	array	Array of data to append on json response.
$autoFilter	boolean	Auto-filter flag.
$builder	Illuminate\Database\Query\Builder	Query builder object.
$columnDef	array	DT columns definitions container (add/edit/remove/filter/order/escape).
$columns	array	Array of result columns/fields.
$connection	Illuminate\Database\Connection	Database connection used.
$database	string	Database driver used.
$extraColumns	array	Extra/Added columns.
$filterCallback	callable	Callback to override global search.
$filterCallbackParameters	mixed	Parameters to passed on filterCallback.
$filteredRecords	integer	Total filtered records.
$isFilterApplied	boolean	[internal] Track if any filter was applied for at least one column
$nullsLast	boolean	Flag for ordering NULLS LAST option.
$orderCallback	callable	Custom ordering callback.
$prefix	string	Database prefix
$query	Illuminate\Database\Query\Builder | Illuminate\Database\Eloquent\Builder	Builder object.
$query_type	string	Query type.
$serializer	string | null	Fractal serializer class.
$skipPaging	boolean	Skip paginate as needed.
$templates	array	DT row templates container.
$totalRecords	integer	Total records.
$transformer	League\Fractal\TransformerAbstract	Output transformer.
$withTrashed	boolean	By default we do not select soft deleted records

Открытые методы

Метод	Описание
__call ( string $name, array $arguments ) : mixed	Allows previous API calls where the methods were snake_case.
addColumn ( string $name, string | callable $content, boolean | integer $order = false )	Add column in collection.
addIndexColumn ( )	Add DT row index column on response.
addRowAttr ( string $key, string | callable $value )	Add DT_RowAttr template.
addRowData ( string $key, string | callable $value )	Add DT_RowData template.
blacklist ( array $blacklist )	Update list of columns that is not allowed for search/sort.
editColumn ( string $name, string | callable $content )	Edit column's content.
escapeColumns ( string | array $columns = '*' )	Declare columns to escape values.
filterColumn ( string $column, string | callable $method )	Override default column filter search.
getQueryBuilder ( mixed $instance = null ) : mixed	Get Query Builder object.
isCaseInsensitive ( ) : boolean	Get config is case insensitive status.
isDebugging ( ) : boolean	Check if app is in debug mode.
isEloquent ( ) : boolean	Check if the engine used was eloquent.
isOracleSql ( ) : boolean	Check if the current sql language is based on oracle syntax.
isQueryBuilder ( ) : boolean	Check query type is a builder.
isSmartSearch ( ) : boolean	Check if DataTables uses smart search.
isWildcard ( ) : boolean	Get config use wild card status.
make ( boolean $mDataSupport = false, boolean $orderFirst = false ) : Illuminate\Http\JsonResponse	Organizes works.
order ( callable $closure )	Override default ordering method with a closure callback.
orderByNullsLast ( )	Set datatables to do ordering with NULLS LAST option.
orderColumn ( string $column, string $sql, array $bindings = [] )	Override default column ordering.
orderColumns ( array $columns, string $sql, array $bindings = [] )	Order each given columns versus the given custom sql.
removeColumn ( )	Remove column from collection.
setRowAttr ( array $data )	Set DT_RowAttr templates.
setRowClass ( string | callable $content )	Sets DT_RowClass template.
setRowData ( array $data )	Set DT_RowData templates.
setRowId ( string | callable $content )	Sets DT_RowId template.
setSerializer ( string $serializer )	Set fractal serializer class.
setTotalRecords ( integer $total )	Set total records manually.
setTransformer ( League\Fractal\TransformerAbstract $transformer )	Set data output transformer.
skipPaging ( )	Skip pagination as needed.
smart ( boolean $bool = true )	Set smart search config at runtime.
whitelist ( string | array $whitelist = '*' )	Update list of columns that is not allowed for search/sort.
with ( mixed $key, mixed $value = '' )	Append data on json response.
withTrashed ( boolean $withTrashed = true )	Change withTrashed flag value.

Защищенные методы

Метод	Описание
createSerializer ( ) : League\Fractal\Serializer\SerializerAbstract	Get or create transformer serializer instance.
createTransformer ( ) : League\Fractal\TransformerAbstract	Get or create transformer instance.
extractColumnName ( string $str, boolean $wantsAlias ) : string	Get column name from string.
filterRecords ( ) : void	Perform necessary filters.
getColumnName ( integer $index, boolean $wantsAlias = false ) : string	Get column name to be use for filtering and sorting.
getColumnNameByIndex ( integer $index ) : mixed	Get column name by order column index.
getPrimaryKeyName ( ) : string	If column name could not be resolved then use primary key.
getProcessedData ( boolean | false $object = false ) : array	Get processed data
isBlacklisted ( string $column ) : boolean	Check if column is blacklisted.
orderRecords ( boolean $skip ) : void	Sort records.
overrideGlobalSearch ( callable $callback, mixed $parameters, boolean $autoFilter = false )	Update flags to disable global search
paginate ( ) : void	Apply pagination.
render ( boolean $object = false ) : Illuminate\Http\JsonResponse	Render json response.
setupKeyword ( string $value ) : string	Setup search keyword.
showDebugger ( array $output ) : array	Append debug parameters on output.
wildcardLikeString ( string $str, boolean $lowercase = true ) : string	Adds % wildcards to the given string.

Описание методов

Описание свойств