Passed
Push — master ( 3bcc1c...6ab367 )
by Esteban De La Fuente
11:28
created

DocumentoRenderer::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 2
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
nc 1
nop 1
dl 0
loc 3
ccs 2
cts 2
cp 1
crap 1
rs 10
c 1
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
/**
6
 * LibreDTE: Biblioteca PHP (Núcleo).
7
 * Copyright (C) LibreDTE <https://www.libredte.cl>
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
11
 * por la Fundación para el Software Libre, ya sea la versión 3 de la Licencia,
12
 * o (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
20
 * GNU junto a este programa.
21
 *
22
 * En caso contrario, consulte <http://www.gnu.org/licenses/agpl.html>.
23
 */
24
25
namespace libredte\lib\Core\Sii\Dte\Documento\Renderer;
26
27
use Illuminate\Support\Str;
28
use libredte\lib\Core\Service\ArrayDataProvider;
29
use libredte\lib\Core\Service\DataProviderInterface;
30
use libredte\lib\Core\Sii\Dte\Documento\AbstractDocumento;
31
use libredte\lib\Core\Sii\Dte\Documento\Builder\DocumentoFactory;
32
33
/**
34
 * Renderizador de la representación gráfica de un DTE.
35
 */
36
class DocumentoRenderer
37
{
38
    /**
39
     * Renderizador por defecto que se debe utilizar.
40
     *
41
     * @var string
42
     */
43
    private string $defaultRenderer = EstandarRenderer::class;
44
45
    /**
46
     * Listado de renderizadores disponibles (ya cargados).
47
     *
48
     * @var array
49
     */
50
    private array $renderers = [];
51
52
    /**
53
     * Proveedor de datos.
54
     *
55
     * @var DataProviderInterface
56
     */
57
    protected DataProviderInterface $dataProvider;
58
59
    /**
60
     * Constructor de la clase.
61
     *
62
     * @param ?DataProviderInterface $dataProvider Proveedor de datos.
63
     */
64 98
    public function __construct(?DataProviderInterface $dataProvider = null)
65
    {
66 98
        $this->dataProvider = $dataProvider ?? new ArrayDataProvider();
67
    }
68
69
    /**
70
     * Renderiza el documento a partir del DTE oficial en XML.
71
     *
72
     * Este método utiliza un XML completo y real de un DTE.
73
     *
74
     * @param string $data Datos en formato XML del DTE.
75
     * @param array $options Opciones para el renderizado.
76
     * @return string
77
     */
78
    public function renderFromXml(
79
        string $data,
80
        array $options = []
81
    ): string {
82
        $factory = new DocumentoFactory($this->dataProvider);
83
        $documento = $factory->loadFromXml($data);
84
85
        return $this->renderFromDocumento($documento, $options);
86
    }
87
88
    /**
89
     * Renderiza el documento a partir de la instancia del documento.
90
     *
91
     * @param AbstractDocumento $documento Instancia del DTE.
92
     * @param array $options Opciones para el renderizado.
93
     * @return string
94
     */
95 98
    public function renderFromDocumento(
96
        AbstractDocumento $documento,
97
        array $options = []
98
    ): string {
99
        // Nnormalizar las opciones.
100 98
        $options = $this->normalizeOptions($options);
101
102
        // Crear el renderizador de los datos del DTE.
103 98
        $renderer = $this->getRendererInstance($options['renderer']);
104
105
        // Renderizar el documento.
106 98
        $data = $renderer->render($documento, $options);
107
108
        // Entregar los datos renderizados.
109 98
        return $data;
110
    }
111
112
    /**
113
     * Normaliza las opciones para el renderizado del documento.
114
     *
115
     * Este método:
116
     *
117
     *   - Asigna el renderizador por defecto.
118
     *   - Determina el nombre de la clase si se pasó como código de renderizado.
119
     *
120
     * @param array $options Opciones sin normalizar.
121
     * @return array Opciones normalizadas.
122
     */
123 98
    private function normalizeOptions(array $options): array
124
    {
125
        // Opciones por defecto para el renderizado.
126 98
        $options = array_merge([
127 98
            'renderer' => $this->defaultRenderer,
128 98
        ], $options);
129
130
        // Si el renderizador tiene "." es el código del renderizador con el
131
        // formato que el renderizador debe utilizar.
132 98
        if (str_contains($options['renderer'], '.')) {
133
            $aux = explode('.', $options['renderer']);
134
            $options['renderer'] = $this->getRendererClass($aux[0]);
135
            $options['format'] = $aux[1];
136
        }
137
138
        // Entregar las opciones que se normalizaron.
139 98
        return $options;
140
    }
141
142
    /**
143
     * Obtener el objeto que se encarga de la renderización del documento.
144
     *
145
     * @param string $render Clase del renderizador que se debe utilizar.
146
     * @return AbstractRenderer
147
     */
148 98
    private function getRendererInstance(string $renderer): AbstractRenderer
149
    {
150
        // Si no existe el renderizador se crea.
151 98
        if (!isset($this->renderers[$renderer])) {
152 98
            $this->renderers[$renderer] = new $renderer($this->dataProvider);
153
        }
154
155
        // Entregar el renderizador solicitado.
156 98
        return $this->renderers[$renderer];
157
    }
158
159
    /**
160
     * Determina la clase del renderer que se está solicitando.
161
     *
162
     * @param string $renderer Nombre del renderer solicitado.
163
     * @return string FQCN de la clase del renderer solicitado.
164
     */
165
    private function getRendererClass(string $renderer): string
166
    {
167
        // Determinar nombre del archivo PHP y de la clase.
168
        $class = Str::studly($renderer) . 'Renderer';
169
        $file = __DIR__ . '/' . $class . '.php';
170
171
        // La clase existe en el namespace actual.
172
        if (file_exists($file)) {
173
            $class = __NAMESPACE__ . '\\' . $class;
174
        }
175
        // La clase podría existir en lib-pro.
176
        else {
177
            $class = str_replace('\\Core\\', '\\Pro\\', __NAMESPACE__)
178
                . '\\' . $class
179
            ;
180
        }
181
182
        // Entregar el FQCN de la clase del renderer buscado.
183
        return $class;
184
    }
185
}
186