Data Structures
class	DataTable
	DataTable widget for displaying list of objects. More...

class	JsonDataTable

class	Pagination

class	PositionInTable

Functions
	addField ($field, $key=null)

	insertField ($index, $field, $key=null)

	insertInField ($index, $field, $key=null)

	fieldAs ($index, $type, $attributes=NULL)

	cleanIdentifier ($id)

	_fieldAs ($elementCallback, &$index, $attributes=NULL, $prefix=null)

	getFieldButtonCallable ($caption, $visibleHover=true, $callback=null)

	getCallable ($thisCallback, $parameters, $callback=null)

	getFieldButton ($caption, $visibleHover=true, $icon=null)

	getFieldButtons ($buttons, $visibleHover=true)

	fieldAsSubmit ($index, $cssStyle=NULL, $url=NULL, $responseElement=NULL, $attributes=NULL)
	Creates a submit button at $index position. More...

	_visibleOver (BaseHtml $element)

	addFieldButton ($caption, $visibleHover=true, $callback=null)
	Inserts a new Button for each row. More...

	addFieldButtons ($buttons, $visibleHover=true, $callback=null)
	Inserts a new ButtonGroups for each row. More...

	insertFieldButton ($index, $caption, $visibleHover=true, $callback=null)
	Inserts a new Button for each row at col $index. More...

	insertInFieldButton ($index, $caption, $visibleHover=true, $callback=null, $key=null)
	Inserts a new Button for each row in col at $index. More...

	addDefaultButton ($icon, $class=null, $visibleHover=true, $callback=null, $key=null)

	insertDefaultButtonIn ($index, $icon, $class=null, $visibleHover=true, $callback=null, $key=null)

	getDefaultButton ($icon, $class=null, $visibleHover=true)

	addDeleteButton ($visibleHover=true, $deleteBehavior=[], $callback=null)
	Adds a delete button. More...

	addEditButton ($visibleHover=true, $editBehavior=[], $callback=null)
	Adds an edit button. More...

	addDisplayButton ($visibleHover=true, $displayBehavior=[], $callback=null)
	Adds a button for displaying an object. More...

	addEditDeleteButtons ($visibleHover=true, $behavior=[], $callbackEdit=null, $callbackDelete=null)
	Adds an edit and a delete button. More...

	addAllButtons ($visibleHover=true, $behavior=[], $callbackDisplay=null, $callbackEdit=null, $callbackDelete=null)
	Adds an edit and a delete button. More...

	insertDeleteButtonIn ($index, $visibleHover=true, $deleteBehavior=[], $callback=null)

	insertEditButtonIn ($index, $visibleHover=true, $editBehavior=[], $callback=null)

	insertDisplayButtonIn ($index, $visibleHover=true, $displayBehavior=[], $callback=null)

	getButtonsColumn ()

	setButtons ($_buttons)

	getButtons ()

	addInToolbar ($element, $callback=NULL)

	_runCheckboxes (JsUtils $js)

	_getCheckedChange (JsUtils $js=NULL)

	_getCheckedMessageFunction ()

	_getCheckedMessageCall (JsUtils $js=NULL)

	_generateMainCheckbox (&$captions)

	_setAllChecked ($checked)

	getHasCheckboxes ()

	setHasCheckboxes ($_hasCheckboxes)

	getCheckedMessage ()

	setCheckedMessage (array $_checkedMessage)
	Defines the message displayed when checkboxes are checked or unchecked with an associative array 0=>no selection,1=>one item selected, other=>{count} items selected. More...

	addCountCheckedInToolbar (array $checkedMessage=null, $callback=null)

	setCheckedClass ($_checkedClass)

	setCheckedCallback ($checkedCallback)
	Set the callback function that determines whether the checkbox should be checked for an object. More...

Variables
trait	DataTableFieldAsTrait

	$_buttonsColumn

trait	HasCheckboxesTrait

	$_hasCheckedMessage =false

	$_checkedMessage

	$_checkedClass

	$_checkedCallback

Function Documentation

◆ _fieldAs()

Ajax\semantic\widgets\datatable\_fieldAs	(		$elementCallback,
		&	$index,
			$attributes = `NULL`,
			$prefix = `null`
	)

abstractprotected

Definition at line 94 of file FieldAsTrait.php.

◆ _generateMainCheckbox()

Ajax\semantic\widgets\datatable\_generateMainCheckbox ( & $captions )

protected

Definition at line 61 of file HasCheckboxesTrait.php.

◆ _getCheckedChange()

Ajax\semantic\widgets\datatable\_getCheckedChange ( JsUtils $js = NULL )

protected

Definition at line 31 of file HasCheckboxesTrait.php.

◆ _getCheckedMessageCall()

