PHP Класс Piwik\API\DataTableGenericFilter

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( $request, $report ) Constructor
areProcessedMetricsNeededFor ( $metrics )
disableFilters ( string[] $filterNames ) Makes sure a set of filters are not run.
filter ( DataTable $table ) Filters the given data table
getGenericFiltersInformation ( ) : array Returns an array containing the information of the generic Filter to be applied automatically to the data resulting from the API calls.

Защищенные методы

Метод Описание
applyGenericFilters ( DataTable $datatable ) : boolean Apply generic filters to the DataTable object resulting from the API Call.

Приватные методы

Метод Описание
containsProcessedMetric ( Piwik\Plugin\ProcessedMetric[] $metrics, string $name ) : boolean
getGenericFiltersHavingDefaultValues ( )

Описание методов

__construct() публичный Метод

Constructor
public __construct ( $request, $report )
$request

applyGenericFilters() защищенный Метод

Disable this feature by setting the parameter disable_generic_filters to 1 in the API call request.
protected applyGenericFilters ( DataTable $datatable ) : boolean
$datatable Piwik\DataTable
Результат boolean

areProcessedMetricsNeededFor() публичный Метод

public areProcessedMetricsNeededFor ( $metrics )

disableFilters() публичный Метод

Makes sure a set of filters are not run.
public disableFilters ( string[] $filterNames )
$filterNames string[] The name of each filter to disable.

filter() публичный Метод

Filters the given data table
public filter ( DataTable $table )
$table Piwik\DataTable

getGenericFiltersInformation() публичный статический Метод

Order to apply the filters: 1 - Filter that remove filtered rows 2 - Filter that sort the remaining rows 3 - Filter that keep only a subset of the results 4 - Presentation filters
public static getGenericFiltersInformation ( ) : array
Результат array See the code for spec