ByTIC\DocumentGenerator\PdfLetters\PdfLetterTrait

Complexity

Total Complexity

35

Size/Duplication

Total Lines	287
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	11

Test Coverage

Coverage

41.38%

Importance

Changes

0

21 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	4	1
A	hasFile()	0	6	1
A	getFile()	0	9	2
A	delete()	0	7	1
A	deleteLetters()	0	4	1
A	downloadExample()	0	8	1
	getModelExample()	0	1	?
A	download()	0	7	1
A	downloadBlank()	0	17	1
A	generateFile()	0	20	5
A	generatePdfObj()	0	13	2
A	addFieldsToPDF()	0	9	2
A	generateNewPdfObj()	0	17	2
A	newPdfBuilder()	0	9	1
A	getItem()	0	6	1
	getItemsManager()	0	1	?
A	getFileNameDefault()	0	4	1
A	pdfDrawGuidelines()	0	20	5
A	getFileNameFromModel()	0	4	1
A	uploadFromRequest()	0	22	5
A	hydrateMediaRepositoryCustom()	0	6	1

<?php

namespace ByTIC\DocumentGenerator\PdfLetters;

use ByTIC\DocumentGenerator\Helpers;
use ByTIC\DocumentGenerator\PdfLetters\Fields\FieldTrait;
use ByTIC\MediaLibrary\Exceptions\FileCannotBeAdded\FileUnacceptableForCollection;
use ByTIC\MediaLibrary\HasMedia\HasMediaTrait;
use ByTIC\MediaLibrary\HasMedia\Interfaces\HasMedia;
use ByTIC\MediaLibrary\Media\Media;
use ByTIC\MediaLibrary\MediaRepository\MediaRepository;
use Nip\Records\Traits\AbstractTrait\RecordTrait as AbstractRecordTrait;
use setasign\Fpdi;
use Symfony\Component\HttpFoundation\File\UploadedFile;
use TCPDF;

/**
 * Class PdfLetterTrait
 * @package ByTIC\DocumentGenerator\PdfLetters
 *
 * @method FieldTrait[] getCustomFields()
 *
 * @property int $id_item
 * @property string $type
 * @property string $orientation
 * @property string $format
 */
trait PdfLetterTrait
{
    use AbstractRecordTrait;
    use HasMediaTrait;

    /**
     * @return string
     */
    public function getName()
    {
        return $this->getManager()->getLabel('title.singular') . ' #' . $this->id;
    }

    /**
     * @return bool
     */
    public function hasFile()
    {
        $file = $this->getFile();

        return $file instanceof Media;
    }

    /**
     * @return bool|Media
     */
    public function getFile()
    {
        $files = $this->getFiles();
        if (count($files) < 1) {
            return false;
        }

        return $files->getDefaultMedia();
    }

    /**
     * @return mixed
     */
    public function delete()
    {
        $this->deleteLetters();

        /** @noinspection PhpUndefinedClassInspection */
        return parent::delete();
    }

    public function deleteLetters()
    {
        $this->getFiles()->delete();
    }

    public function downloadExample()
    {
        $result = $this->getModelExample();
        /** @noinspection PhpUndefinedFieldInspection */
        $result->demo = true;

The property demo does not seem to exist in Nip\Records\Traits\AbstractTrait\RecordTrait.

        $this->download($result);
    }

    /**
     * @return AbstractRecordTrait

The return type AbstractRecordTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    abstract public function getModelExample();

    /**
     * @param AbstractRecordTrait $model

The type AbstractRecordTrait for parameter $model is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    public function download($model)
    {
        $pdf = $this->generatePdfObj($model);

        $pdf->Output($this->getFileNameFromModel($model) . '.pdf', 'D');
        die();
    }

    public function downloadBlank()
    {
        $file = $this->getFile();
        $model = $this->getModelExample();
        $name = $this->getFileNameFromModel($model) . '.pdf';

        header('Content-Type: application/pdf');
        header('Content-Description: File Transfer');
        header('Cache-Control: private, must-revalidate, post-check=0, pre-check=0, max-age=1');
        header('Pragma: public');
        header('Expires: Sat, 26 Jul 1997 05:00:00 GMT'); // Date in the past
        header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
        header('Content-Disposition: attachment; filename="' . $name . '";');
        header("Content-Transfer-Encoding: Binary");
        echo $file->read();
        die();
    }

    /**
     * @param $model
     * @param $output
     * @return bool|Fpdi|TCPDF
     */
    public function generateFile($model, $output = null)
    {
        $pdf = $this->generatePdfObj($model);

        if ($model->demo === true) {
            $this->pdfDrawGuidelines($pdf);
        }
        $fileName = $this->getFileNameFromModel($model) . '.pdf';
        if (is_string($output) && is_dir($output)) {
            return $pdf->Output($output . $fileName, 'F');
        }
        if ($output instanceof HasMedia) {
            /** @var HasMediaTrait $output */
            $output->addFileFromContent(
                $pdf->Output($fileName, 'S'),
                $fileName
            );
        }
        return $pdf;
    }

