byrokrat\autogiro\Writer\TreeBuilder

Complexity

Total Complexity

16

Size/Duplication

Total Lines	283
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	21

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	reset()	0	15	1
A	buildTree()	0	12	3
A	__construct()	0	14	1
A	addCreateMandateRequest()	0	11	1
A	addDeleteMandateRequest()	0	9	1
A	addAcceptDigitalMandateRequest()	0	9	1
A	addRejectDigitalMandateRequest()	0	11	1
A	addUpdateMandateRequest()	0	11	1
A	addIncomingPaymentRequest()	0	18	1
A	addOutgoingPaymentRequest()	0	18	1
A	addImmediateIncomingPaymentRequest()	0	4	1
A	addImmediateOutgoingPaymentRequest()	0	4	1
A	addPaymentRequest()	0	22	1
A	addImmediatePaymentRequest()	0	15	1

<?php
/**
 * This file is part of byrokrat\autogiro.
 *
 * byrokrat\autogiro is free software: you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * byrokrat\autogiro is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with byrokrat\autogiro. If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright 2016-18 Hannes Forsgård
 */

declare(strict_types = 1);

namespace byrokrat\autogiro\Writer;

use byrokrat\autogiro\Layouts;
use byrokrat\autogiro\Tree\RecordNode;
use byrokrat\autogiro\Tree\Request\RequestOpening;
use byrokrat\autogiro\Tree\Request\AcceptDigitalMandateRequest;
use byrokrat\autogiro\Tree\Request\CreateMandateRequest;
use byrokrat\autogiro\Tree\Request\DeleteMandateRequest;
use byrokrat\autogiro\Tree\Request\RejectDigitalMandateRequest;
use byrokrat\autogiro\Tree\Request\UpdateMandateRequest;
use byrokrat\autogiro\Tree\Request\IncomingPaymentRequest;
use byrokrat\autogiro\Tree\Request\OutgoingPaymentRequest;
use byrokrat\autogiro\Tree\FileNode;
use byrokrat\autogiro\Tree\LayoutNode;
use byrokrat\autogiro\Tree\DateNode;
use byrokrat\autogiro\Tree\ImmediateDateNode;
use byrokrat\autogiro\Tree\TextNode;
use byrokrat\autogiro\Tree\BgcNumberNode;
use byrokrat\autogiro\Tree\BankgiroNode;
use byrokrat\autogiro\Tree\PayerNumberNode;
use byrokrat\autogiro\Tree\AccountNode;
use byrokrat\autogiro\Tree\IdNode;
use byrokrat\autogiro\Tree\IntervalNode;
use byrokrat\autogiro\Tree\RepetitionsNode;
use byrokrat\autogiro\Tree\AmountNode;
use byrokrat\banking\AccountNumber;
use byrokrat\banking\Bankgiro;
use byrokrat\id\IdInterface;
use byrokrat\amount\Currency\SEK;

/**
 * Build trees representing autogiro request files
 */
class TreeBuilder
{
    /**
     * Map layout names to record store array names
     */
    private const LAYOUT_TO_RECORD_STORE_MAP = [
        Layouts::LAYOUT_MANDATE_REQUEST => 'mandates',
        Layouts::LAYOUT_PAYMENT_REQUEST => 'payments',
        Layouts::LAYOUT_AMENDMENT_REQUEST => 'amendments'
    ];

    /**
     * @var RequestOpening Opening record used for each layout
     */
    private $opening;

    /**
     * @var RecordNode[] List of created mandate requests
     */
    private $mandates;

    /**
     * @var RecordNode[] List of created payment requests
     */
    private $payments;

    /**
     * @var RecordNode[] List of created amendment requests
     */
    private $amendments;

    /**
     * @var string Payee BGC customer number
     */
    private $bgcNr;

    /**
     * @var BankgiroNode Wrapper around payee bankgiro account number
     */
    private $payeeBgNode;

    /**
     * @var \DateTimeInterface Date of file creation
     */
    private $date;

    /**
     * @var IntervalFormatter
     */
    private $intervalFormatter;

    /**
     * @var RepititionsFormatter
     */
    private $repititionsFormatter;

    /**
     * @param string               $bgcNr                The BGC customer number of payee
     * @param Bankgiro             $bankgiro             Payee bankgiro account number
     * @param \DateTimeInterface   $date                 Creation date
     * @param IntervalFormatter    $intervalFormatter    Interval formatter
     * @param RepititionsFormatter $repititionsFormatter Repititions formatter
     */
    public function __construct(
        string $bgcNr,
        Bankgiro $bankgiro,
        \DateTimeInterface $date,
        IntervalFormatter $intervalFormatter,
        RepititionsFormatter $repititionsFormatter
    ) {
        $this->bgcNr = $bgcNr;
        $this->payeeBgNode = BankgiroNode::fromBankgiro($bankgiro);

It seems like \byrokrat\autogiro\Tree\BankgiroNode::fromBankgiro($bankgiro) of type object<self> is incompatible with the declared type object<byrokrat\autogiro\Tree\BankgiroNode> of property $payeeBgNode.

        $this->date = $date;
        $this->intervalFormatter = $intervalFormatter;
        $this->repititionsFormatter = $repititionsFormatter;
        $this->reset();
    }

    /**
     * Reset builder to initial state
     */
    public function reset(): void
    {
        $this->opening = new RequestOpening(
            0,
            DateNode::fromDate($this->date),
            new TextNode(0, 'AUTOGIRO'),
            new TextNode(0, str_pad('', 44)),
            new BgcNumberNode(0, $this->bgcNr),
            $this->payeeBgNode,
            [new TextNode(0, '  ')]
        );
        $this->mandates = [];
        $this->payments = [];
        $this->amendments = [];
    }

