Overview

Namespaces

  • None
  • Yajra
    • Datatables
      • Contracts
      • Engines
      • Facades
      • Generators
      • Html
      • Processors
      • Services
      • Transformers

Classes

  • BaseEngine
  • CollectionEngine
  • EloquentEngine
  • QueryBuilderEngine
  • Overview
  • Namespace
  • Class

Class BaseEngine

Class BaseEngine.

Yajra\Datatables\Engines\BaseEngine implements Yajra\Datatables\Contracts\DataTableEngineContract

Direct known subclasses

Yajra\Datatables\Engines\CollectionEngine, Yajra\Datatables\Engines\QueryBuilderEngine

Indirect known subclasses

Yajra\Datatables\Engines\EloquentEngine
Abstract
Namespace: Yajra\Datatables\Engines
Package: Yajra\Datatables\Engines
Author: Arjay Angeles aqangeles@gmail.com
Located at Engines/BaseEngine.php
.

Sets DT_RowClass template. result:

.

Parameters

$content

Returns


$this
.

Sets DT_RowId template. result:

.

Parameters

$content

Returns


$this
.

Set DT_RowAttr templates. result:

.

Parameters

$data

Returns


$this
Methods summary
public string
# setupKeyword( string $value )

Setup search keyword.

Setup search keyword.

Parameters

$value

Returns

string
protected boolean
# isSmartSearch( )

Check if DataTables uses smart search.

Check if DataTables uses smart search.

Returns

boolean
public boolean
# isWildcard( )

Get config use wild card status.

Get config use wild card status.

Returns

boolean
public string
# wildcardLikeString( string $str, boolean $lowercase = true )

Adds % wildcards to the given string.

Adds % wildcards to the given string.

Parameters

$str
$lowercase

Returns

string
public string
# prefixColumn( string $column )

Will prefix column if needed.

Will prefix column if needed.

Parameters

$column

Returns

string
public array
# tableNames( )

Will look through the query and all it's joins to determine the table names.

Will look through the query and all it's joins to determine the table names.

Returns

array
public mixed
# getQueryBuilder( mixed $instance = null )

Get Query Builder object.

Get Query Builder object.

Parameters

$instance

Returns

mixed
public boolean
# isQueryBuilder( )

Check query type is a builder.

Check query type is a builder.

Returns

boolean
public
# addColumn( string $name, string|callable $content, boolean|integer $order = false )

Add column in collection.

Add column in collection.

Parameters

$name
$content
$order

Returns


$this
public
# addIndexColumn( )

Add DT row index column on response.

Add DT row index column on response.

Returns


$this
public
# editColumn( string $name, string|callable $content )

Edit column's content.

Edit column's content.

Parameters

$name
$content

Returns


$this
public
# removeColumn( )

Remove column from collection.

Remove column from collection.

Returns


$this
public
# escapeColumns( string|array $columns = '*' )

Declare columns to escape values.

Declare columns to escape values.

Parameters

$columns

Returns


$this
public
# withTrashed( boolean $withTrashed = true )

Change withTrashed flag value.

Change withTrashed flag value.

Parameters

$withTrashed

Returns


$this
public mixed
# __call( string $name, array $arguments )

Allows previous API calls where the methods were snake_case. Will convert a camelCase API call to a snake_case call. Allow query builder method to be used by the engine.

Allows previous API calls where the methods were snake_case. Will convert a camelCase API call to a snake_case call. Allow query builder method to be used by the engine.

Parameters

$name
$arguments

Returns

mixed
public
# setRowClass( string|callable $content )

Sets DT_RowClass template. result:

public
# setRowId( string|callable $content )

Sets DT_RowId template. result:

public
# setRowData( array $data )

Set DT_RowData templates.

Set DT_RowData templates.

Parameters

$data

Returns


$this
public
# addRowData( string $key, string|callable $value )

Add DT_RowData template.

Add DT_RowData template.

Parameters

$key
$value

Returns


$this
public
# setRowAttr( array $data )

Set DT_RowAttr templates. result:

public
# addRowAttr( string $key, string|callable $value )

Add DT_RowAttr template.

Add DT_RowAttr template.

Parameters

$key
$value

Returns


$this
public
# filterColumn( string $column, string|Closure $method )

Override default column filter search.

Override default column filter search.

Parameters

$column
$method

Returns


$this
public
# orderColumns( array $columns, string $sql, array $bindings = [] )

Order each given columns versus the given custom sql.

Order each given columns versus the given custom sql.

Parameters

$columns
$sql
$bindings

Returns


$this
public
# orderColumn( string $column, string $sql, array $bindings = [] )

Override default column ordering.

Override default column ordering.

Parameters

$column
$sql
$bindings

Returns


$this
public
# setTransformer( League\Fractal\TransformerAbstract $transformer )

Set data output transformer.

Set data output transformer.

Parameters

$transformer

Returns


$this
public
# setSerializer( string $serializer )

Set fractal serializer class.

Set fractal serializer class.

Parameters

$serializer

Returns


$this
public Illuminate\Http\JsonResponse
# make( boolean $mDataSupport = false, boolean $orderFirst = false )

Organizes works.

Organizes works.

Parameters

$mDataSupport
$orderFirst

Returns

Illuminate\Http\JsonResponse

Implementation of

Yajra\Datatables\Contracts\DataTableEngineContract::make()
public
# orderRecords( boolean $skip )

Sort records.

Sort records.

Parameters

$skip
public
# filterRecords( )

Perform necessary filters.

Perform necessary filters.
public
# paginate( )

Apply pagination.

Apply pagination.
public Illuminate\Http\JsonResponse
# render( boolean $object = false )

