PHP Class Action_Helper_Datatable

Inheritance: extends Zend_Controller_Action_Helper_Abstract
Show file Open project: sourcefabric/newscoop

Public Methods

Method Description
dispatch ( ) : void Dispatch table
init ( ) : Action_Helper_Datatable
setBody ( string $p_columnProperty, array $p_values = [] ) : Action_Helper_Datatable Set body properties
setClasses ( array $p_values = [] ) : Action_Helper_Datatable Set header style classes
setCols ( array $cols, array $sorting = [] ) : Action_Helper_Datatable Set table columns
setDataProp ( array $p_values = [] ) : Action_Helper_Datatable Set custom widths
setDataSource ( Newscoop\Datatable\ISource $p_dataSource ) : Action_Helper_Datatable Set Datasource
setEntity ( $p_entity ) : Action_Helper_Datatable Set entity
setHandle ( Closure $handle ) : Action_Helper_Datatable Set handle
setHeader ( string $p_columnProperty, array $p_values = [] ) : Action_Helper_Datatable Set header properties
setInitialSorting ( array $initial_sort = [] ) : Action_Helper_Datatable Set initial sorting columns (aaSorting)
setOption ( string $p_key, mixed $p_value ) : Action_Helper_Datatable Setter for options
setSearchable ( array $searchable = [] ) : Action_Helper_Datatable Set searchable columns (bSearchable_col#)
setSorting ( array $p_sorting = [] ) : Action_Helper_Datatable Set sorting columns
setStripClasses ( array $p_value = [] ) : Action_Helper_Datatable Set strip classes to use when rendering the table Usefull for odd and even class
setVisible ( array $p_values = [] ) : Action_Helper_Datatable Set visibility
setWidths ( array | boolean $p_widths = false ) : Action_Helper_Datatable Set custom widths
toggleAutomaticWidth ( boolean $p_state = null ) : Action_Helper_Datatable Toggle automatic width

Private Methods

Method Description
buildColumnDefs ( )

Method Details

dispatch() public method

Dispatch table
public dispatch ( ) : void
return void

init() public method

public init ( ) : Action_Helper_Datatable
return Action_Helper_Datatable

setBody() public method

Set body properties
public setBody ( string $p_columnProperty, array $p_values = [] ) : Action_Helper_Datatable
$p_columnProperty string
$p_values array
return Action_Helper_Datatable

setClasses() public method

Set header style classes
public setClasses ( array $p_values = [] ) : Action_Helper_Datatable
$p_values array
return Action_Helper_Datatable

setCols() public method

Set table columns
public setCols ( array $cols, array $sorting = [] ) : Action_Helper_Datatable
$cols array
$sorting array
return Action_Helper_Datatable

setDataProp() public method

Set custom widths
public setDataProp ( array $p_values = [] ) : Action_Helper_Datatable
$p_values array
return Action_Helper_Datatable

setDataSource() public method

Set Datasource
public setDataSource ( Newscoop\Datatable\ISource $p_dataSource ) : Action_Helper_Datatable
$p_dataSource Newscoop\Datatable\ISource
return Action_Helper_Datatable

setEntity() public method

Set entity
public setEntity ( $p_entity ) : Action_Helper_Datatable
return Action_Helper_Datatable

setHandle() public method

Set handle
public setHandle ( Closure $handle ) : Action_Helper_Datatable
$handle Closure
return Action_Helper_Datatable

setHeader() public method

Set header properties
public setHeader ( string $p_columnProperty, array $p_values = [] ) : Action_Helper_Datatable
$p_columnProperty string
$p_values array
return Action_Helper_Datatable

setInitialSorting() public method

Set initial sorting columns (aaSorting)
public setInitialSorting ( array $initial_sort = [] ) : Action_Helper_Datatable
$initial_sort array
return Action_Helper_Datatable

setOption() public method

Setter for options
public setOption ( string $p_key, mixed $p_value ) : Action_Helper_Datatable
$p_key string
$p_value mixed
return Action_Helper_Datatable

setSearchable() public method

Set searchable columns (bSearchable_col#)
public setSearchable ( array $searchable = [] ) : Action_Helper_Datatable
$searchable array
return Action_Helper_Datatable

setSorting() public method

Set sorting columns
public setSorting ( array $p_sorting = [] ) : Action_Helper_Datatable
$p_sorting array
return Action_Helper_Datatable

setStripClasses() public method

Set strip classes to use when rendering the table Usefull for odd and even class
public setStripClasses ( array $p_value = [] ) : Action_Helper_Datatable
$p_value array
return Action_Helper_Datatable

setVisible() public method

Set visibility
public setVisible ( array $p_values = [] ) : Action_Helper_Datatable
$p_values array
return Action_Helper_Datatable

setWidths() public method

Set custom widths
public setWidths ( array | boolean $p_widths = false ) : Action_Helper_Datatable
$p_widths array | boolean
return Action_Helper_Datatable

toggleAutomaticWidth() public method

Toggle automatic width
public toggleAutomaticWidth ( boolean $p_state = null ) : Action_Helper_Datatable
$p_state boolean null
return Action_Helper_Datatable