Platine\PDF\Generator\DOMPDFGenerator

Complexity

Total Complexity

10

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	checkIfAlreadyRendered()	0	4	2
A	raw()	0	5	1
A	setDompdf()	0	4	1
A	save()	0	6	1
A	download()	0	4	1
A	getDompdf()	0	3	1
A	__construct()	0	2	1
A	generate()	0	12	1
A	disableSslVerify()	0	13	1

<?php

/**
 * Platine PDF
 *
 * Platine PDF is the lightweight for generating PDF documents
 *
 * This content is released under the MIT License (MIT)
 *
 * Copyright (c) 2020 Platine PDF
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/**
 *  @file DOMPDFGenerator.php
 *
 *  The DOMPDF generator class
 *
 *  @package    Platine\PDF\Generator
 *  @author Platine Developers Team
 *  @copyright  Copyright (c) 2020
 *  @license    http://opensource.org/licenses/MIT  MIT License
 *  @link   https://www.platine-php.com
 *  @version 1.0.0
 *  @filesource
 */

declare(strict_types=1);

namespace Platine\PDF\Generator;

use Dompdf\Dompdf;
use Platine\Filesystem\Filesystem;
use Platine\PDF\PDFGeneratorInterface;
use RuntimeException;

/**
 * @class DOMPDFGenerator
 * @package Platine\PDF\Generator
 */
class DOMPDFGenerator implements PDFGeneratorInterface
{
    /**
    * Whether the document already rendered call
     * mean to render() method
    * @var bool
    */
    protected $rendered = false;

    /**
    * The PDF generated filename
    * @var string
    */
    protected $filename = 'dompdf.pdf';

    /**
     * Create new instance
     * @param Dompdf $dompdf
     * @param Filesystem $filesystem
     */
    public function __construct(protected Dompdf $dompdf, protected Filesystem $filesystem)
    {
    }

    /**
     * Return the DOMPDF
     * @return Dompdf
     */
    public function getDompdf(): Dompdf
    {
        return $this->dompdf;
    }

    /**
     * Set the DOMPDF instance
     * @param Dompdf $dompdf
     * @return $this
     */
    public function setDompdf(Dompdf $dompdf): self
    {
        $this->dompdf = $dompdf;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function generate(
        string $content,
        string $filename = 'output.pdf',
        string $format = 'A4',
        string $orientation = 'portrait'
    ): void {
        $this->filename = $filename;
        $this->dompdf->loadHtml($content);
        $this->dompdf->setPaper($format, $orientation);
        $this->dompdf->render();

        $this->rendered = true;
    }

    /**
     * {@inheritdoc}
     */
    public function raw(): string
    {
        $this->checkIfAlreadyRendered();

        return (string) $this->dompdf->output();
    }

    /**
     * {@inheritdoc}
     */
    public function save(): void
    {
        $this->checkIfAlreadyRendered();

        $this->filesystem->file($this->filename)
                         ->write($this->raw());
    }

    /**
     * {@inheritdoc}
     */
    public function download(): void
    {
        $this->checkIfAlreadyRendered();
        $this->dompdf->stream($this->filename);
    }

    /**
     * Disable the SSL verification
     * @return $this
     */
    public function disableSslVerify(): self
    {
        $context = stream_context_create([
            'ssl' => [
                'verify_peer' => false,
                'verify_peer_name' => false,
                'allow_self_signed' => true
            ]
        ]);

        $this->dompdf->setHttpContext($context);

        return $this;
    }

    /**
     * Check if the document already rendered
     * @return void
     * @throws RuntimeException
     */
    protected function checkIfAlreadyRendered(): void
    {
        if ($this->rendered === false) {
            throw new RuntimeException('You must render the document first');
        }
    }
}