Overview

Namespaces

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

Classes

  • Builder
  • Column
  • Parameters
  • Overview
  • Namespace
  • Class

Class Builder

Class Builder.

Namespace: Yajra\Datatables\Html
Package: Yajra\Datatables\Html
Author: Arjay Angeles aqangeles@gmail.com
Located at Html/Builder.php
Methods summary
public
# __construct( Illuminate\Contracts\Config\Repository $config, Illuminate\Contracts\View\Factory $view, Collective\Html\HtmlBuilder $html, Illuminate\Routing\UrlGenerator $url, Collective\Html\FormBuilder $form )

Parameters

$config
$view
$html
$url
$form
public string
# scripts( null $script = null, array $attributes = ['type' => 'text/javascript'] )

Generate DataTable javascript.

Generate DataTable javascript.

Parameters

$script
$attributes

Returns

string
public string
# generateScripts( )

Get generated raw scripts.

Get generated raw scripts.

Returns

string
public string
# parameterize( array $attributes = [] )

Generate DataTables js parameters.

Generate DataTables js parameters.

Parameters

$attributes

Returns

string
protected mixed
# encodeAjaxDataFunction( array $parameters )

Encode ajax data function param.

Encode ajax data function param.

Parameters

$parameters

Returns

mixed
protected array
# encodeColumnFunctions( array $parameters )

Encode columns render function.

Encode columns render function.

Parameters

$parameters

Returns

array
protected array
# encodeCallbackFunctions( array $parameters )

Encode DataTables callbacks function.

Encode DataTables callbacks function.

Parameters

$parameters

Returns

array
protected string
# decodeAjaxDataFunction( string $function, string $json )

Decode ajax data method.

Decode ajax data method.

Parameters

$function
$json

Returns

string
protected string
# decodeColumnFunctions( array $columnFunctions, string $json )

Decode columns render functions.

Decode columns render functions.

Parameters

$columnFunctions
$json

Returns

string
protected string
# decodeCallbackFunctions( array $callbackFunctions, string $json )

Decode DataTables callbacks function.

Decode DataTables callbacks function.

Parameters

$callbackFunctions
$json

Returns

string
protected string
# template( )

Get javascript template to use.

Get javascript template to use.

Returns

string
public
# setTableAttribute( string|array $attribute, mixed $value = null )

Sets HTML table attribute(s).

Sets HTML table attribute(s).

Parameters

$attribute
$value

Returns


$this
public
# setTableAttributes( array $attributes )

Sets multiple HTML table attributes at once.

Sets multiple HTML table attributes at once.

Parameters

$attributes

Returns


$this
public mixed
# getTableAttribute( string $attribute )

Retrieves HTML table attribute value.

Retrieves HTML table attribute value.

Parameters

$attribute

Returns

mixed

Throws

Exception
public
# addColumn( array $attributes )

Add a column in collection using attributes.

Add a column in collection using attributes.

Parameters

$attributes

Returns


$this
public
# add( Yajra\Datatables\Html\Column $column )

Add a Column object in collection.

Add a Column object in collection.

Parameters

$column

Returns


$this
public
# columns( array $columns )

Set datatables columns from array definition.

Set datatables columns from array definition.

Parameters

$columns

Returns


$this
public array
# setTitle( string $title, array $attributes )

Set title attribute of an array if not set.

Set title attribute of an array if not set.

Parameters

$title
$attributes

Returns

array
public string
# getQualifiedTitle( string $title )

Convert string into a readable title.

Convert string into a readable title.

Parameters

$title

Returns

string
public
# addCheckbox( array $attributes = [] )

Add a checkbox column.

Add a checkbox column.

Parameters

$attributes

Returns


$this
public
# addAction( array $attributes = [] )

Add a action column.

Add a action column.

Parameters

$attributes

Returns


$this
public
# addIndex( array $attributes = [] )

Add a index column.

Add a index column.

Parameters

$attributes

Returns


$this
public
# ajax( string|array $attributes )

Setup ajax parameter

Setup ajax parameter

Parameters

$attributes

Returns


$this
public string
# table( array $attributes = [], boolean $drawFooter = false )

Generate DataTable's table html.

Generate DataTable's table html.

Parameters

$attributes
$drawFooter

Returns

string
public
# parameters( array $attributes = [] )

Configure DataTable's parameters.

Configure DataTable's parameters.

Parameters

$attributes

Returns


$this
public
# setTemplate( string $template )

Set custom javascript template.

Set custom javascript template.

Parameters

$template

Returns


$this
public Illuminate\Support\Collection
# getColumns( )

Get collection of columns.

Get collection of columns.

Returns

Illuminate\Support\Collection
Properties summary
public Illuminate\Support\Collection $collection
#
public Illuminate\Contracts\Config\Repository $config
#
public Illuminate\Contracts\View\Factory $view
#
public Collective\Html\HtmlBuilder $html
#
public Illuminate\Routing\UrlGenerator $url
#
public Collective\Html\FormBuilder $form
#
protected string|array $ajax
# ''
protected array $tableAttributes
# ['class' => 'table', 'id' => 'dataTableBuilder']
protected string $template
# ''
protected array $attributes
# []
protected array $validCallbacks

Lists of valid DataTables Callbacks.

Lists of valid DataTables Callbacks.

Link

https://datatables.net/reference/option/.
# [ 'createdRow', 'drawCallback', 'footerCallback', 'formatNumber', 'headerCallback', 'infoCallback', 'initComplete', 'preDrawCallback', 'rowCallback', 'stateLoadCallback', 'stateLoaded', 'stateLoadParams', 'stateSaveCallback', 'stateSaveParams', ]
API documentation generated by ApiGen