PHP Класс Piwik\API\DataTableManipulator\Flattener

It loads subtables and combines them into a single table by concatenating the labels. This manipulator is triggered by using flat=1 in the API request.
Наследование: extends Piwik\API\DataTableManipulator
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$recursiveLabelSeparator string Separator for building recursive labels (or paths)

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

Метод Описание
flatten ( DataTable $dataTable, string $recursiveLabelSeparator ) : DataTable | Piwik\DataTable\Map
includeAggregateRows ( ) If the flattener is used after calling this method, aggregate rows will be included in the result. This can be useful when they contain data that the leafs don't have (e.g. conversion stats in some cases).

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

Метод Описание
flattenDataTableInto ( $dataTable, $newDataTable, $prefix = '', $logo = false )
manipulateDataTable ( DataTable $dataTable ) : DataTable Template method called from self::manipulate.
manipulateSubtableRequest ( array $request ) : array Remove the flat parameter from the subtable request

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

Метод Описание
flattenRow ( Row $row, $rowId, DataTable $dataTable, string $labelPrefix = '', boolean $parentLogo = false )

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

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

public flatten ( DataTable $dataTable, string $recursiveLabelSeparator ) : DataTable | Piwik\DataTable\Map
$dataTable Piwik\DataTable
$recursiveLabelSeparator string
Результат Piwik\DataTable | Piwik\DataTable\Map

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

protected flattenDataTableInto ( $dataTable, $newDataTable, $prefix = '', $logo = false )
$dataTable DataTable
$newDataTable

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

If the flattener is used after calling this method, aggregate rows will be included in the result. This can be useful when they contain data that the leafs don't have (e.g. conversion stats in some cases).
public includeAggregateRows ( )

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

Flatten each data table.
protected manipulateDataTable ( DataTable $dataTable ) : DataTable
$dataTable Piwik\DataTable
Результат Piwik\DataTable

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

Remove the flat parameter from the subtable request
protected manipulateSubtableRequest ( array $request ) : array
$request array
Результат array

Описание свойств

$recursiveLabelSeparator публичное свойство

Separator for building recursive labels (or paths)
public string $recursiveLabelSeparator
Результат string