Ajax\semantic\widgets\datatable\_getCheckedMessageCall ( JsUtils $js = NULL )

protected

Definition at line 48 of file HasCheckboxesTrait.php.

◆ _getCheckedMessageFunction()

Ajax\semantic\widgets\datatable\_getCheckedMessageFunction ( )

protected

Definition at line 38 of file HasCheckboxesTrait.php.

◆ _runCheckboxes()

Ajax\semantic\widgets\datatable\_runCheckboxes ( JsUtils $js )

protected

Definition at line 24 of file HasCheckboxesTrait.php.

◆ _setAllChecked()

Ajax\semantic\widgets\datatable\_setAllChecked ( $checked )

protected

Definition at line 72 of file HasCheckboxesTrait.php.

◆ _visibleOver()

Ajax\semantic\widgets\datatable\_visibleOver ( BaseHtml $element )

protected

Definition at line 102 of file DataTableFieldAsTrait.php.

◆ addAllButtons()

Ajax\semantic\widgets\datatable\addAllButtons	(	$visibleHover = `true`,
		$behavior = `[]`,
		$callbackDisplay = `null`,
		$callbackEdit = `null`,
		$callbackDelete = `null`
	)

Adds an edit and a delete button.

Parameters

boolean	$visibleHover
array	$behavior	default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
callable	$callbackDisplay	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
callable	$callbackEdit	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
callable	$callbackDelete	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object

Returns: DataTable

Definition at line 233 of file DataTableFieldAsTrait.php.

◆ addCountCheckedInToolbar()

Ajax\semantic\widgets\datatable\addCountCheckedInToolbar	(	array	$checkedMessage = `null`,
			$callback = `null`
	)

Parameters

array	$checkedMessage
callable	$callback

Definition at line 112 of file HasCheckboxesTrait.php.

◆ addDefaultButton()

Ajax\semantic\widgets\datatable\addDefaultButton	(	$icon,
		$class = `null`,
		$visibleHover = `true`,
		$callback = `null`,
		$key = `null`
	)

Definition at line 155 of file DataTableFieldAsTrait.php.

◆ addDeleteButton()

Ajax\semantic\widgets\datatable\addDeleteButton	(	$visibleHover = `true`,
		$deleteBehavior = `[]`,
		$callback = `null`
	)

Adds a delete button.

Parameters

boolean	$visibleHover
array	$deleteBehavior	default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
callable	$callback	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object

Returns: DataTable

Definition at line 180 of file DataTableFieldAsTrait.php.

◆ addDisplayButton()

Ajax\semantic\widgets\datatable\addDisplayButton	(	$visibleHover = `true`,
		$displayBehavior = `[]`,
		$callback = `null`
	)

Adds a button for displaying an object.

Parameters

boolean	$visibleHover
array	$displayBehavior	default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
callable	$callback	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object

Returns: DataTable

Definition at line 204 of file DataTableFieldAsTrait.php.

◆ addEditButton()

Ajax\semantic\widgets\datatable\addEditButton	(	$visibleHover = `true`,
		$editBehavior = `[]`,
		$callback = `null`
	)

Adds an edit button.

Parameters

boolean	$visibleHover
array	$editBehavior	default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
callable	$callback	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object

Returns: DataTable

Definition at line 192 of file DataTableFieldAsTrait.php.

◆ addEditDeleteButtons()

Ajax\semantic\widgets\datatable\addEditDeleteButtons	(	$visibleHover = `true`,
		$behavior = `[]`,
		$callbackEdit = `null`,
		$callbackDelete = `null`
	)

Adds an edit and a delete button.

Parameters

boolean	$visibleHover
array	$behavior	default : array("preventDefault"=>true,"stopPropagation"=>true,"jsCallback"=>NULL,"attr"=>"data-ajax","params"=>"{}","method"=>"get")
callable	$callbackEdit	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object
callable	$callbackDelete	this function takes the following arguments : $object=>the delete button, $instance : the active instance of the object

Returns: DataTable

Definition at line 217 of file DataTableFieldAsTrait.php.

◆ addField()

Ajax\semantic\widgets\datatable\addField	(	$field,
		$key = `null`
	)

abstract

◆ addFieldButton()

Ajax\semantic\widgets\datatable\addFieldButton	(	$caption,
		$visibleHover = `true`,
		$callback = `null`
	)

Inserts a new Button for each row.

Parameters

string	$caption
callable	$callback
boolean	$visibleHover

Returns: DataTable

Definition at line 114 of file DataTableFieldAsTrait.php.

◆ addFieldButtons()

Ajax\semantic\widgets\datatable\addFieldButtons	(	$buttons,
		$visibleHover = `true`,
		$callback = `null`
	)

Inserts a new ButtonGroups for each row.

Parameters

array	$buttons
callable	$callback
boolean	$visibleHover

