Application\Handler\ExportTransactionLinesHandler

Complexity

Total Complexity

18

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Test Coverage

Coverage

57.29%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
C	writeData()	0	80	14
A	getHeaders()	0	16	1
A	writeFooter()	0	34	1
A	getModelClass()	0	3	1
A	__construct()	0	12	1

<?php

declare(strict_types=1);

namespace Application\Handler;

use Application\Model\TransactionLine;
use Money\Currencies\ISOCurrencies;
use Money\Formatter\DecimalMoneyFormatter;
use PhpOffice\PhpSpreadsheet\Cell\Coordinate;
use PhpOffice\PhpSpreadsheet\Worksheet\Worksheet;

class ExportTransactionLinesHandler extends AbstractExcel
{
    /**
     * @var DecimalMoneyFormatter
     */
    private $moneyFormatter;

    /**
     * ReportTransactionsAction constructor.
     */
    public function __construct(string $hostname)
    {
        parent::__construct($hostname, 'transactionLines');

        $currencies = new ISOCurrencies();
        $this->moneyFormatter = new DecimalMoneyFormatter($currencies);

        $this->outputFileName = sprintf('Ichtus_compta_ecritures_%s.xlsx', date('Y-m-d-H:i:s'));

        $sheet = $this->workbook->getActiveSheet();
        $sheet->setTitle('Compta Écritures');
        $sheet->getDefaultRowDimension()->setRowHeight(20);
    }

    /**
     * The model class name
     */
    protected function getModelClass(): string
    {
        return TransactionLine::class;
    }

    /**
     * @param TransactionLine[] $items
     */
    protected function writeData(Worksheet $sheet, array $items): void
    {
        $sheet->setShowGridlines(false);
        $initialColumn = $maxColumn = $this->column;

The assignment to $maxColumn is dead and can be removed.

        $currentTransactionRowStart = null;
        $currentTransactionId = null;

        $mergeRowsFromColumns = [
            $initialColumn + 1, // Transaction.ID
            $initialColumn + 2, // Transaction.name
            $initialColumn + 3, // Transaction.remarks
            $initialColumn + 4, // Transaction.internalRemarks
        ];

        foreach ($items as $index => $line) {
            $transaction = $line->getTransaction();
            $transactionId = $transaction->getId();

            if (!$currentTransactionId) {
                $currentTransactionId = $transactionId;
                $currentTransactionRowStart = $this->row;
            } elseif ($transactionId !== $currentTransactionId) {
                // Current line starts a new transaction
                if ($currentTransactionRowStart < $this->row - 1) {
                    // Multi-line transaction
                    // Merge cells that have the same value because from the same transaction
                    foreach ($mergeRowsFromColumns as $column) {
                        $sheet->mergeCellsByColumnAndRow($column, $currentTransactionRowStart, $column, $this->row - 1);
                    }
                }
                $currentTransactionRowStart = $this->row;
                $currentTransactionId = $transactionId;
            }

            // Date
            $this->write($sheet, $line->getTransactionDate()->format('d.m.Y'));

            // Transaction.ID
            $this->write($sheet, $transactionId);
            $url = 'https://' . $this->hostname . '/admin/transaction/%u';
            $sheet->getCellByColumnAndRow($this->column - 1, $this->row)->getHyperlink()->setUrl(sprintf($url, $transactionId));
            // Transaction.name
            $this->write($sheet, $transaction->getName());
            // Transaction.remarks
            $this->write($sheet, $transaction->getRemarks());
            // Transaction.internalRemarks
            $this->write($sheet, $transaction->getInternalRemarks());

            // TransactionLine.name
            $this->write($sheet, $line->getName());
            // TransactionLine.remarks
            $this->write($sheet, $line->getRemarks());
            // Bookable.name
            $this->write($sheet, $line->getBookable() ? $line->getBookable()->getName() : '');
            // Debit account
            $debit = $line->getDebit();
            $this->write($sheet, $debit ? implode(' ', [$debit->getCode(), $debit->getName()]) : '');
            // Credit account
            $credit = $line->getCredit();
            $this->write($sheet, $credit ? implode(' ', [$credit->getCode(), $credit->getName()]) : '');
            // Debit amount
            $this->write($sheet, $debit ? $this->moneyFormatter->format($line->getBalance()) : '');
            // Credit amount
            $this->write($sheet, $credit ? $this->moneyFormatter->format($line->getBalance()) : '');
            // Reconciled
            $this->write($sheet, $line->isReconciled() ? '✔️' : '');

            $maxColumn = $this->column - 1;

            $range = Coordinate::stringFromColumnIndex($initialColumn) . $this->row . ':' . Coordinate::stringFromColumnIndex($maxColumn) . $this->row;
            // Thicker horizontal delimiter between lines of different transactions
            if ($index === max(array_keys($items)) || $line->getTransaction()->getId() !== $items[$index + 1]->getTransaction()->getId()) {
                $borderBottom = self::$bordersBottom;
            } else {
                $borderBottom = self::$bordersBottomLight;
            }
            $sheet->getStyle($range)->applyFromArray($borderBottom);

            $this->column = $initialColumn;
            ++$this->row;
        }
    }

