libredte\lib\Core\Package\Billing\Component\Document\Exception\BatchProcessorException

Complexity

Total Complexity

2

Size/Duplication

Total Lines	36
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getDocumentBatch()	0	3	1
A	__construct()	0	8	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\Document\Exception;

use libredte\lib\Core\Package\Billing\Component\Document\Contract\DocumentBatchInterface;
use Throwable;

/**
 * Excepción para el worker "billing.document.batch_processor".
 */
class BatchProcessorException extends DocumentException
{
    /**
     * Contenedor del lote de documentos que se estaba manipulando cuando se
     * generó la excepción.
     *
     * @var DocumentBatchInterface|null
     */
    protected ?DocumentBatchInterface $documentBatch = null;

    /**
     * Constructor de la excepción.
     *
     * @param string $message
     * @param integer $code
     * @param Throwable|null $previous
     * @param DocumentBatchInterface|null $documentBatch
     */
    public function __construct(
        string $message = '',
        int $code = 0,
        ?Throwable $previous = null,
        ?DocumentBatchInterface $documentBatch = null
    ) {
        parent::__construct($message, $code, $previous);
        $this->documentBatch = $documentBatch;
    }

    /**
     * Entrega, si está asignado, el contenedor del lote documentos.
     *
     * @return DocumentBatchInterface|null
     */
    public function getDocumentBatch(): ?DocumentBatchInterface
    {
        return $this->documentBatch;
    }
}