RendererWorker::renderPdf() - Code Metrics - Inspection of "Se agrega componente para renderizado de plantilla..." - derafu/derafu-lib-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 4d7c06...5132bf )

by Esteban De La Fuente

created 2025-01-03 19:33 UTC

RendererWorker::renderPdf() A

↳ Parent: RendererWorker

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	4
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	11
ccs	0
cts	5
cp	0
crap	2
rs	10

<?php

declare(strict_types=1);

/**
 * Derafu: Biblioteca PHP (Núcleo).
 * Copyright (C) Derafu <https://www.derafu.org>
 *
 * Este programa es software libre: usted puede redistribuirlo y/o modificarlo
 * bajo los términos de la Licencia Pública General Affero de GNU publicada por
 * la Fundación para el Software Libre, ya sea la versión 3 de la Licencia, o
 * (a su elección) cualquier versión posterior de la misma.
 *
 * Este programa se distribuye con la esperanza de que sea útil, pero SIN
 * GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
 * PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la Licencia Pública
 * General Affero de GNU para obtener una información más detallada.
 *
 * Debería haber recibido una copia de la Licencia Pública General Affero de GNU
 * junto a este programa.
 *
 * En caso contrario, consulte <http://www.gnu.org/licenses/agpl.html>.
 */

namespace Derafu\Lib\Core\Package\Prime\Component\Template\Worker;

use Derafu\Lib\Core\Foundation\Abstract\AbstractWorker;
use Derafu\Lib\Core\Package\Prime\Component\Template\Contract\RendererWorkerInterface;
use Mpdf\Mpdf;
use Mpdf\Output\Destination;
use Twig\Environment;
use Twig\Loader\FilesystemLoader;

/**
 * Worker de renderización de plantillas.
 *
 * Permite renderizar plantillas Twig a HTML y PDF.
 *
 * TODO: Ordenar código, usar configuraciones/opciones y separar en estrategias.
 */
class RendererWorker extends AbstractWorker implements RendererWorkerInterface
{
    /**
     * Formato por defecto que se debe utilizar.
     *
     * @var string
     */
    private string $defaultFormat = 'pdf';

    /**
     * Rutas donde están las plantillas.
     *
     * @var array
     */
    private array $paths = [];

    /**
     * Cargador de plantillas mediante el sistema de archivos para Twig.
     */
    private FilesystemLoader $filesystemLoader;

    /**
     * Renderizador de plantillas HTML con Twig.
     *
     * @var Environment
     */
    private Environment $twig;

    /**
     * Constructor del worker.
     *
     * @param string|array $paths Rutas dónde se buscarán las plantillas.
     */
    public function __construct(string|array $paths = [])
    {
        $this->paths = is_string($paths) ? [$paths] : $paths;

    }

    /**
     * {@inheritdoc}
     */
    public function render(string $template, array $data = []): string
    {
        // Formato en el que se renderizará la plantilla.
        $format = $data['options']['format'] ?? $this->defaultFormat;

        // Renderizar HTML de la plantilla Twig.
        $html = $this->renderHtml($template, $data);

        // Si el formato solicitado es HTML se retorna directamente.
        if ($format === 'html') {
            return $html;
        }

        // Renderizar el PDF a partir del HTML.
        $configPdf = $data['options']['config']['pdf'] ?? [];
        $pdf = $this->renderPdf($html, $configPdf);

        // Entregar el contenido del PDF renderizado.
        return $pdf;
    }

    /**
     * Entrega la instancia de Twig.
     *
     * Este método evita crearla en el constructor y se crea solo cuando
     * realmente se utiliza. Útil porque los workers son lazy services.
     *
     * @return Environment
     */
    private function getTwig(): Environment
    {
        if (!isset($this->twig)) {
            $this->filesystemLoader = new FilesystemLoader($this->paths);
            $this->twig = new Environment($this->filesystemLoader);
        }

        return $this->twig;
    }