    protected function getHeaders(): array
    {
        return [
            ['label' => 'Date', 'width' => 12, 'formats' => [self::$dateFormat]],
            ['label' => 'ID', 'width' => 7, 'formats' => [self::$headerFormat, self::$centerFormat]],
            ['label' => 'Transaction', 'width' => 25, 'formats' => [self::$wrapFormat]],
            ['label' => 'Remarques', 'width' => 25, 'formats' => [self::$wrapFormat]],
            ['label' => 'Remarques internes', 'width' => 25, 'formats' => [self::$wrapFormat]],
            ['label' => 'Écriture', 'width' => 25, 'formats' => [self::$wrapFormat]],
            ['label' => 'Remarques', 'width' => 25, 'formats' => [self::$wrapFormat]],
            ['label' => 'Réservable', 'width' => 30, 'formats' => [self::$wrapFormat]],
            ['label' => 'Compte débit', 'width' => 30, 'formats' => [self::$wrapFormat]],
            ['label' => 'Compte crédit', 'width' => 30, 'formats' => [self::$wrapFormat]],
            ['label' => 'Montant débit', 'width' => 20, 'formats' => [self::$headerFormat]],
            ['label' => 'Montant crédit', 'width' => 20, 'formats' => [self::$headerFormat]],
            ['label' => 'Pointé', 'width' => 15, 'formats' => [self::$centerFormat]],
        ];
    }

    /**
     * @param TransactionLine[] $items
     */
    protected function writeFooter(Worksheet $sheet, array $items): void
    {
        $initialColumn = $this->column;

        // Date
        $this->write($sheet, '');
        // ID
        $this->write($sheet, '');
        // Transaction.name
        $this->write($sheet, '');
        // Transaction.remarks
        $this->write($sheet, '');
        // Internal remarks
        $this->write($sheet, '');
        // TransactionLine.name
        $this->write($sheet, '');
        // Remarks
        $this->write($sheet, '');
        // Bookable.name
        $this->write($sheet, '');
        // Debit account
        $this->write($sheet, '');
        // Credit account
        $this->write($sheet, '');
        // Debit amount
        $this->write($sheet, '=SUBTOTAL(9,' . Coordinate::stringFromColumnIndex($this->column) . '2:' . Coordinate::stringFromColumnIndex($this->column) . ($this->row - 1) . ')');
        // Credit amount
        $this->write($sheet, '=SUBTOTAL(9,' . Coordinate::stringFromColumnIndex($this->column) . '2:' . Coordinate::stringFromColumnIndex($this->column) . ($this->row - 1) . ')');
        // Reconciled
        $this->write($sheet, '');

        // Apply style
        $range = Coordinate::stringFromColumnIndex($initialColumn) . $this->row . ':' . Coordinate::stringFromColumnIndex($this->column - 1) . $this->row;
        $sheet->getStyle($range)->applyFromArray(self::$totalFormat);
    }
}