Sfneal\ViewExport\Pdf\Utils\PdfExporter

Complexity

Total Complexity

8

Size/Duplication

Total Lines	146
Duplicated Lines	0 %

Importance

Changes	8
Bugs	2	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getUrl()	0	3	1
A	getPath()	0	3	1
A	download()	0	3	1
A	render()	0	25	1
A	getOutput()	0	3	1
A	view()	0	3	1
A	__construct()	0	7	1
A	upload()	0	6	1

<?php

namespace Sfneal\ViewExport\Pdf\Utils;

use Dompdf\Dompdf;
use Dompdf\Exception;
use Dompdf\Options;
use Illuminate\Contracts\View\View;
use Sfneal\Helpers\Aws\S3\S3;
use Sfneal\Helpers\Strings\StringHelpers;

class PdfExporter
{
    /**
     * @var Options
     */
    public $options;

    /**
     * @var Dompdf
     */
    private $pdf;

    /**
     * @var string|null AWS S3 file path
     */
    private $path;

    /**
     * @var string|null AWS S3 file URL
     */
    private $url;

    /**
     * @var string|null
     */
    private $output;

    /**
     * @var View|string
     */
    private $content;

    /**
     * PdfExporter constructor.
     *
     * - $content can be a View or HTML file contents
     *
     * @param View|string $content
     * @param Options|null $options
     */
    public function __construct($content, Options $options = null)
    {
        // Declare PDF options (use DefaultOptions) if none provided
        $this->options = $options ?? new DefaultOptions();

        // Content of the PDF
        $this->content = $content;
    }

    /**
     * Load PDF content to the Dompdf instance and render the output.
     *
     *  - storing output in a property avoids potentially calling expensive 'output()' method multiple times
     *
     * @return $this
     * @throws Exception
     */
    public function render(): self
    {
        // Instantiate dompdf
        $this->pdf = new Dompdf($this->options);

        // Create local HTML file path
        $localHTML = StringHelpers::joinPaths($this->options->getRootDir(), uniqid().'.html');

        // Store View (or HTML) as HTML file within Dompdf root
        touch($localHTML);
        file_put_contents($localHTML, $this->content);

        // Load HTML
        $this->pdf->loadHtmlFile($localHTML);

        // Remove temp HTML file
        unlink($localHTML);

        // Render the PDF
        $this->pdf->render();

        // Store output to a property to avoid retrieving twice
        $this->output = $this->pdf->output();

        return $this;
    }

    /**
     * Upload a rendered PDF to an AWS S3 file store.
     *
     * @param string $path
     * @return $this
     */
    public function upload(string $path): self
    {
        $this->path = $path;
        $this->url = (new S3($path))->upload_raw($this->getOutput());

        return $this;
    }

    /**
     * View the PDF in the clients browser.
     *
     * @param string $filename
     */
    public function view(string $filename = 'output.pdf')
    {
        $this->pdf->stream($filename, ['Attachment' => false]);
    }

    /**
     * Download the PDF using the clients browser.
     *
     * @param string $filename
     */
    public function download(string $filename = 'output.pdf')
    {
        $this->pdf->stream($filename, ['Attachment' => true]);
    }

    /**
     * Retrieve the PDF's output.
     *
     * @return string
     */
    public function getOutput(): string
    {
        return $this->output;
    }

    /**
     * Retrieve the PDF's AWS S3 path.
     *
     * @return string|null
     */
    public function getPath(): ?string
    {
        return $this->path;
    }

    /**
     * Retrieve the PDF's AWS S3 url.
     *
     * @return string|null
     */
    public function getUrl(): ?string
    {
        return $this->url;
    }
}