Transaction::setExpenseClaim() - Code Metrics - Inspection of "PHP 7.4 on Scrutinizer" - Ecodev/my-ichtus - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Push — master ( 51347b...4787ce )

by Adrien

created 2020-05-13 03:26 UTC

Transaction::setExpenseClaim() A

↳ Parent: Transaction

Complexity

Conditions	3
Paths	4

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	5
nc	4
nop	1
dl	0
loc	10
ccs	6
cts	6
cp	1
crap	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Application\Model;

use Application\Traits\HasAutomaticUnsignedBalance;
use Application\Traits\HasRemarks;
use Cake\Chronos\Chronos;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Ecodev\Felix\Format;
use Ecodev\Felix\Model\Traits\HasInternalRemarks;
use Ecodev\Felix\Model\Traits\HasName;
use Money\Money;

/**
 * An accounting journal entry (simple or compound)
 *
 * @ORM\Entity(repositoryClass="Application\Repository\TransactionRepository")
 * @ORM\HasLifecycleCallbacks
 */
class Transaction extends AbstractModel
{
    use HasName;
    use HasRemarks;
    use HasInternalRemarks;
    use HasAutomaticUnsignedBalance;

    /**
     * @var Chronos
     * @ORM\Column(type="datetime")
     */
    private $transactionDate;

    /**
     * @var Collection
     * @ORM\OneToMany(targetEntity="TransactionLine", mappedBy="transaction")
     */
    private $transactionLines;

    /**
     * @var Collection
     * @ORM\OneToMany(targetEntity="AccountingDocument", mappedBy="transaction")
     */
    private $accountingDocuments;

    /**
     * @var null|ExpenseClaim
     *
     * @ORM\ManyToOne(targetEntity="ExpenseClaim", inversedBy="transactions")
     * @ORM\JoinColumns({
     *     @ORM\JoinColumn(nullable=true, onDelete="SET NULL")
     * })
     */
    private $expenseClaim;

