Traincase\HtmlToPdfTinker\Drivers\WkhtmltopdfDriver

Complexity

Total Complexity

5

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
A	generatePdf()	0	14	1
A	storeOnFilesystem()	0	20	3

<?php

namespace Traincase\HtmlToPdfTinker\Drivers;

use Exception;
use League\Flysystem\FilesystemInterface;
use mikehaertl\wkhtmlto\Pdf;
use Traincase\HtmlToPdfTinker\DTO\PdfToGenerateDTO;
use Traincase\HtmlToPdfTinker\Exceptions\PdfCouldNotBeCreatedException;

class WkhtmltopdfDriver extends Driver
{
    private Pdf $wkhtmltopdf;

    public function __construct(Pdf $wkhtmltopdf)
    {
        $this->wkhtmltopdf = $wkhtmltopdf;
    }

    /**
     * Create the PDF and return it in string format.
     *
     * @param FilesystemInterface $filesystem Filesystem used for storing the PDF
     * @param PdfToGenerateDTO $dto Data needed to generate the PDF file
     * @return string Filepath to the generated PDF file
     * @throws PdfCouldNotBeCreatedException
     */
    public function storeOnFilesystem(FilesystemInterface $filesystem, PdfToGenerateDTO $dto): string
    {
        try {
            $options = array_merge([
                'orientation' => $dto->orientation
            ], $dto->options);

            $pdf = $this->generatePdf($dto->html, $options);

            if (!$pdf) {
                throw new \Exception('Wkhtmltopdf could not create PDF');
            }

            $fullPath = $this->getFullPath($dto->path, $dto->filename);

            $filesystem->put($fullPath, $pdf);

            return $fullPath;
        } catch (\Exception $e) {
            throw new PdfCouldNotBeCreatedException('Wkhtmltopdf could not create PDF', $e->getCode(), $e);
        }
    }

    /**
     * @param string $html
     * @param array $options
     * @return string
     * @throws Exception
     */
    protected function generatePdf(string $html, array $options): string
    {
        // Cloning the wkhtmltopdf class, since we're not able to reset/flush it.
        // If we generate multiple pdfs with the same driver we don't want
        // pages of the first PDF showing up in the second and nth...
        $wk = clone $this->wkhtmltopdf;

        $wk->setOptions($options);

        $wk->addPage($html);

        $pdf = $wk->toString();

        return $pdf;

The expression return $pdf could return the type false which is incompatible with the type-hinted return string. Consider adding an additional type-check to rule them out.

    }
}