Render json response.

Render json response.

Parameters

$object

Returns

Illuminate\Http\JsonResponse
protected League\Fractal\TransformerAbstract
# createTransformer( )

Get or create transformer instance.

Get or create transformer instance.

Returns

League\Fractal\TransformerAbstract
public boolean
# isDebugging( )

Check if app is in debug mode.

Check if app is in debug mode.

Returns

boolean
public array
# showDebugger( array $output )

Append debug parameters on output.

Append debug parameters on output.

Parameters

$output

Returns

array
public
# overrideGlobalSearch( Closure $callback, mixed $parameters, boolean $autoFilter = false )

Update flags to disable global search

Update flags to disable global search

Parameters

$callback
$parameters
$autoFilter
public boolean
# isCaseInsensitive( )

Get config is case insensitive status.

Get config is case insensitive status.

Returns

boolean
public
# with( mixed $key, mixed $value = '' )

Append data on json response.

Append data on json response.

Parameters

$key
$value

Returns


$this
public
# order( Closure $closure )

Override default ordering method with a closure callback.

Override default ordering method with a closure callback.

Parameters

$closure

Returns


$this
public
# blacklist( array $blacklist )

Update list of columns that is not allowed for search/sort.

Update list of columns that is not allowed for search/sort.

Parameters

$blacklist

Returns


$this
public
# whitelist( string|array $whitelist = '*' )

Update list of columns that is not allowed for search/sort.

Update list of columns that is not allowed for search/sort.

Parameters

$whitelist

Returns


$this
public
# smart( boolean $bool = true )

Set smart search config at runtime.

Set smart search config at runtime.

Parameters

$bool

Returns


$this
public
# setTotalRecords( integer $total )

Set total records manually.

Set total records manually.

Parameters

$total

Returns


$this
public
# skipPaging( )

Skip pagination as needed.

Skip pagination as needed.
protected boolean
# isBlacklisted( string $column )

Check if column is blacklisted.

Check if column is blacklisted.

Parameters

$column

Returns

boolean
protected string
# getColumnName( integer $index, boolean $wantsAlias = false )

Get column name to be use for filtering and sorting.

Get column name to be use for filtering and sorting.

Parameters

$index
$wantsAlias

Returns

string
protected mixed
# getColumnNameByIndex( integer $index )

Get column name by order column index.

Get column name by order column index.

Parameters

$index

Returns

mixed
protected string
# getPrimaryKeyName( )

If column name could not be resolved then use primary key.

If column name could not be resolved then use primary key.

Returns

string
protected boolean
# isEloquent( )

Check if the engine used was eloquent.

Check if the engine used was eloquent.

Returns

boolean
protected string
# extractColumnName( string $str, boolean $wantsAlias )

Get column name from string.

Get column name from string.

Parameters

$str
$wantsAlias

Returns

string
protected boolean
# isOracleSql( )

Check if the current sql language is based on oracle syntax.

Check if the current sql language is based on oracle syntax.

Returns

boolean
Methods inherited from Yajra\Datatables\Contracts\DataTableEngineContract
columnSearch(), count(), filter(), filtering(), ordering(), paging(), results(), totalCount()
Properties summary
public Yajra\Datatables\Request $request

Datatables Request object.

Datatables Request object.
#
protected Illuminate\Database\Connection $connection

Database connection used.

Database connection used.
#
protected Illuminate\Database\Query\Builder|Illuminate\Database\Eloquent\Builder $query

Builder object.

Builder object.
#
protected Illuminate\Database\Query\Builder $builder

Query builder object.

Query builder object.
#
protected array $columns

Array of result columns/fields.

Array of result columns/fields.
# []
protected array $columnDef

DT columns definitions container (add/edit/remove/filter/order/escape).

DT columns definitions container (add/edit/remove/filter/order/escape).
# [ 'index' => false, 'append' => [], 'edit' => [], 'excess' => ['rn', 'row_num'], 'filter' => [], 'order' => [], 'escape' => [], 'blacklist' => ['password', 'remember_token'], 'whitelist' => '*', ]
protected string $query_type

Query type.

Query type.
#
protected array $extraColumns

Extra/Added columns.

Extra/Added columns.
# []
protected integer $totalRecords

Total records.

Total records.
# 0
protected integer $filteredRecords

Total filtered records.

Total filtered records.
# 0
protected boolean $autoFilter

Auto-filter flag.

Auto-filter flag.
# true
protected boolean $withTrashed

Select trashed records in count function for models with soft deletes trait. By default we do not select soft deleted records

Select trashed records in count function for models with soft deletes trait. By default we do not select soft deleted records
# false
protected Closure $filterCallback

Callback to override global search.

Callback to override global search.
#
protected mixed $filterCallbackParameters

Parameters to passed on filterCallback.

Parameters to passed on filterCallback.
#
protected array $templates

DT row templates container.

DT row templates container.
# [ 'DT_RowId' => '', 'DT_RowClass' => '', 'DT_RowData' => [], 'DT_RowAttr' => [], ]
protected League\Fractal\TransformerAbstract $transformer

Output transformer.

Output transformer.
# null
protected string $prefix

Database prefix

Database prefix
#
protected string $database

Database driver used.

Database driver used.
#
protected boolean $isFilterApplied

[internal] Track if any filter was applied for at least one column

[internal] Track if any filter was applied for at least one column
# false
protected string|null $serializer

Fractal serializer class.

Fractal serializer class.
# null
protected Closure $orderCallback

Custom ordering callback.

Custom ordering callback.
#
protected boolean $skipPaging

Skip paginate as needed.

Skip paginate as needed.
# false
API documentation generated by ApiGen