Overview

Namespaces

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

Classes

  • DataTable
  • Overview
  • Namespace
  • Class

Class DataTable

Class DataTable.

Yajra\Datatables\Services\DataTable implements Yajra\Datatables\Contracts\DataTableContract, Yajra\Datatables\Contracts\DataTableButtonsContract
Abstract
Namespace: Yajra\Datatables\Services
Package: Yajra\Datatables\Services
Author: Arjay Angeles aqangeles@gmail.com
Located at Services/DataTable.php
Methods summary
public
# __construct( Yajra\Datatables\Datatables $datatables, Illuminate\Contracts\View\Factory $viewFactory )

DataTable constructor.

DataTable constructor.

Parameters

$datatables
$viewFactory
public Illuminate\Http\JsonResponse|Illuminate\View\View
# render( string $view, array $data = [], array $mergeData = [] )

Process dataTables needed render output.

Process dataTables needed render output.

Parameters

$view
$data
$mergeData

Returns

Illuminate\Http\JsonResponse|Illuminate\View\View

Implementation of

Yajra\Datatables\Contracts\DataTableContract::render()
public Yajra\Datatables\Request
# request( )

Get Datatables Request instance.

Get Datatables Request instance.

Returns

Yajra\Datatables\Request

Implementation of

Yajra\Datatables\Contracts\DataTableContract::request()
public Illuminate\Contracts\View\View
# printPreview( )

Display printable view of datatables.

Display printable view of datatables.

Returns

Illuminate\Contracts\View\View

Implementation of

Yajra\Datatables\Contracts\DataTableButtonsContract::printPreview()
protected array
# getDataForPrint( )

Get mapped columns versus final decorated output.

Get mapped columns versus final decorated output.

Returns

array
protected array|string
# printColumns( )

Get printable columns.

Get printable columns.

Returns

array|string
protected array
# getColumnsFromBuilder( )

Get columns definition from html builder.

Get columns definition from html builder.

Returns

array
public Yajra\Datatables\Html\Builder
# html( )

Optional method if you want to use html builder.

Optional method if you want to use html builder.

Returns

Yajra\Datatables\Html\Builder

Implementation of

Yajra\Datatables\Contracts\DataTableContract::html()
public Yajra\Datatables\Html\Builder
# builder( )

Get Datatables Html Builder instance.

Get Datatables Html Builder instance.

Returns

Yajra\Datatables\Html\Builder

Implementation of

Yajra\Datatables\Contracts\DataTableContract::builder()
protected array
# mapResponseToColumns( mixed $columns, string $type )

Map ajax response to columns definition.

Map ajax response to columns definition.

Parameters

$columns
$type

Returns

array
protected array
# getAjaxResponseData( )

Get decorated data as defined in datatables ajax response.

Get decorated data as defined in datatables ajax response.

Returns

array
public
# excel( )

Export results to Excel file.

Export results to Excel file.

Implementation of

Yajra\Datatables\Contracts\DataTableButtonsContract::excel()
protected Maatwebsite\Excel\Writers\LaravelExcelWriter
# buildExcelFile( )

Build excel file and prepare for export.

Build excel file and prepare for export.

Returns

Maatwebsite\Excel\Writers\LaravelExcelWriter
public string
# getFilename( )

Get export filename.

Get export filename.

Returns

string
public Yajra\Datatables\Services\DataTable
# setFilename( string $filename )

Set export filename.

Set export filename.

Parameters

$filename

Returns

Yajra\Datatables\Services\DataTable
protected string
# filename( )

Get filename for export.

Get filename for export.

Returns

string
protected array
# getDataForExport( )

Get mapped columns versus final decorated output.

Get mapped columns versus final decorated output.

Returns

array
public
# csv( )

Export results to CSV file.

Export results to CSV file.

Implementation of

Yajra\Datatables\Contracts\DataTableButtonsContract::csv()
public mixed
# pdf( )

Export results to PDF file.

Export results to PDF file.

Returns

mixed

Implementation of

Yajra\Datatables\Contracts\DataTableButtonsContract::pdf()
public mixed
# snappyPdf( )

PDF version of the table using print preview blade template.

PDF version of the table using print preview blade template.

Returns

mixed
public
# addScope( Yajra\Datatables\Contracts\DataTableScopeContract $scope )

Add basic array query scopes.

Add basic array query scopes.

Parameters

$scope

Returns


$this
protected mixed
# applyScopes( Illuminate\Database\Query\Builder|Illuminate\Database\Eloquent\Builder $query )

Apply query scopes.

Apply query scopes.

Parameters

$query

Returns

mixed
protected array
# getBuilderParameters( )

Get default builder parameters.

Get default builder parameters.

Returns

array
Methods inherited from Yajra\Datatables\Contracts\DataTableContract
ajax(), query()
Properties summary
protected Yajra\Datatables\Datatables $datatables
#
protected Illuminate\Contracts\View\Factory $viewFactory
#
protected string $printPreview

Datatables print preview view.

Datatables print preview view.

# 'datatables::print'
protected string|array $exportColumns

List of columns to be exported.

List of columns to be exported.

# '*'
protected string|array $printColumns

List of columns to be printed.

List of columns to be printed.

# '*'
protected Yajra\Datatables\Contracts\DataTableScopeContract[] $scopes

Query scopes.

Query scopes.

# []
protected Yajra\Datatables\Html\Builder $htmlBuilder

Html builder.

Html builder.

#
protected string $filename

Export filename.

Export filename.

# ''
API documentation generated by ApiGen