libredte /
libredte-lib-core
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like EnvioDte often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use EnvioDte, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class EnvioDte extends \sasco\LibreDTE\Sii\Base\Envio |
||
| 32 | { |
||
| 33 | |||
| 34 | private $dtes = []; ///< Objetos con los DTE que se enviarán |
||
| 35 | private $config = [ // 0: DTE, 1: boleta |
||
| 36 | 'SubTotDTE_max' => [20, 2], ///< máxima cantidad de tipos de documentos en el envío |
||
| 37 | 'DTE_max' => [2000, 1000], ///< máxima cantidad de DTE en un envío |
||
| 38 | 'tipos' => ['EnvioDTE', 'EnvioBOLETA'], ///< Tag para el envío, según si son Boletas o no |
||
| 39 | 'schemas' => ['EnvioDTE_v10', 'EnvioBOLETA_v11'], ///< Schema (XSD) que se deberá usar para validar según si son boletas o no |
||
| 40 | ]; ///< Configuración/reglas para el documento XML |
||
| 41 | private $tipo = null; ///< =0 DTE, =1 boleta |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Método que agrega un DTE al listado que se enviará |
||
| 45 | * @param DTE Objeto del DTE |
||
| 46 | * @return =true si se pudo agregar el DTE o =false si no se agregó por exceder el límite de un envío |
||
|
|
|||
| 47 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 48 | * @version 2015-12-11 |
||
| 49 | */ |
||
| 50 | public function agregar(Dte $DTE) |
||
| 71 | |||
| 72 | /** |
||
| 73 | * Método para asignar la caratula |
||
| 74 | * @param caratula Arreglo con datos del envío: RutEnvia, FchResol y NroResol |
||
| 75 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 76 | * @version 2015-12-11 |
||
| 77 | */ |
||
| 78 | public function setCaratula(array $caratula) |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Método que realiza el envío del sobre con el o los DTEs al SII |
||
| 115 | * @return Track ID del envío o =false si hubo algún problema al enviar el documento |
||
| 116 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 117 | * @version 2019-12-10 |
||
| 118 | */ |
||
| 119 | public function enviar($retry = null, $gzip = false) |
||
| 120 | { |
||
| 121 | // si es boleta no se envía al SII |
||
| 122 | if ($this->tipo) { |
||
| 123 | return false; |
||
| 124 | } |
||
| 125 | // enviar al SII |
||
| 126 | return parent::enviar($retry, $gzip); |
||
| 127 | } |
||
| 128 | |||
| 129 | /** |
||
| 130 | * Método que genera el XML para el envío del DTE al SII |
||
| 131 | * @return XML con el envio del DTE firmado o =false si no se pudo generar o firmar el envío |
||
| 132 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 133 | * @version 2016-08-06 |
||
| 134 | */ |
||
| 135 | public function generar() |
||
| 176 | |||
| 177 | /** |
||
| 178 | * Método que obtiene los datos para generar los tags SubTotDTE |
||
| 179 | * @return Arreglo con los datos para generar los tags SubTotDTE |
||
| 180 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 181 | * @version 2015-09-02 |
||
| 182 | */ |
||
| 183 | private function getSubTotDTE() |
||
| 200 | |||
| 201 | /** |
||
| 202 | * Método que carga un XML de EnvioDte y asigna el objeto XML correspondiente |
||
| 203 | * para poder obtener los datos del envío |
||
| 204 | * @param xml_data XML con tag inicial: EnvioDTE, EnvioBOLETA, DTE o SetDTE |
||
| 205 | * @return Objeto XML |
||
| 206 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 207 | * @version 2020-04-22 |
||
| 208 | */ |
||
| 209 | public function loadXML($xml_data) |
||
| 260 | |||
| 261 | /** |
||
| 262 | * Método que entrega un arreglo con los datos de la carátula del envío |
||
| 263 | * @return Arreglo con datos de carátula |
||
| 264 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 265 | * @version 2015-12-11 |
||
| 266 | */ |
||
| 267 | public function getCaratula() |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Método que entrega el ID de SetDTE |
||
| 274 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 275 | * @version 2015-12-11 |
||
| 276 | */ |
||
| 277 | public function getID() |
||
| 281 | |||
| 282 | /** |
||
| 283 | * Método que entrega el DigestValue de la firma del envío |
||
| 284 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 285 | * @version 2015-12-11 |
||
| 286 | */ |
||
| 287 | public function getDigest() |
||
| 291 | |||
| 292 | /** |
||
| 293 | * Método que entrega el rut del emisor del envío |
||
| 294 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 295 | * @version 2015-09-07 |
||
| 296 | */ |
||
| 297 | public function getEmisor() |
||
| 302 | |||
| 303 | /** |
||
| 304 | * Método que entrega el rut del receptor del envío |
||
| 305 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 306 | * @version 2015-09-07 |
||
| 307 | */ |
||
| 308 | public function getReceptor() |
||
| 313 | |||
| 314 | /** |
||
| 315 | * Método que entrega la fecha del DTE más antiguo del envio |
||
| 316 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 317 | * @version 2015-12-12 |
||
| 318 | */ |
||
| 319 | public function getFechaEmisionInicial() |
||
| 328 | |||
| 329 | /** |
||
| 330 | * Método que entrega la fecha del DTE más nuevo del envio |
||
| 331 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 332 | * @version 2015-12-12 |
||
| 333 | */ |
||
| 334 | public function getFechaEmisionFinal() |
||
| 343 | |||
| 344 | /** |
||
| 345 | * Método que entrega el arreglo con los objetos DTE del envío |
||
| 346 | * @return Arreglo de objetos DTE |
||
| 347 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 348 | * @version 2016-11-21 |
||
| 349 | */ |
||
| 350 | public function getDocumentos($c14n = true) |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Método que entrega el objeto DTE solicitado del envío |
||
| 374 | * @return Objeto DTE |
||
| 375 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 376 | * @version 2016-11-21 |
||
| 377 | */ |
||
| 378 | public function getDocumento($emisor, $dte, $folio) |
||
| 403 | |||
| 404 | /** |
||
| 405 | * Método que indica si es EnvioDTE o EnvioBOLETA |
||
| 406 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 407 | * @version 2018-08-27 |
||
| 408 | */ |
||
| 409 | public function esBoleta() |
||
| 413 | |||
| 414 | /** |
||
| 415 | * Método que determina el estado de validación sobre el envío |
||
| 416 | * @param datos Arreglo con datos para hacer las validaciones |
||
| 417 | * @return Código del estado de la validación |
||
| 418 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 419 | * @version 2019-07-03 |
||
| 420 | */ |
||
| 421 | public function getEstadoValidacion(array $datos = null) |
||
| 434 | |||
| 435 | /** |
||
| 436 | * Método que indica si la firma del documento es o no válida |
||
| 437 | * @return =true si la firma del documento del envío es válida, =null si no se pudo determinar |
||
| 438 | * @author Esteban De La Fuente Rubio, DeLaF (esteban[at]sasco.cl) |
||
| 439 | * @version 2017-04-07 |
||
| 440 | */ |
||
| 441 | public function checkFirma() |
||
| 458 | |||
| 459 | } |
||
| 460 |
Loading history...
This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types.