    /**
     * @var string
     *
     * @ORM\Column(type="string", length=18, options={"default" = ""})
     */
    private $datatransRef = '';

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->balance = Money::CHF(0);
        $this->transactionLines = new ArrayCollection();
        $this->accountingDocuments = new ArrayCollection();
    }

    /**
     * Set date of transaction
     *
     * @param Chronos $transactionDate
     */
    public function setTransactionDate(Chronos $transactionDate): void
    {
        $this->transactionDate = $transactionDate;
    }

    /**
     * Get date of transaction
     *
     * @return Chronos
     */
    public function getTransactionDate(): Chronos
    {
        return $this->transactionDate;
    }

    /**
     * Notify when a transaction line is added
     * This should only be called by TransactionLine::setTransaction()
     *
     * @param TransactionLine $transactionLine
     */
    public function transactionLineAdded(TransactionLine $transactionLine): void
    {
        $this->transactionLines->add($transactionLine);
    }

    /**
     * Notify when a transaction line is removed
     * This should only be called by TransactionLine::setTransaction()
     *
     * @param TransactionLine $transactionLine
     */
    public function transactionLineRemoved(TransactionLine $transactionLine): void
    {
        $this->transactionLines->removeElement($transactionLine);
    }

    /**
     * @return Collection
     */
    public function getTransactionLines(): Collection
    {
        return $this->transactionLines;
    }

    /**
     * Notify the transaction that an accounting document was added
     * This should only be called by AccountingDocument::setTransaction()
     *
     * @param AccountingDocument $document
     */
    public function accountingDocumentAdded(AccountingDocument $document): void
    {
        $this->accountingDocuments->add($document);
    }

    /**
     * Notify the transaction that an accounting document was removed
     * This should only be called by AccountingDocument::setTransaction()
     *
     * @param AccountingDocument $document
     */
    public function accountingDocumentRemoved(AccountingDocument $document): void
    {
        $this->accountingDocuments->removeElement($document);
    }

    /**
     * Get accounting documents
     *
     * @return Collection
     */
    public function getAccountingDocuments(): Collection
    {
        return $this->accountingDocuments;
    }

    /**
     * Set expense claim
     *
     * @param null|ExpenseClaim $expenseClaim
     */
    public function setExpenseClaim(?ExpenseClaim $expenseClaim): void
    {
        if ($this->expenseClaim) {
            $this->expenseClaim->transactionRemoved($this);
        }

        $this->expenseClaim = $expenseClaim;

        if ($this->expenseClaim) {
            $this->expenseClaim->transactionAdded($this);
        }
    }

    /**
     * Get expense claim
     *
     * @return null|ExpenseClaim
     */
    public function getExpenseClaim(): ?ExpenseClaim
    {
        return $this->expenseClaim;
    }

    /**
     * Get Datatrans payment reference number
     *
     * @param string $datatransRef
     */
    public function setDatatransRef(string $datatransRef): void
    {
        $this->datatransRef = $datatransRef;
    }

    /**
     * Set Datatrans payment reference number
     *
     * @return string
     */
    public function getDatatransRef(): string
    {
        return $this->datatransRef;
    }

    /**
     * Automatically called by Doctrine whenever a transaction is created or updated
     *
     * @ORM\PrePersist
     * @ORM\PreUpdate
     */
    public function checkBalance(): void
    {
        $totalDebit = Money::CHF(0);
        $totalCredit = Money::CHF(0);
        foreach ($this->getTransactionLines() as $i => $line) {
            if ($line->getDebit()) {
                $totalDebit = $totalDebit->add($line->getBalance());
            }
            if ($line->getCredit()) {
                $totalCredit = $totalCredit->add($line->getBalance());
            }
        }

        if (!$totalDebit->equals($totalCredit)) {
            throw new \Ecodev\Felix\Api\Exception(sprintf('Transaction %s non-équilibrée, débits: %s, crédits: %s', $this->getId() ?? 'NEW', Format::money($totalDebit), Format::money($totalCredit)));
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Application\Model;
6
7		use Application\Traits\HasAutomaticUnsignedBalance;
8		use Application\Traits\HasRemarks;
9		use Cake\Chronos\Chronos;
10		use Doctrine\Common\Collections\ArrayCollection;
11		use Doctrine\Common\Collections\Collection;
12		use Doctrine\ORM\Mapping as ORM;
13		use Ecodev\Felix\Format;
14		use Ecodev\Felix\Model\Traits\HasInternalRemarks;
15		use Ecodev\Felix\Model\Traits\HasName;
16		use Money\Money;
17
18		/**
19		* An accounting journal entry (simple or compound)
20		*
21		* @ORM\Entity(repositoryClass="Application\Repository\TransactionRepository")
22		* @ORM\HasLifecycleCallbacks
23		*/
24		class Transaction extends AbstractModel
25		{
26		use HasName;
27		use HasRemarks;
28		use HasInternalRemarks;
29		use HasAutomaticUnsignedBalance;
30
31		/**
32		* @var Chronos
33		* @ORM\Column(type="datetime")
34		*/
35		private $transactionDate;
36
37		/**
38		* @var Collection
39		* @ORM\OneToMany(targetEntity="TransactionLine", mappedBy="transaction")
40		*/
41		private $transactionLines;
42
43		/**
44		* @var Collection
45		* @ORM\OneToMany(targetEntity="AccountingDocument", mappedBy="transaction")
46		*/
47		private $accountingDocuments;
48
49		/**
50		* @var null\|ExpenseClaim
51		*
52		* @ORM\ManyToOne(targetEntity="ExpenseClaim", inversedBy="transactions")
53		* @ORM\JoinColumns({
54		* @ORM\JoinColumn(nullable=true, onDelete="SET NULL")
55		* })
56		*/
57		private $expenseClaim;
58
59		/**
60		* @var string
61		*
62		* @ORM\Column(type="string", length=18, options={"default" = ""})
63		*/
64		private $datatransRef = '';
65
66		/**
67		* Constructor
68		*/
69	26	public function __construct()
70		{
71	26	$this->balance = Money::CHF(0);
72	26	$this->transactionLines = new ArrayCollection();
73	26	$this->accountingDocuments = new ArrayCollection();
74	26	}
75
76		/**
77		* Set date of transaction
78		*
79		* @param Chronos $transactionDate
80		*/
81	18	public function setTransactionDate(Chronos $transactionDate): void
82		{
83	18	$this->transactionDate = $transactionDate;
84	18	}
85
86		/**
87		* Get date of transaction
88		*
89		* @return Chronos
90		*/
91	8	public function getTransactionDate(): Chronos
92		{
93	8	return $this->transactionDate;
94		}
95
96		/**
97		* Notify when a transaction line is added
98		* This should only be called by TransactionLine::setTransaction()
99		*
100		* @param TransactionLine $transactionLine
101		*/
102	17	public function transactionLineAdded(TransactionLine $transactionLine): void
103		{
104	17	$this->transactionLines->add($transactionLine);
105	17	}
106
107		/**
108		* Notify when a transaction line is removed
109		* This should only be called by TransactionLine::setTransaction()
110		*
111		* @param TransactionLine $transactionLine
112		*/
113	1	public function transactionLineRemoved(TransactionLine $transactionLine): void
114		{
115	1	$this->transactionLines->removeElement($transactionLine);
116	1	}
117
118		/**
119		* @return Collection
120		*/
121	20	public function getTransactionLines(): Collection
122		{
123	20	return $this->transactionLines;
124		}
125
126		/**
127		* Notify the transaction that an accounting document was added
128		* This should only be called by AccountingDocument::setTransaction()
129		*
130		* @param AccountingDocument $document
131		*/
132	1	public function accountingDocumentAdded(AccountingDocument $document): void
133		{
134	1	$this->accountingDocuments->add($document);
135	1	}
136
137		/**
138		* Notify the transaction that an accounting document was removed
139		* This should only be called by AccountingDocument::setTransaction()
140		*
141		* @param AccountingDocument $document
142		*/
143	1	public function accountingDocumentRemoved(AccountingDocument $document): void
144		{
145	1	$this->accountingDocuments->removeElement($document);
146	1	}
147
148		/**
149		* Get accounting documents
150		*
151		* @return Collection
152		*/
153	1	public function getAccountingDocuments(): Collection
154		{
155	1	return $this->accountingDocuments;
156		}
157
158		/**
159		* Set expense claim
160		*
161		* @param null\|ExpenseClaim $expenseClaim
162		*/
163	1	public function setExpenseClaim(?ExpenseClaim $expenseClaim): void
164		{
165	1	if ($this->expenseClaim) {
166	1	$this->expenseClaim->transactionRemoved($this);
167		}
168
169	1	$this->expenseClaim = $expenseClaim;
170
171	1	if ($this->expenseClaim) {
172	1	$this->expenseClaim->transactionAdded($this);
173		}
174	1	}
175
176		/**
177		* Get expense claim
178		*
179		* @return null\|ExpenseClaim
180		*/
181		public function getExpenseClaim(): ?ExpenseClaim
182		{
183		return $this->expenseClaim;
184		}
185
186		/**
187		* Get Datatrans payment reference number
188		*
189		* @param string $datatransRef
190		*/
191	5	public function setDatatransRef(string $datatransRef): void
192		{
193	5	$this->datatransRef = $datatransRef;
194	5	}
195
196		/**
197		* Set Datatrans payment reference number
198		*
199		* @return string
200		*/
201	2	public function getDatatransRef(): string
202		{
203	2	return $this->datatransRef;
204		}
205
206		/**
207		* Automatically called by Doctrine whenever a transaction is created or updated
208		*
209		* @ORM\PrePersist
210		* @ORM\PreUpdate
211		*/
212	17	public function checkBalance(): void
213		{
214	17	$totalDebit = Money::CHF(0);
215	17	$totalCredit = Money::CHF(0);
216	17	foreach ($this->getTransactionLines() as $i => $line) {
217	8	if ($line->getDebit()) {
218	8	$totalDebit = $totalDebit->add($line->getBalance());
219		}
220	8	if ($line->getCredit()) {
221	8	$totalCredit = $totalCredit->add($line->getBalance());
222		}
223		}
224
225	17	if (!$totalDebit->equals($totalCredit)) {
226	1	throw new \Ecodev\Felix\Api\Exception(sprintf('Transaction %s non-équilibrée, débits: %s, crédits: %s', $this->getId() ?? 'NEW', Format::money($totalDebit), Format::money($totalCredit)));
227		}
228	16	}
229		}
230

Ecodev / my-ichtus

Push — master ( 51347b...4787ce )

Transaction::setExpenseClaim() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like