    /**
     * Add a new mandate request to tree
     */
    public function addCreateMandateRequest(string $payerNr, AccountNumber $account, IdInterface $id): void
    {
        $this->mandates[] = new CreateMandateRequest(
            0,
            $this->payeeBgNode,
            new PayerNumberNode(0, $payerNr),
            AccountNode::fromAccount($account),
            IdNode::fromId($id),
            [new TextNode(0, str_pad('', 24))]
        );
    }

    /**
     * Add a delete mandate request to tree
     */
    public function addDeleteMandateRequest(string $payerNr): void
    {
        $this->mandates[] = new DeleteMandateRequest(
            0,
            $this->payeeBgNode,
            new PayerNumberNode(0, $payerNr),
            [new TextNode(0, str_pad('', 52))]
        );
    }

    /**
     * Add an accept digital mandate request to tree
     */
    public function addAcceptDigitalMandateRequest(string $payerNr): void
    {
        $this->mandates[] = new AcceptDigitalMandateRequest(
            0,
            $this->payeeBgNode,
            new PayerNumberNode(0, $payerNr),
            [new TextNode(0, str_pad('', 52))]
        );
    }

    /**
     * Add a reject digital mandate request to tree
     */
    public function addRejectDigitalMandateRequest(string $payerNr): void
    {
        $this->mandates[] = new RejectDigitalMandateRequest(
            0,
            $this->payeeBgNode,
            new PayerNumberNode(0, $payerNr),
            new TextNode(0, str_pad('', 48)),
            new TextNode(0, 'AV'),
            [new TextNode(0, '  ')]
        );
    }

    /**
     * Add an update mandate request to tree
     */
    public function addUpdateMandateRequest(string $payerNr, string $newPayerNr): void
    {
        $this->mandates[] = new UpdateMandateRequest(
            0,
            $this->payeeBgNode,
            new PayerNumberNode(0, $payerNr),
            $this->payeeBgNode,
            new PayerNumberNode(0, $newPayerNr),
            [new TextNode(0, str_pad('', 26))]
        );
    }

    /**
     * Add an incoming payment request to tree
     */
    public function addIncomingPaymentRequest(
        string $payerNr,
        SEK $amount,
        \DateTimeInterface $date,
        string $ref,
        string $interval,
        int $repetitions
    ): void {
        $this->addPaymentRequest(
            IncomingPaymentRequest::CLASS,
            $payerNr,
            $amount,
            $date,
            $ref,
            $interval,
            $repetitions
        );
    }

    /**
     * Add an outgoing payment request to tree
     */
    public function addOutgoingPaymentRequest(
        string $payerNr,
        SEK $amount,
        \DateTimeInterface $date,
        string $ref,
        string $interval,
        int $repetitions
    ): void {
        $this->addPaymentRequest(
            OutgoingPaymentRequest::CLASS,
            $payerNr,
            $amount,
            $date,
            $ref,
            $interval,
            $repetitions
        );
    }

    /**
     * Add an incoming payment at next possible bank date request to tree
     */
    public function addImmediateIncomingPaymentRequest(string $payerNr, SEK $amount, string $ref): void
    {
        $this->addImmediatePaymentRequest(IncomingPaymentRequest::CLASS, $payerNr, $amount, $ref);
    }

    /**
     * Add an outgoing payment at next possible bank date request to tree
     */
    public function addImmediateOutgoingPaymentRequest(string $payerNr, SEK $amount, string $ref): void
    {
        $this->addImmediatePaymentRequest(OutgoingPaymentRequest::CLASS, $payerNr, $amount, $ref);
    }

    /**
     * Get the created request tree
     */
    public function buildTree(): FileNode
    {
        $layouts = [];

        foreach (self::LAYOUT_TO_RECORD_STORE_MAP as $layoutName => $recordStore) {
            if (!empty($this->$recordStore)) {
                $layouts[] = new LayoutNode($layoutName, $this->opening, ...$this->$recordStore);
            }
        }

        return new FileNode(...$layouts);
    }

    private function addPaymentRequest(
        string $classname,
        string $payerNr,
        SEK $amount,
        \DateTimeInterface $date,
        string $ref,
        string $interval,
        int $repetitions
    ): void {
        $this->payments[] = new $classname(
            0,
            DateNode::fromDate($date),
            new IntervalNode(0, $this->intervalFormatter->format($interval)),
            new RepetitionsNode(0, $this->repititionsFormatter->format($repetitions)),
            new TextNode(0, ' '),
            new PayerNumberNode(0, $payerNr),
            AmountNode::fromAmount($amount),
            $this->payeeBgNode,
            new TextNode(0, str_pad($ref, 16, ' ', STR_PAD_LEFT), '/^.{16}$/'),
            [new TextNode(0, str_pad('', 11))]
        );
    }

    private function addImmediatePaymentRequest(string $classname, string $payerNr, SEK $amount, string $ref): void
    {
        $this->payments[] = new $classname(
            0,
            new ImmediateDateNode,
            new IntervalNode(0, '0'),
            new RepetitionsNode(0, '   '),
            new TextNode(0, ' '),
            new PayerNumberNode(0, $payerNr),
            AmountNode::fromAmount($amount),
            $this->payeeBgNode,
            new TextNode(0, str_pad($ref, 16, ' ', STR_PAD_LEFT), '/^.{16}$/'),
            [new TextNode(0, str_pad('', 11))]
        );
    }
}