PHP Class Newscoop\Controller\Action\Helper\Datatable\ADatatable

Inheritance: extends Zend_Controller_Action_Helper_Abstrac\Zend_Controller_Action_Helper_Abstract
Afficher le fichier Open project: sourcefabric/newscoop Class Usage Examples

Protected Properties

Свойство Type Description
$_adapter Newscoop\Controller\Action\Helper\Datatable\Adapter\AAdapter The data adapter
$_cols array Columns
$_colsIndex array Columns' index
$_isDispatched
$_options array Options
$_outputObject object Output object for processed data
$_params Paramenters for the data fetching Get them from the request object for example
$_rowHandler function Row handler, called for each row in datatable

Méthodes publiques

Méthode Description
dispatch ( $p_params = null, $p_cols = null, $p_options = null ) should implement a switching method for data and metadata fetching
dispatchData ( array $p_params = null, array $p_cols = null ) Get data and set the out object
dispatchMedatata ( array $p_cols = null, array $p_options = null ) set output metadata
getAdapter ( ) : Adapter Get the data adapter
getOptions ( ) : array Get options
getOutputObject ( ) : object Get output object
init ( )
setAdapter ( AAdapter $p_adapter ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable Set the data adapter
setCols ( $p_cols ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable Set columns
setOption ( string $p_key, $p_value ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable Set option
setOptions ( array $p_options ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable Set multiple options
setOutputObject ( object &$p_object ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable Set output object, for example the view object.
setParams ( $p_params ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable Set params
setRowHandler ( function $p_func ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable Set row handler

Method Details

dispatch() abstract public méthode

should implement a switching method for data and metadata fetching
abstract public dispatch ( $p_params = null, $p_cols = null, $p_options = null )

dispatchData() public méthode

Get data and set the out object
public dispatchData ( array $p_params = null, array $p_cols = null )
$p_params array
$p_cols array

dispatchMedatata() public méthode

set output metadata
public dispatchMedatata ( array $p_cols = null, array $p_options = null )
$p_cols array
$p_options array

getAdapter() public méthode

Get the data adapter
public getAdapter ( ) : Adapter
Résultat Adapter $p_adapter

getOptions() public méthode

Get options
public getOptions ( ) : array
Résultat array

getOutputObject() public méthode

Get output object
public getOutputObject ( ) : object
Résultat object $p_object

init() public méthode

public init ( )

setAdapter() public méthode

Set the data adapter
public setAdapter ( AAdapter $p_adapter ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable
$p_adapter Newscoop\Controller\Action\Helper\Datatable\Adapter\AAdapter
Résultat Newscoop\Controller\Action\Helper\Datatable\ADatatable

setCols() public méthode

Set columns
public setCols ( $p_cols ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable
Résultat Newscoop\Controller\Action\Helper\Datatable\ADatatable

setOption() public méthode

Set option
public setOption ( string $p_key, $p_value ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable
$p_key string
Résultat Newscoop\Controller\Action\Helper\Datatable\ADatatable

setOptions() public méthode

Set multiple options
public setOptions ( array $p_options ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable
$p_options array
Résultat Newscoop\Controller\Action\Helper\Datatable\ADatatable

setOutputObject() public méthode

Set output object, for example the view object.
public setOutputObject ( object &$p_object ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable
$p_object object
Résultat Newscoop\Controller\Action\Helper\Datatable\ADatatable

setParams() public méthode

Set params
public setParams ( $p_params ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable
Résultat Newscoop\Controller\Action\Helper\Datatable\ADatatable

setRowHandler() public méthode

Set row handler
public setRowHandler ( function $p_func ) : Newscoop\Controller\Action\Helper\Datatable\ADatatable
$p_func function
Résultat Newscoop\Controller\Action\Helper\Datatable\ADatatable

Property Details

$_adapter protected_oe property

The data adapter
protected AAdapter,Newscoop\Controller\Action\Helper\Datatable\Adapter $_adapter
Résultat Newscoop\Controller\Action\Helper\Datatable\Adapter\AAdapter

$_cols protected_oe property

Columns
protected array $_cols
Résultat array

$_colsIndex protected_oe property

Columns' index
protected array $_colsIndex
Résultat array

$_isDispatched protected_oe property

protected $_isDispatched

$_options protected_oe property

Options
protected array $_options
Résultat array

$_outputObject protected_oe property

Output object for processed data
protected object $_outputObject
Résultat object

$_params protected_oe property

Paramenters for the data fetching Get them from the request object for example
protected $_params

$_rowHandler protected_oe property

Row handler, called for each row in datatable
protected function $_rowHandler
Résultat function