PHP Class Piwik\API\DataTablePostProcessor

Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
__construct ( $apiModule, $apiMethod, $request )	Constructor.
applyComputeProcessedMetrics ( Piwik\DataTable\DataTableInterface $dataTable )
applyFlattener ( Piwik\DataTable\DataTableInterface $dataTable ) : DataTable \| Piwik\DataTable\DataTableInterface \| Piwik\DataTable\Map
applyGenericFilters ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
applyLabelFilter ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
applyMetricsFormatting ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
applyPivotByFilter ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
applyProcessedMetricsGenericFilters ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
applyQueuedFilters ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
applyRequestedColumnDeletion ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
applyTotalsCalculator ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
computeProcessedMetrics ( DataTable $dataTable )
getLabelFromRequest ( array $request ) : array	Returns the value for the label query parameter which can be either a string (ie, label=.
process ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface	Apply post-processing logic to a DataTable of a report for an API request.
removeTemporaryMetrics ( Piwik\DataTable\DataTableInterface $dataTable )
setCallbackAfterGenericFilters ( $callbackAfterGenericFilters )
setCallbackBeforeGenericFilters ( $callbackBeforeGenericFilters )
setFormatter ( Piwik\Metrics\Formatter $formatter )
setRequest ( $request )
unsanitizeLabelParameter ( $label )

Private Methods

Method	Description
convertSegmentValueToSegment ( Piwik\DataTable\DataTableInterface $dataTable )

Method Details

__construct() public method

Constructor.

public __construct ( $apiModule, $apiMethod, $request )

applyComputeProcessedMetrics() public method

public applyComputeProcessedMetrics ( Piwik\DataTable\DataTableInterface $dataTable )
$dataTable	Piwik\DataTable\DataTableInterface

applyFlattener() public method

public applyFlattener ( Piwik\DataTable\DataTableInterface $dataTable ) : DataTable \| Piwik\DataTable\DataTableInterface \| Piwik\DataTable\Map
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable \| Piwik\DataTable\DataTableInterface \| Piwik\DataTable\Map

applyGenericFilters() public method

public applyGenericFilters ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

applyLabelFilter() public method

public applyLabelFilter ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

applyMetricsFormatting() public method

public applyMetricsFormatting ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

applyPivotByFilter() public method

public applyPivotByFilter ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

applyProcessedMetricsGenericFilters() public method

public applyProcessedMetricsGenericFilters ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

applyQueuedFilters() public method

public applyQueuedFilters ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

applyRequestedColumnDeletion() public method

public applyRequestedColumnDeletion ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

applyTotalsCalculator() public method

public applyTotalsCalculator ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface
return	Piwik\DataTable\DataTableInterface

computeProcessedMetrics() public method

public computeProcessedMetrics ( DataTable $dataTable )
$dataTable	Piwik\DataTable

getLabelFromRequest() public static method

..) or array (ie, label[]=...).

public static getLabelFromRequest ( array $request ) : array
$request	array
return	array

process() public method

Apply post-processing logic to a DataTable of a report for an API request.

public process ( Piwik\DataTable\DataTableInterface $dataTable ) : Piwik\DataTable\DataTableInterface
$dataTable	Piwik\DataTable\DataTableInterface	The data table to process.
return	Piwik\DataTable\DataTableInterface	A new data table.

removeTemporaryMetrics() public method

public removeTemporaryMetrics ( Piwik\DataTable\DataTableInterface $dataTable )
$dataTable	Piwik\DataTable\DataTableInterface

setCallbackAfterGenericFilters() public method

public setCallbackAfterGenericFilters ( $callbackAfterGenericFilters )

setCallbackBeforeGenericFilters() public method

public setCallbackBeforeGenericFilters ( $callbackBeforeGenericFilters )

setFormatter() public method

public setFormatter ( Piwik\Metrics\Formatter $formatter )
$formatter	Piwik\Metrics\Formatter

setRequest() public method

public setRequest ( $request )

unsanitizeLabelParameter() public static method

public static unsanitizeLabelParameter ( $label )