libredte\lib\Core\Package\Billing\Component\Identifier\Support\CafBag

Complexity

Total Complexity

10

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Test Coverage

Coverage

19.35%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getCaf()	0	3	1
A	ensureFoliosDisponibles()	0	6	2
A	getTipoDocumento()	0	3	1
A	getSiguienteFolio()	0	17	2
A	getEmisor()	0	3	1
A	setFoliosDisponibles()	0	5	1
A	getFoliosDisponibles()	0	5	1
A	__construct()	0	5	1

<?php

declare(strict_types=1);

/**
 * LibreDTE: Biblioteca PHP (Núcleo).
 * Copyright (C) LibreDTE <https://www.libredte.cl>
 *
 * 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 libredte\lib\Core\Package\Billing\Component\Identifier\Support;

use libredte\lib\Core\Package\Billing\Component\Document\Contract\TipoDocumentoInterface;
use libredte\lib\Core\Package\Billing\Component\Identifier\Contract\CafBagInterface;
use libredte\lib\Core\Package\Billing\Component\Identifier\Contract\CafInterface;
use libredte\lib\Core\Package\Billing\Component\Identifier\Exception\CafException;
use libredte\lib\Core\Package\Billing\Component\TradingParties\Contract\EmisorInterface;

/**
 * Contenedor de datos del archivo CAF de un documento tributario electrónico.
 *
 * Permite "mover" un CAF, junto a otros datos asociados, por métodos de
 * manera sencilla y, sobre todo, extensible.
 */
class CafBag implements CafBagInterface
{
    /**
     * Listado de folios disponibles en el CAF.
     *
     * Estos son los folios que se pueden usar.
     *
     * @var int[]
     */
    private array $foliosDisponibles;

    /**
     * Constructor de la bolsa del CAF.
     *
     * @param CafInterface $caf
     * @param EmisorInterface $emisor
     * @param TipoDocumentoInterface $tipoDocumento
     */
    public function __construct(
        private readonly CafInterface $caf,
        private readonly EmisorInterface $emisor,
        private readonly TipoDocumentoInterface $tipoDocumento
    ) {
    }

    /**
     * {@inheritDoc}
     */
    public function getCaf(): CafInterface
    {
        return $this->caf;
    }

    /**
     * {@inheritDoc}
     */
    public function getEmisor(): EmisorInterface
    {
        return $this->emisor;
    }

    /**
     * {@inheritDoc}
     */
    public function getTipoDocumento(): TipoDocumentoInterface
    {
        return $this->tipoDocumento;
    }

    /**
     * {@inheritDoc}
     */
    public function setFoliosDisponibles(array $foliosDisponibles): static
    {
        $this->foliosDisponibles = $foliosDisponibles;

        return $this;
    }

    /**
     * {@inheritDoc}
     */
    public function getFoliosDisponibles(): array
    {
        $this->ensureFoliosDisponibles();

        return $this->foliosDisponibles;
    }

    /**
     * {@inheritDoc}
     */
    public function getSiguienteFolio(): int
    {
        $this->ensureFoliosDisponibles();

        $folio = array_shift($this->foliosDisponibles);

        if ($folio === null) {
            throw new CafException(sprintf(
                'El CAF del documento %s de %s que comienza en %d y termina en %d no tiene folios disponibles.',
                $this->getTipoDocumento()->getNombre(),
                $this->getEmisor()->getRazonSocial(),
                $this->getCaf()->getFolioDesde(),
                $this->getCaf()->getFolioHasta()
            ));
        }

        return $folio;
    }

    /**
     * Asegura que existan folios disponibles asignados.
     *
     * Si no existen asignados se asignan según el rango del CAF.
     *
     * @return void
     */
    private function ensureFoliosDisponibles(): void
    {
        if (!isset($this->foliosDisponibles)) {
            $desde = $this->getCaf()->getFolioDesde();
            $hasta = $this->getCaf()->getFolioHasta();
            $this->foliosDisponibles = range($desde, $hasta);
        }
    }
}