DataTables
DataComponent Class Reference
Inheritance diagram for DataComponent:

Public Member Functions

 init (DataTable $dataTable)
 
 remember ()
 
 forget ()
 
 transformData ()
 
 getName ()
 
 render ()
 

Protected Member Functions

 _readFromSession ()
 
 _afterInit ()
 
 _storeInSession ()
 
 _shapeData ()
 

Protected Attributes

 $_rememberState = false
 
 $_rememberKey = 'global'
 
 $_dataTable
 

Member Function Documentation

◆ _afterInit()

_afterInit ( )
protected

Initalize fields after the query builder instance is set.

◆ _readFromSession()

_readFromSession ( )
protected

Everything that needs to be read when the state is remembered. Is called before _afterInit(), so that session values can be overriden.

◆ _shapeData()

_shapeData ( )
abstractprotected
Returns
Builder

◆ _storeInSession()

_storeInSession ( )
protected

Use this function to save your state in the session. This is called just before rendering, so all dynamically added stuff etc. is considered.

◆ forget()

forget ( )

Forget the state of the data component.

Returns
DataComponent

◆ getName()

getName ( )
Returns
string

◆ init()

init ( DataTable  $dataTable)
Parameters
DataTable$dataTable
Returns
DataComponent

◆ remember()

remember ( )

Remember the state of the data component.

Returns
DataComponent

◆ render()

render ( )
abstract
Returns
string

The documentation for this class was generated from the following file: