PHP Class Piwik\ReportRenderer\Csv

Inheritance: extends Piwik\ReportRenderer
Show file Open project: piwik/piwik

Protected Properties

Property Type Description
$rendered string

Public Methods

Method Description
getAttachments ( $report, $processedReports, $prettyDate ) : array Get report attachments, ex. graph images
getRenderedReport ( ) Get rendered report
renderFrontPage ( string $reportTitle, string $prettyDate, string $description, array $reportMetadata, array $segment ) Generate the first page.
renderReport ( array $processedReport ) Render the provided report.
sendToBrowserDownload ( string $filename ) Send rendering to browser with a 'download file' prompt
sendToBrowserInline ( string $filename ) Output rendering to browser
sendToDisk ( string $filename ) : string Save rendering to disk
setLocale ( string $locale ) Initialize locale settings.

Protected Methods

Method Description
getApiMethodNameFromUniqueId ( $uniqueId ) : string
getRenderer ( Piwik\DataTable\DataTableInterface $table, string $uniqueId ) : Csv

Method Details

getApiMethodNameFromUniqueId() protected method

protected getApiMethodNameFromUniqueId ( $uniqueId ) : string
$uniqueId
return string

getAttachments() public method

Get report attachments, ex. graph images
public getAttachments ( $report, $processedReports, $prettyDate ) : array
$report
$processedReports
$prettyDate
return array

getRenderedReport() public method

Get rendered report
public getRenderedReport ( )

getRenderer() protected method

protected getRenderer ( Piwik\DataTable\DataTableInterface $table, string $uniqueId ) : Csv
$table Piwik\DataTable\DataTableInterface
$uniqueId string
return Piwik\DataTable\Renderer\Csv

renderFrontPage() public method

Generate the first page.
public renderFrontPage ( string $reportTitle, string $prettyDate, string $description, array $reportMetadata, array $segment )
$reportTitle string
$prettyDate string formatted date
$description string
$reportMetadata array metadata for all reports
$segment array segment applied to all reports

renderReport() public method

Multiple calls to this method before calling outputRendering appends each report content.
public renderReport ( array $processedReport )
$processedReport array @see API::getProcessedReport()

sendToBrowserDownload() public method

Send rendering to browser with a 'download file' prompt
public sendToBrowserDownload ( string $filename )
$filename string without path & without format extension

sendToBrowserInline() public method

Output rendering to browser
public sendToBrowserInline ( string $filename )
$filename string without path & without format extension

sendToDisk() public method

Save rendering to disk
public sendToDisk ( string $filename ) : string
$filename string without path & without format extension
return string path of file

setLocale() public method

If not called, locale settings defaults to 'en'
public setLocale ( string $locale )
$locale string

Property Details

$rendered protected property

protected string $rendered
return string