    /**
     * @param AbstractRecordTrait $model

The type AbstractRecordTrait for parameter $model is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     * @return FPDI|TCPDF
     */
    public function generatePdfObj($model)
    {
        $pdf = $this->generateNewPdfObj();

        /** @noinspection PhpUndefinedFieldInspection */
        if ($model->demo === true) {

The property demo does not seem to exist in Nip\Records\Traits\AbstractTrait\RecordTrait.

            $this->pdfDrawGuidelines($pdf);
        }

        $this->addFieldsToPDF($pdf, $model);

        return $pdf;
    }

    /**
     * @param $pdf
     * @param $model
     */
    protected function addFieldsToPDF($pdf, $model)
    {

        /** @var FieldTrait[] $fields */
        $fields = $this->getCustomFields();
        foreach ($fields as $field) {
            $field->addToPdf($pdf, $model);
        }
    }

    /**
     * @return Fpdi\Tcpdf\Fpdi|TCPDF
     * @throws Fpdi\PdfParser\CrossReference\CrossReferenceException
     * @throws Fpdi\PdfParser\Filter\FilterException
     * @throws Fpdi\PdfParser\PdfParserException
     * @throws Fpdi\PdfParser\Type\PdfTypeException
     * @throws Fpdi\PdfReader\PdfReaderException
     */
    public function generateNewPdfObj()
    {
        $pdf = static::newPdfBuilder('L');

        $mediaFile = $this->getFile();
        $pageCount = $pdf->setSourceFile($mediaFile->getFile()->readStream());
        for ($pageNo = 1; $pageNo <= $pageCount; $pageNo++) {
            $tplidx = $pdf->importPage($pageNo, '/MediaBox');

            $pdf->AddPage(ucfirst($this->orientation), $this->format);
            $pdf->useTemplate($tplidx);
            $pdf->endPage();
        }
        $pdf->setPage(1);

        return $pdf;
    }

    /**
     * @param mixed ...$params
     * @return Fpdi\Tcpdf\Fpdi
     */
    public static function newPdfBuilder(...$params)
    {
        $pdf = new Fpdi\Tcpdf\Fpdi(...$params);
        $pdf->setPrintHeader(false);
        $pdf->SetCreator(PDF_CREATOR);
        $pdf->SetAuthor(Helpers::author());

        return $pdf;
    }

    /**
     * @return AbstractRecordTrait

The return type AbstractRecordTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    public function getItem()
    {
        $manager = $this->getItemsManager();

        return $manager->findOne($this->id_item);

It seems like findOne() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @return AbstractRecordTrait

The return type AbstractRecordTrait is a trait, and thus cannot be used for type-hinting in PHP. Maybe consider adding an interface and use that for type-hinting?

     */
    abstract public function getItemsManager();

    /**
     * @return string
     */
    protected function getFileNameDefault()
    {
        return 'letter';
    }

    /**
     * @param FPDI|TCPDF $pdf
     */
    protected function pdfDrawGuidelines($pdf)
    {
        for ($pos = 5; $pos < 791; $pos = $pos + 5) {
            if (($pos % 100) == 0) {
                $pdf->SetDrawColor(0, 0, 200);
                $pdf->SetLineWidth(.7);
            } elseif (($pos % 50) == 0) {
                $pdf->SetDrawColor(200, 0, 0);
                $pdf->SetLineWidth(.4);
            } else {
                $pdf->SetDrawColor(128, 128, 128);
                $pdf->SetLineWidth(.05);
            }

            $pdf->Line(0, $pos, 611, $pos);
            if ($pos < 611) {
                $pdf->Line($pos, 0, $pos, 791);
            }
        }
    }

    /** @noinspection PhpUnusedParameterInspection
     * @param $model
     * @return string
     */
    protected function getFileNameFromModel($model)

The parameter $model is not used and could be removed.

    {
        return $this->getFileNameDefault();
    }

    /**
     * @param UploadedFile $uploadedFile
     * @return string|boolean
     */
    public function uploadFromRequest($uploadedFile)
    {
        $fileCollection = $this->getFiles();

        if (!$uploadedFile->isValid()) {
            return $uploadedFile->getErrorMessage();
        }

        try {
            $fileAdder = $this->addFile($uploadedFile);
            $newMedia = $fileAdder->getMedia();
        } catch (FileUnacceptableForCollection $exception) {
            return $exception->violations->getMessageString();
        }

        foreach ($fileCollection as $name => $media) {
            if ($name != $newMedia->getName()) {
                $media->delete();
            }
        }
        return $newMedia;
    }

    /**
     * @param MediaRepository $mediaRepository
     * @return MediaRepository
     */
    protected function hydrateMediaRepositoryCustom($mediaRepository)
    {
        $filesCollection = $mediaRepository->getCollection('files');
        $filesCollection->getConstraint()->mimeTypes = ['application/pdf'];
        return $mediaRepository;
    }
}