Returns: DataTable

Definition at line 126 of file DataTableFieldAsTrait.php.

◆ addInToolbar()

Ajax\semantic\widgets\datatable\addInToolbar	(	$element,
		$callback = `NULL`
	)

abstract

◆ cleanIdentifier()

Ajax\semantic\widgets\datatable\cleanIdentifier ( $id )

abstractprotected

◆ fieldAs()

Ajax\semantic\widgets\datatable\fieldAs	(	$index,
		$type,
		$attributes = `NULL`
	)

abstract

Definition at line 349 of file FieldAsTrait.php.

◆ fieldAsSubmit()

Ajax\semantic\widgets\datatable\fieldAsSubmit	(	$index,
		$cssStyle = `NULL`,
		$url = `NULL`,
		$responseElement = `NULL`,
		$attributes = `NULL`
	)

Creates a submit button at $index position.

Parameters

int	$index
string	$cssStyle
string	$url
string	$responseElement
array	$attributes	associative array (ajax key is for ajax post)

Returns: DataTable

Definition at line 92 of file DataTableFieldAsTrait.php.

◆ getButtons()

Ajax\semantic\widgets\datatable\getButtons ( )

Returns: string[]

Definition at line 275 of file DataTableFieldAsTrait.php.

◆ getButtonsColumn()

Ajax\semantic\widgets\datatable\getButtonsColumn ( )

Returns: mixed

Definition at line 260 of file DataTableFieldAsTrait.php.

◆ getCallable()

Ajax\semantic\widgets\datatable\getCallable	(	$thisCallback,
		$parameters,
		$callback = `null`
	)

private

Parameters

callable	$thisCallback
array	$parameters
callable	$callback

Returns: callable

Definition at line 43 of file DataTableFieldAsTrait.php.

◆ getCheckedMessage()

Ajax\semantic\widgets\datatable\getCheckedMessage ( )

protected

Definition at line 89 of file HasCheckboxesTrait.php.

◆ getDefaultButton()

Ajax\semantic\widgets\datatable\getDefaultButton	(	$icon,
		$class = `null`,
		$visibleHover = `true`
	)

private

Definition at line 165 of file DataTableFieldAsTrait.php.

◆ getFieldButton()

Ajax\semantic\widgets\datatable\getFieldButton	(	$caption,
		$visibleHover = `true`,
		$icon = `null`
	)

private

Parameters

string $caption

Returns: HtmlButton

Definition at line 68 of file DataTableFieldAsTrait.php.

◆ getFieldButtonCallable()

Ajax\semantic\widgets\datatable\getFieldButtonCallable	(	$caption,
		$visibleHover = `true`,
		$callback = `null`
	)

private

Parameters

string	$caption
callable	$callback
boolean	$visibleHover

Returns: callable

Definition at line 33 of file DataTableFieldAsTrait.php.

◆ getFieldButtons()

Ajax\semantic\widgets\datatable\getFieldButtons	(	$buttons,
		$visibleHover = `true`
	)

private

Definition at line 76 of file DataTableFieldAsTrait.php.

◆ getHasCheckboxes()

Ajax\semantic\widgets\datatable\getHasCheckboxes ( )

Definition at line 80 of file HasCheckboxesTrait.php.

◆ insertDefaultButtonIn()

Ajax\semantic\widgets\datatable\insertDefaultButtonIn	(	$index,
		$icon,
		$class = `null`,
		$visibleHover = `true`,
		$callback = `null`,
		$key = `null`
	)

Definition at line 160 of file DataTableFieldAsTrait.php.

◆ insertDeleteButtonIn()

Ajax\semantic\widgets\datatable\insertDeleteButtonIn	(	$index,
		$visibleHover = `true`,
		$deleteBehavior = `[]`,
		$callback = `null`
	)

Definition at line 242 of file DataTableFieldAsTrait.php.

◆ insertDisplayButtonIn()

Ajax\semantic\widgets\datatable\insertDisplayButtonIn	(	$index,
		$visibleHover = `true`,
		$displayBehavior = `[]`,
		$callback = `null`
	)

Definition at line 252 of file DataTableFieldAsTrait.php.

◆ insertEditButtonIn()

Ajax\semantic\widgets\datatable\insertEditButtonIn	(	$index,
		$visibleHover = `true`,
		$editBehavior = `[]`,
		$callback = `null`
	)

Definition at line 247 of file DataTableFieldAsTrait.php.

◆ insertField()

Ajax\semantic\widgets\datatable\insertField	(	$index,
		$field,
		$key = `null`
	)

abstract

◆ insertFieldButton()

Ajax\semantic\widgets\datatable\insertFieldButton	(	$index,
		$caption,
		$visibleHover = `true`,
		$callback = `null`
	)

