Tsv.php
133 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik\ReportRenderer; |
| 10 | |
| 11 | use Piwik\DataTable\DataTableInterface; |
| 12 | use Piwik\DataTable\Renderer\Tsv as TsvDataTableRenderer; |
| 13 | use Piwik\Piwik; |
| 14 | use Piwik\ReportRenderer; |
| 15 | /** |
| 16 | * TSV report renderer |
| 17 | */ |
| 18 | class Tsv extends ReportRenderer |
| 19 | { |
| 20 | /** |
| 21 | * @var string |
| 22 | */ |
| 23 | protected $rendered; |
| 24 | /** |
| 25 | * Initialize locale settings. |
| 26 | * If not called, locale settings defaults to 'en' |
| 27 | * |
| 28 | * @param string $locale |
| 29 | */ |
| 30 | public function setLocale($locale) |
| 31 | { |
| 32 | return; |
| 33 | } |
| 34 | /** |
| 35 | * Save rendering to disk |
| 36 | * |
| 37 | * @param string $filename without path & without format extension |
| 38 | * @return string path of file |
| 39 | */ |
| 40 | public function sendToDisk($filename) |
| 41 | { |
| 42 | return ReportRenderer::writeFile($filename, ReportRenderer::TSV_FORMAT, $this->getRenderedReport()); |
| 43 | } |
| 44 | /** |
| 45 | * Send rendering to browser with a 'download file' prompt |
| 46 | * |
| 47 | * @param string $filename without path & without format extension |
| 48 | */ |
| 49 | public function sendToBrowserDownload($filename) |
| 50 | { |
| 51 | ReportRenderer::sendToBrowser($filename, ReportRenderer::TSV_FORMAT, "text/" . ReportRenderer::TSV_FORMAT, $this->getRenderedReport()); |
| 52 | } |
| 53 | /** |
| 54 | * Output rendering to browser |
| 55 | * |
| 56 | * @param string $filename without path & without format extension |
| 57 | */ |
| 58 | public function sendToBrowserInline($filename) |
| 59 | { |
| 60 | ReportRenderer::sendToBrowser($filename, ReportRenderer::TSV_FORMAT, "application/" . ReportRenderer::TSV_FORMAT, $this->getRenderedReport()); |
| 61 | } |
| 62 | /** |
| 63 | * Get rendered report |
| 64 | */ |
| 65 | public function getRenderedReport() |
| 66 | { |
| 67 | return $this->rendered; |
| 68 | } |
| 69 | /** |
| 70 | * Generate the first page. |
| 71 | * |
| 72 | * @param string $reportTitle |
| 73 | * @param string $prettyDate formatted date |
| 74 | * @param string $description |
| 75 | * @param array $reportMetadata metadata for all reports |
| 76 | * @param array $segment segment applied to all reports |
| 77 | */ |
| 78 | public function renderFrontPage($reportTitle, $prettyDate, $description, $reportMetadata, $segment) |
| 79 | { |
| 80 | return; |
| 81 | } |
| 82 | /** |
| 83 | * Render the provided report. |
| 84 | * Multiple calls to this method before calling outputRendering appends each report content. |
| 85 | * |
| 86 | * @param array $processedReport @see API::getProcessedReport() |
| 87 | */ |
| 88 | public function renderReport($processedReport) |
| 89 | { |
| 90 | $tsvRenderer = $this->getRenderer($processedReport['reportData'], $processedReport['metadata']['uniqueId']); |
| 91 | $reportData = $tsvRenderer->render(); |
| 92 | if (empty($reportData)) { |
| 93 | $reportData = Piwik::translate('CoreHome_ThereIsNoDataForThisReport'); |
| 94 | } |
| 95 | $replaceBySpace = array($tsvRenderer->separator); |
| 96 | $reportName = str_replace($replaceBySpace, " ", $processedReport['metadata']['name']); |
| 97 | $this->rendered .= implode('', array($reportName, $tsvRenderer->lineEnd, $reportData, $tsvRenderer->lineEnd, $tsvRenderer->lineEnd)); |
| 98 | } |
| 99 | /** |
| 100 | * @param string $uniqueId |
| 101 | * @return \Piwik\DataTable\Renderer\Tsv |
| 102 | */ |
| 103 | protected function getRenderer(DataTableInterface $table, $uniqueId) |
| 104 | { |
| 105 | $tsvRenderer = new TsvDataTableRenderer(); |
| 106 | $tsvRenderer->setIdSite($this->idSite); |
| 107 | $tsvRenderer->setTable($table); |
| 108 | $tsvRenderer->setConvertToUnicode(\false); |
| 109 | $tsvRenderer->setApiMethod($this->getApiMethodNameFromUniqueId($uniqueId)); |
| 110 | return $tsvRenderer; |
| 111 | } |
| 112 | /** |
| 113 | * @param $uniqueId |
| 114 | * @return string |
| 115 | */ |
| 116 | protected function getApiMethodNameFromUniqueId($uniqueId) |
| 117 | { |
| 118 | return str_replace("_", ".", $uniqueId); |
| 119 | } |
| 120 | /** |
| 121 | * Get report attachments, ex. graph images |
| 122 | * |
| 123 | * @param $report |
| 124 | * @param $processedReports |
| 125 | * @param $prettyDate |
| 126 | * @return array |
| 127 | */ |
| 128 | public function getAttachments($report, $processedReports, $prettyDate) |
| 129 | { |
| 130 | return array(); |
| 131 | } |
| 132 | } |
| 133 |