Application\Model\ExpenseClaim

Complexity

Total Complexity

11

Size/Duplication

Total Lines	147
Duplicated Lines	0 %

Test Coverage

Coverage

83.33%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	accountingDocumentRemoved()	0	3	1
A	accountingDocumentAdded()	0	3	1
A	getAmount()	0	3	1
A	__construct()	0	4	1
A	transactionAdded()	0	3	1
A	setAmount()	0	3	1
A	getTransactions()	0	3	1
A	transactionRemoved()	0	3	1
A	getAccountingDocuments()	0	3	1
A	getStatus()	0	3	1
A	setStatus()	0	3	1

<?php

declare(strict_types=1);

namespace Application\Model;

use Application\DBAL\Types\ExpenseClaimStatusType;
use Application\Traits\HasDescription;
use Application\Traits\HasName;
use Application\Traits\HasRemarks;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use GraphQL\Doctrine\Annotation as API;

/**
 * An expense claim to be refunded to an user
 *
 * @ORM\Entity(repositoryClass="Application\Repository\ExpenseClaimRepository")
 * @ORM\AssociationOverrides({
 *     @ORM\AssociationOverride(name="owner",
 *         joinColumns=@ORM\JoinColumn(nullable=false)
 *     )
 * })
 */
class ExpenseClaim extends AbstractModel
{
    use HasName;
    use HasDescription;
    use HasRemarks;

    /**
     * @var string
     *
     * @ORM\Column(type="decimal", precision=7, scale=2)
     */
    private $amount;

    /**
     * @var Collection
     * @ORM\OneToMany(targetEntity="Transaction", mappedBy="expenseClaim")
     */
    private $transactions;

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

    /**
     * @var string
     *
     * @ORM\Column(type="ExpenseClaimStatus", length=10, options={"default" = ExpenseClaimStatusType::NEW})
     */
    private $status = ExpenseClaimStatusType::NEW;

    /**
     * Constructor
     */
    public function __construct()
    {
        $this->transactions = new ArrayCollection();
        $this->accountingDocuments = new ArrayCollection();
    }

    /**
     * Set amount
     *
     * @param string $amount
     */
    public function setAmount(string $amount): void
    {
        $this->amount = $amount;
    }

    /**
     * Get amount
     *
     * @return string
     */
    public function getAmount(): string
    {
        return $this->amount;
    }

    /**
     * Set status
     *
     * @API\Input(type="ExpenseClaimStatus")
     *
     * @param string $status
     */
    public function setStatus(string $status): void
    {
        $this->status = $status;
    }

    /**
     * Get status
     *
     * @API\Field(type="ExpenseClaimStatus")
     *
     * @return string
     */
    public function getStatus(): string
    {
        return $this->status;
    }

    /**
     * Notify the expense claim that a transaction was added
     * This should only be called by Transaction::setExpenseClaim()
     *
     * @param Transaction $transaction
     */
    public function transactionAdded(Transaction $transaction): void
    {
        $this->transactions->add($transaction);
    }

    /**
     * Notify the expense claim that a transaction was removed
     * This should only be called by Transaction::setExpenseClaim()
     *
     * @param Transaction $transaction
     */
    public function transactionRemoved(Transaction $transaction): void
    {
        $this->transactions->removeElement($transaction);
    }

    /**
     * Get the transactions created from this expense claim
     *
     * @return Collection
     */
    public function getTransactions(): Collection
    {
        return $this->transactions;
    }

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

    /**
     * Notify the expense that an accounting document was removed
     * This should only be called by AccountingDocument::setExpenseClaim()
     *
     * @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;
    }
}