Inserts a new Button for each row at col $index.

Parameters

int	$index
string	$caption
callable	$callback

Returns: DataTable

Definition at line 138 of file DataTableFieldAsTrait.php.

◆ insertInField()

Ajax\semantic\widgets\datatable\insertInField	(	$index,
		$field,
		$key = `null`
	)

abstract

◆ insertInFieldButton()

Ajax\semantic\widgets\datatable\insertInFieldButton	(	$index,
		$caption,
		$visibleHover = `true`,
		$callback = `null`,
		$key = `null`
	)

Inserts a new Button for each row in col at $index.

Parameters

int	$index
string	$caption
callable	$callback

Returns: DataTable

Definition at line 150 of file DataTableFieldAsTrait.php.

◆ setButtons()

Ajax\semantic\widgets\datatable\setButtons ( $_buttons )

Parameters

array $_buttons

Definition at line 267 of file DataTableFieldAsTrait.php.

◆ setCheckedCallback()

Ajax\semantic\widgets\datatable\setCheckedCallback ( $checkedCallback )

Set the callback function that determines whether the checkbox should be checked for an object.

Parameters

callable $checkedCallback a callback like function($object) that returns true or false

Definition at line 130 of file HasCheckboxesTrait.php.

◆ setCheckedClass()

Ajax\semantic\widgets\datatable\setCheckedClass ( $_checkedClass )

Definition at line 122 of file HasCheckboxesTrait.php.

◆ setCheckedMessage()

Ajax\semantic\widgets\datatable\setCheckedMessage ( array $_checkedMessage )

Defines the message displayed when checkboxes are checked or unchecked with an associative array 0=>no selection,1=>one item selected, other=>{count} items selected.

Parameters

array $_checkedMessage

Returns

Definition at line 103 of file HasCheckboxesTrait.php.

◆ setHasCheckboxes()

Ajax\semantic\widgets\datatable\setHasCheckboxes ( $_hasCheckboxes )

Definition at line 84 of file HasCheckboxesTrait.php.

Variable Documentation

◆ $_buttonsColumn

$_buttonsColumn

protected

Definition at line 19 of file DataTableFieldAsTrait.php.

◆ $_checkedCallback

$_checkedCallback

protected

Definition at line 20 of file HasCheckboxesTrait.php.

◆ $_checkedClass

$_checkedClass

protected

Definition at line 19 of file HasCheckboxesTrait.php.

◆ $_checkedMessage

$_checkedMessage

protected

Definition at line 18 of file HasCheckboxesTrait.php.

◆ $_hasCheckedMessage

$_hasCheckedMessage =false

protected

Definition at line 17 of file HasCheckboxesTrait.php.

◆ DataTableFieldAsTrait

trait DataTableFieldAsTrait

Initial value:

{

protected $_buttons=["display","edit","delete"]

Definition at line 17 of file DataTableFieldAsTrait.php.

◆ HasCheckboxesTrait

trait HasCheckboxesTrait

Initial value:

{

protected $_hasCheckboxes

Definition at line 15 of file HasCheckboxesTrait.php.

Data Structures

Functions

Variables

Function Documentation

◆ _fieldAs()

◆ _generateMainCheckbox()

◆ _getCheckedChange()

◆ _getCheckedMessageCall()

◆ _getCheckedMessageFunction()

◆ _runCheckboxes()

◆ _setAllChecked()

◆ _visibleOver()

◆ addAllButtons()

◆ addCountCheckedInToolbar()

◆ addDefaultButton()

◆ addDeleteButton()

◆ addDisplayButton()

◆ addEditButton()

◆ addEditDeleteButtons()

◆ addField()

◆ addFieldButton()

◆ addFieldButtons()

◆ addInToolbar()

◆ cleanIdentifier()

◆ fieldAs()

◆ fieldAsSubmit()

◆ getButtons()

◆ getButtonsColumn()

◆ getCallable()

◆ getCheckedMessage()

◆ getDefaultButton()

◆ getFieldButton()

◆ getFieldButtonCallable()

◆ getFieldButtons()

◆ getHasCheckboxes()

◆ insertDefaultButtonIn()

◆ insertDeleteButtonIn()

◆ insertDisplayButtonIn()

◆ insertEditButtonIn()

◆ insertField()

◆ insertFieldButton()

◆ insertInField()

◆ insertInFieldButton()

◆ setButtons()

◆ setCheckedCallback()

◆ setCheckedClass()

◆ setCheckedMessage()

◆ setHasCheckboxes()

Variable Documentation

◆ $_buttonsColumn

◆ $_checkedCallback

◆ $_checkedClass

◆ $_checkedMessage

◆ $_hasCheckedMessage

◆ DataTableFieldAsTrait

◆ HasCheckboxesTrait