    /**
     * Renderiza una plantilla Twig en HTML.
     *
     * @param string $template Plantilla Twig a renderizar.
     * @param array $data Datos que se pasarán a la plantilla Twig.
     * @return string Código HTML con el renderizado de la plantilla Twig.
     */
    private function renderHtml(string $template, array $data): string
    {
        // Resolver plantilla.
        $template = $this->resolveTemplate($template);

        // Renderizar la plantilla.
        return $this->getTwig()->render($template, $data);
    }

    /**
     * Renderiza un HTML en un documento PDF.
     *
     * El renderizado se realiza a partir de un HTML previamente renderizado que
     * será pasado a PDF.
     */
    private function renderPdf(string $html, array $config): string
    {
        // Generar el PDF con mPDF.
        $mpdf = new Mpdf();
        $mpdf->WriteHTML($html);

        // Obtener el contenido del PDF.
        $pdf = $mpdf->Output('', Destination::STRING_RETURN);

        // Entregar el contenido del PDF.
        return $pdf;
    }

    /**
     * Resuelve la plantilla que se está solicitando.
     *
     * Se encarga de:
     *
     *   - Agregar la extensión a la plantilla.
     *   - Agregar el directorio si se pasó una ruta absoluta de la plantilla.
     *
     * @param string $template
     * @return string
     */
    private function resolveTemplate(string $template): string
    {
        // Agregar extensión.
        if (!str_ends_with($template, '.html.twig')) {
            $template .= '.html.twig';
        }

        // Agregar el directorio si se pasó una ruta absoluta.
        if ($template[0] === '/') {
            $dir = dirname($template);
            $this->filesystemLoader->addPath($dir);
            $template = basename($template);
        }

        // Entregar nombre de la plantilla.
        return $template;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/**
6			* Derafu: Biblioteca PHP (Núcleo).
7			* Copyright (C) Derafu <https://www.derafu.org>
8			*
9			* Este programa es software libre: usted puede redistribuirlo y/o modificarlo
10			* bajo los términos de la Licencia Pública General Affero de GNU publicada por
11			* la Fundación para el Software Libre, ya sea la versión 3 de la Licencia, o
12			* (a su elección) cualquier versión posterior de la misma.
13			*
14			* Este programa se distribuye con la esperanza de que sea útil, pero SIN
15			* GARANTÍA ALGUNA; ni siquiera la garantía implícita MERCANTIL o de APTITUD
16			* PARA UN PROPÓSITO DETERMINADO. Consulte los detalles de la Licencia Pública
17			* General Affero de GNU para obtener una información más detallada.
18			*
19			* Debería haber recibido una copia de la Licencia Pública General Affero de GNU
20			* junto a este programa.
21			*
22			* En caso contrario, consulte <http://www.gnu.org/licenses/agpl.html>.
23			*/
24
25			namespace Derafu\Lib\Core\Package\Prime\Component\Template\Worker;
26
27			use Derafu\Lib\Core\Foundation\Abstract\AbstractWorker;
28			use Derafu\Lib\Core\Package\Prime\Component\Template\Contract\RendererWorkerInterface;
29			use Mpdf\Mpdf;
30			use Mpdf\Output\Destination;
31			use Twig\Environment;
32			use Twig\Loader\FilesystemLoader;
33
34			/**
35			* Worker de renderización de plantillas.
36			*
37			* Permite renderizar plantillas Twig a HTML y PDF.
38			*
39			* TODO: Ordenar código, usar configuraciones/opciones y separar en estrategias.
40			*/
41			class RendererWorker extends AbstractWorker implements RendererWorkerInterface
42			{
43			/**
44			* Formato por defecto que se debe utilizar.
45			*
46			* @var string
47			*/
48			private string $defaultFormat = 'pdf';
49
50			/**
51			* Rutas donde están las plantillas.
52			*
53			* @var array
54			*/
55			private array $paths = [];
56
57			/**
58			* Cargador de plantillas mediante el sistema de archivos para Twig.
59			*/
60			private FilesystemLoader $filesystemLoader;
61
62			/**
63			* Renderizador de plantillas HTML con Twig.
64			*
65			* @var Environment
66			*/
67			private Environment $twig;
68
69			/**
70			* Constructor del worker.
71			*
72			* @param string\|array $paths Rutas dónde se buscarán las plantillas.
73			*/
74			public function __construct(string\|array $paths = [])
75			{
76			$this->paths = is_string($paths) ? [$paths] : $paths;
			0 ignored issues – show introduced 2025-01-03 19:37 UTC by Report Bug Copy Issue Report The condition `is_string($paths)` is always `false`. Loading history...
77			}
78
79			/**
80			* {@inheritdoc}
81			*/
82			public function render(string $template, array $data = []): string
83			{
84			// Formato en el que se renderizará la plantilla.
85			$format = $data['options']['format'] ?? $this->defaultFormat;
86
87			// Renderizar HTML de la plantilla Twig.
88			$html = $this->renderHtml($template, $data);
89
90			// Si el formato solicitado es HTML se retorna directamente.
91			if ($format === 'html') {
92			return $html;
93			}
94
95			// Renderizar el PDF a partir del HTML.
96			$configPdf = $data['options']['config']['pdf'] ?? [];
97			$pdf = $this->renderPdf($html, $configPdf);
98
99			// Entregar el contenido del PDF renderizado.
100			return $pdf;
101			}
102
103			/**
104			* Entrega la instancia de Twig.
105			*
106			* Este método evita crearla en el constructor y se crea solo cuando
107			* realmente se utiliza. Útil porque los workers son lazy services.
108			*
109			* @return Environment
110			*/
111			private function getTwig(): Environment
112			{
113			if (!isset($this->twig)) {
114			$this->filesystemLoader = new FilesystemLoader($this->paths);
115			$this->twig = new Environment($this->filesystemLoader);
116			}
117
118			return $this->twig;
119			}
120
121			/**
122			* Renderiza una plantilla Twig en HTML.
123			*
124			* @param string $template Plantilla Twig a renderizar.
125			* @param array $data Datos que se pasarán a la plantilla Twig.
126			* @return string Código HTML con el renderizado de la plantilla Twig.
127			*/
128			private function renderHtml(string $template, array $data): string
129			{
130			// Resolver plantilla.
131			$template = $this->resolveTemplate($template);
132
133			// Renderizar la plantilla.
134			return $this->getTwig()->render($template, $data);
135			}
136
137			/**
138			* Renderiza un HTML en un documento PDF.
139			*
140			* El renderizado se realiza a partir de un HTML previamente renderizado que
141			* será pasado a PDF.
142			*/
143			private function renderPdf(string $html, array $config): string
144			{
145			// Generar el PDF con mPDF.
146			$mpdf = new Mpdf();
147			$mpdf->WriteHTML($html);
148
149			// Obtener el contenido del PDF.
150			$pdf = $mpdf->Output('', Destination::STRING_RETURN);
151
152			// Entregar el contenido del PDF.
153			return $pdf;
154			}
155
156			/**
157			* Resuelve la plantilla que se está solicitando.
158			*
159			* Se encarga de:
160			*
161			* - Agregar la extensión a la plantilla.
162			* - Agregar el directorio si se pasó una ruta absoluta de la plantilla.
163			*
164			* @param string $template
165			* @return string
166			*/
167			private function resolveTemplate(string $template): string
168			{
169			// Agregar extensión.
170			if (!str_ends_with($template, '.html.twig')) {
171			$template .= '.html.twig';
172			}
173
174			// Agregar el directorio si se pasó una ruta absoluta.
175			if ($template[0] === '/') {
176			$dir = dirname($template);
177			$this->filesystemLoader->addPath($dir);
178			$template = basename($template);
179			}
180
181			// Entregar nombre de la plantilla.
182			return $template;
183			}
184			}
185

derafu / derafu-lib-core

Push — master ( 4d7c06...5132bf )

RendererWorker::renderPdf() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like