Sfneal\ViewExport\Support\Adapters\Renderer

Complexity

Total Complexity

5

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	export()	0	12	2
A	handle()	0	7	1
A	__construct()	0	7	1
A	handleJob()	0	3	1

<?php

namespace Sfneal\ViewExport\Support\Adapters;

use Illuminate\Support\Facades\Bus;
use Sfneal\Queueables\AbstractJob;

abstract class Renderer extends AbstractJob
{
    /**
     * @var mixed Renderable content
     */
    protected $content;

    /**
     * @var string|null AWS S3 path to upload a file to after render (if provided)
     */
    protected $uploadPath;

    /**
     * Renderer constructor.
     *
     * - $content can be a View or HTML file contents
     *
     * @param mixed $content
     * @param string|null $uploadPath
     */
    public function __construct($content, string $uploadPath = null)
    {
        // Content of the PDF
        $this->content = $content;

        // Upload PDF after rendering (defaults to false)
        $this->uploadPath = $uploadPath;
    }

    /**
     * Render the content to a exportable object.
     *
     * @return object
     */
    abstract protected function render(): object;

    /**
     * Retrieve in an Exporter instance created from the $exportable.
     *
     * @param $exportable
     * @return Exporter
     */
    abstract protected function exporter($exportable): Exporter;

    /**
     * Dispatch this renderer instance to the Job queue without having to construct it statically.
     *
     * @return mixed
     */
    public function handleJob()
    {
        return Bus::dispatch($this);
    }

    /**
     * Load renderable content to an Exporter instance and render the output.
     *
     *  - storing output in a property avoids potentially calling expensive 'output()' method multiple times
     *
     * @return Exporter
     */
    public function handle(): Exporter
    {
        // Render the PDF
        $exportable = $this->render();

        // Instantiate the Exporter
        return $this->export($exportable);
    }

    /**
     * Create & return an Exporter instance.
     *
     * @param $exportable
     * @return Exporter
     */
    private function export($exportable): Exporter
    {
        // Initialize the PdfExporter
        $exporter = $this->exporter($exportable);

        // Upload after rendering if an upload path was provided
        if ($this->uploadPath) {
            $exporter->upload($this->uploadPath);
        }

        // Return a PdfExporter
        return $exporter;
    }
}