PHP Класс Piwik\DataTable\Renderer\Csv

When rendered using the default settings, a CSV report has the following characteristics: The first record contains headers for all the columns in the report. All rows have the same number of columns. The default field delimiter string is a comma (,). Formatting and layout are ignored.
Наследование: extends Piwik\DataTable\Renderer
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$convertToUnicode boolean Converts the content to unicode so that UTF8 characters (eg. chinese) can be imported in Excel
$exportIdSubtable boolean idSubtable will be exported in a column called 'idsubdatatable'
$exportMetadata boolean 'metadata' columns will be exported, prefixed by 'metadata_'
$lineEnd string Line end
$separator string Column separator

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

Метод Описание
render ( ) : string Computes the dataTable output and returns the string/binary
setConvertToUnicode ( $bool ) Enables / Disables unicode converting
setSeparator ( $separator ) Sets the column separator

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

Метод Описание
formatFormulas ( $value )
formatValue ( mixed $value ) : string Formats/Escapes the given value
removeFirstPercentSign ( $value ) : mixed
renderDataTable ( DataTable | Piwik\DataTable\Simple $table, array &$allColumns = [] ) : string Converts the output of the given simple data table
renderDataTableMap ( Piwik\DataTable\Map $table, array &$allColumns = [] ) : string Computes the output of the given data table array
renderHeader ( ) Sends the http headers for csv file
renderTable ( DataTable | array $table, array &$allColumns = [] ) : string Computes the output of the given data table

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

Метод Описание
buildCsvString ( $allColumns, $csv ) : array
convertToUnicode ( $str ) : string
flattenColumnArray ( $columns, &$csvRow = [], $csvColumnNameTemplate = '%s' ) Flattens an array of column values so they can be outputted as CSV (which does not support nested structures).
getCsvColumnName ( $name )
getHeaderLine ( array $columnMetrics ) : array Returns the CSV header line for a set of metrics. Will translate columns if desired.
makeArrayFromDataTable ( $table, &$allColumns ) : array

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

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

protected formatFormulas ( $value )

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

Formats/Escapes the given value
protected formatValue ( mixed $value ) : string
$value mixed
Результат string

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

protected removeFirstPercentSign ( $value ) : mixed
$value
Результат mixed

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

Computes the dataTable output and returns the string/binary
public render ( ) : string
Результат string

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

Converts the output of the given simple data table
protected renderDataTable ( DataTable | Piwik\DataTable\Simple $table, array &$allColumns = [] ) : string
$table Piwik\DataTable | Piwik\DataTable\Simple
$allColumns array
Результат string

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

Computes the output of the given data table array
protected renderDataTableMap ( Piwik\DataTable\Map $table, array &$allColumns = [] ) : string
$table Piwik\DataTable\Map
$allColumns array
Результат string

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

Sends the http headers for csv file
protected renderHeader ( )

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

Computes the output of the given data table
protected renderTable ( DataTable | array $table, array &$allColumns = [] ) : string
$table Piwik\DataTable | array
$allColumns array
Результат string

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

Enables / Disables unicode converting
public setConvertToUnicode ( $bool )
$bool

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

Sets the column separator
public setSeparator ( $separator )
$separator

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

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

Converts the content to unicode so that UTF8 characters (eg. chinese) can be imported in Excel
public bool $convertToUnicode
Результат boolean

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

idSubtable will be exported in a column called 'idsubdatatable'
public bool $exportIdSubtable
Результат boolean

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

'metadata' columns will be exported, prefixed by 'metadata_'
public bool $exportMetadata
Результат boolean

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

Line end
public string $lineEnd
Результат string

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

Column separator
public string $separator
Результат string