Palmtree\Csv\Downloader

Complexity

Total Complexity

12

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

0%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	download()	0	6	1
A	sendResponse()	0	15	3
A	getResponseHeaders()	0	4	1
A	addResponseHeaders()	0	8	2
A	addResponseHeader()	0	4	1
A	removeResponseHeader()	0	4	1
A	getFilename()	0	4	1
A	setFilename()	0	6	1

<?php

namespace Palmtree\Csv;

class Downloader extends Writer
{
    /**
     * Default headers used to tell client the response is
     * a downloadable, non-cacheable file.
     * @var array
     */
    protected $responseHeaders = [
        'Content-Type'              => 'text/csv',
        'Content-Description'       => 'File Transfer',
        'Content-Transfer-Encoding' => 'Binary',
        'Expires'                   => '0',
        'Cache-Control'             => 'must-revalidate, post-check=0, pre-check=0',
        'Pragma'                    => 'public',
    ];

    protected $filename;

    public function __construct($filename, $responseHeaders = [])
    {
        $this->setFilename($filename);

        $this->addResponseHeader('Content-Disposition', sprintf('attachment; filename="%s"', $this->getFilename()));
        $this->addResponseHeaders($responseHeaders);

        parent::__construct('php://temp');
    }

    public static function download($file, $data)
    {
        $downloader = new static($file);
        $downloader->setData($data);
        $downloader->sendResponse();
    }

    /**
     * Attempts to send the file as a download to the client.
     *
     * @throws \Exception
     */
    public function sendResponse()
    {
        if (!headers_sent()) {
            $headers = $this->getResponseHeaders();

            foreach ($headers as $key => $value) {
                header(sprintf('%s: %s', $key, $value));
            }
        }

        $this->getDocument()->trimFinalLineEnding();

        $this->getDocument()->fseek(0);
        $this->getDocument()->fpassthru();
    }

    public function getResponseHeaders()
    {
        return $this->responseHeaders;
    }

    public function addResponseHeaders($headers = [])
    {
        foreach ($headers as $key => $value) {
            $this->addResponseHeader($key, $value);
        }

        return $this;
    }

    public function addResponseHeader($key, $value)
    {
        $this->responseHeaders[$key] = $value;
    }

    public function removeResponseHeader($key)
    {
        unset($this->responseHeaders[$key]);
    }

    /**
     * @return string
     */
    public function getFilename()
    {
        return $this->filename;
    }

    /**
     * @param string $filename
     *
     * @return Downloader
     */
    public function setFilename($filename)
    {
        $this->filename = $filename;

        return $this;
    }
}