CsvDownloadAction.php

Go to the documentation of this file.

<?php
 
namespace Elgg\Controllers;
 
use Elgg\Http\DownloadResponse;
 
abstract class CsvDownloadAction extends DownloadAction {
 
    protected function getFilename(): string {
        return 'output.csv';
    }
    
    protected function getMimeType(): string {
        return 'text/csv';
    }
 
    protected function getSeparator(): string {
        return ';';
    }
 
    protected function getEnclosure(): string {
        return '"';
    }
 
    protected function getEscape(): string {
        return '\\';
    }
 
    protected function getContentHeaders(): array {
        return [];
    }
 
    abstract protected function getContentRows(): array;
 
    final protected function getContents(): string {
        $fh_temp = new \ElggTempFile();
        $fh = $fh_temp->open('write');
 
        $headers = $this->getContentHeaders();
        if (!empty($headers)) {
            fputcsv($fh, $headers, $this->getSeparator(), $this->getEnclosure(), $this->getEscape());
        }
        
        foreach ($this->getContentRows() as $row) {
            fputcsv($fh, $row, $this->getSeparator(), $this->getEnclosure(), $this->getEscape());
        }
 
        $contents = $fh_temp->grabFile();
        $fh_temp->close();
        
        return $contents;
    }
}