App\Entity\PaymentOrder

Complexity

Total Complexity

64

Size/Duplication

Total Lines	770
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

57 Methods

Rating	Name	Duplication	Size	Complexity
A	setPrintedForm()	0	5	1
A	setConfirm1Timestamp()	0	5	1
A	getAmount()	0	3	1
A	getAmountString()	0	8	2
A	isMathematicallyCorrect()	0	3	1
A	setFactuallyCorrect()	0	12	2
A	__construct()	0	8	1
A	setResolutionDate()	0	5	1
A	setDepartment()	0	5	1
A	isExported()	0	3	1
A	isFsrKomResolution()	0	3	1
A	setConfirm2Timestamp()	0	5	1
A	getReferencesFile()	0	3	1
A	getContactEmail()	0	3	1
A	getResolutionDate()	0	3	1
A	getComment()	0	3	1
A	getProjectName()	0	3	1
A	setContactEmail()	0	5	1
A	setConfirm2Token()	0	5	1
A	getBookingDate()	0	3	1
A	getReferences()	0	3	1
A	isConfirmed()	0	3	2
A	getFirstName()	0	3	1
A	isReferencesExported()	0	3	1
A	setReferencesFile()	0	13	2
A	setFundingId()	0	5	1
A	getLastName()	0	3	1
A	setConfirm1Token()	0	5	1
A	getPrintedForm()	0	3	1
A	setBankInfo()	0	5	1
A	getConfirm1Timestamp()	0	3	1
A	serialize()	0	3	1
A	setReferencesExported()	0	5	1
A	getDepartment()	0	3	1
A	getBankInfo()	0	3	1
A	getIDString()	0	3	1
A	unserialize()	0	3	1
A	setReferences()	0	5	1
A	setBookingDate()	0	5	1
A	getFullName()	0	10	3
A	setFirstName()	0	5	1
A	setLastName()	0	5	1
A	getAssociatedSepaExports()	0	3	1
A	getConfirm1Token()	0	3	1
A	getConfirm2Token()	0	3	1
A	setPrintedFormFile()	0	13	2
A	getId()	0	3	1
A	setComment()	0	5	1
A	getConfirm2Timestamp()	0	3	1
A	setMathematicallyCorrect()	0	5	1
A	setProjectName()	0	5	1
A	getPrintedFormFile()	0	3	1
A	setAmount()	0	5	1
A	setExported()	0	5	1
A	getFundingId()	0	3	1
A	setFsrKomResolution()	0	5	1
A	isFactuallyCorrect()	0	3	1

<?php
/*
 * Copyright (C) 2020  Jan Böhmer
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace App\Entity;

use App\Entity\Contracts\DBElementInterface;
use App\Entity\Contracts\TimestampedElementInterface;
use App\Entity\Embeddable\PayeeInfo;
use App\Repository\PaymentOrderRepository;
use App\Validator\FSRNotBlocked;
use DateTime;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\Common\Collections\Collection;
use Doctrine\ORM\Mapping as ORM;
use Symfony\Component\Validator\Constraints as Assert;
use Vich\UploaderBundle\Entity\File;
use Vich\UploaderBundle\Mapping\Annotation as Vich;

/**
 * This entity represents a request to pay money for something to a persons bank account.
 * The applicant (which can be some other person than the payment receiver) submits a payment order ("Zahlungsauftrag")
 * via the front end form. The finance officers of the department for which the payment order was submitted receive an
 * email with a verification link where they have to confirm the payment oder.
 * In the backend the back office officers can see all submitted payment orders. In the first step it is checked if a
 * payment order is factually correct, then it is exported (as SEPA-XML) to the online banking system. Another officer
 * then checks if the payment order is factually correct and then approve the payment in the online banking.
 *
 * @ORM\Entity(repositoryClass=PaymentOrderRepository::class)
 * @ORM\Table("payment_orders")
 * @Vich\Uploadable()
 * @ORM\HasLifecycleCallbacks()
 */
class PaymentOrder implements DBElementInterface, TimestampedElementInterface, \Serializable
{
    use TimestampTrait;

    public const FUNDING_ID_REGEX = '/^(FA|M)-\d{3,4}-20\d{2}(_\d{2})?$/';

    /**
     * @ORM\Id()
     * @ORM\GeneratedValue()
     * @ORM\Column(type="integer")
     */
    private $id;

    /**
     * @var PayeeInfo
     * @ORM\Embedded(class="App\Entity\Embeddable\PayeeInfo")
     * @Assert\Valid()
     */
    private $bank_info;

    /**
     * @var string "Vorname"
     * @ORM\Column(type="string")
     * @Assert\NotBlank()
     */
    private $first_name = '';

    /**
     * @var string "Nachname"
     * @ORM\Column(type="string")
     * @Assert\NotBlank()
     */
    private $last_name = '';

    /**
     * @var Department "Struktur/Organisation"
     * @ORM\ManyToOne(targetEntity="App\Entity\Department")
     * @ORM\JoinColumn(nullable=false)
     * @Assert\NotNull()
     * @FSRNotBlocked(groups={"fsr_blocked"})
     */
    private $department;

    /**
     * @var string "Projektbezeichnung"
     * @Assert\NotBlank()
     * @Assert\Length(max=70, maxMessage="validator.project_name.too_long")
     * @ORM\Column(type="string")
     */
    private $project_name = '';

    /**
     * @var int "Betrag"
     * @ORM\Column(type="integer")
     * @Assert\Positive()
     */
    private $amount = null;

    /**
     * @var bool "mathematisch richtig"
     * @ORM\Column(type="boolean")
     */
    private $mathematically_correct = false;

    /**
     * @var bool
     * @ORM\Column(type="boolean")
     */
    private $exported = false;

    /**
     * @var bool "sachlich richtig"
     * @ORM\Column(type="boolean")
     */
    private $factually_correct = false;

    /**
     * @ORM\Column(type="text")
     */
    private $comment = '';

    /**
     * @var string "Mittelfreigabe / Finanzantrag"
     * @ORM\Column(type="string")
     * @Assert\Regex(PaymentOrder::FUNDING_ID_REGEX)
     */
    private $funding_id = '';

    /**
     * @var string|null
     * @ORM\Column(type="string", nullable=true)
     */
    private $confirm1_token = null;

    /**
     * @var DateTime|null
     * @ORM\Column(type="datetime", nullable=true)
     */
    private $confirm1_timestamp = null;

    /**
     * @var string|null
     * @ORM\Column(type="string", nullable=true)
     */
    private $confirm2_token = null;

    /**
     * @var DateTime|null
     * @ORM\Column(type="datetime", nullable=true)
     */
    private $confirm2_timestamp = null;

    /**
     * @var bool Is FSR-Kom resolution
     * @ORM\Column(type="boolean")
     */
    private $fsr_kom_resolution = false;

    /**
     * @var DateTime|null
     * @ORM\Column(type="date", nullable=true)
     * @Assert\LessThanOrEqual(value="today", message="validator.resolution_must_not_be_in_future")
     * @Assert\GreaterThan(value="-3 years", message="validator.resolution_too_old")
     * @Assert\Expression("value !== null || (this.getDepartment() !== null && this.getDepartment().getType() != 'fsr' && this.isFsrKomResolution() === false)", message="validator.resolution_date.needed_for_fsr_fsrkom")
     */
    private $resolution_date = null;

    /**
     * @var string
     * @ORM\Column(type="string", nullable=false)
     * @Assert\Email()
     */
    private $contact_email = '';

    /**
     * @var DateTime|null
     * @ORM\Column(type="datetime", nullable=true)
     */
    private $booking_date = null;

    /**
     * @var bool
     * @ORM\Column(type="boolean")
     */
    private $references_exported = false;

    /*
     * Associated files
     */

    /**
     * @Vich\UploadableField(mapping="payment_orders_form", fileNameProperty="printed_form.name", size="printed_form.size", mimeType="printed_form.mimeType", originalName="printed_form.originalName", dimensions="printed_form.dimensions")
     *
     * @var \Symfony\Component\HttpFoundation\File\File|null
     * @Assert\File(
     *     maxSize = "1024k",
     *     mimeTypes = {"application/pdf", "application/x-pdf"},
     *     mimeTypesMessage = "validator.upload_pdf"
     * )
     */
    private $printed_form_file;

    /**
     * @ORM\Embedded(class="Vich\UploaderBundle\Entity\File")
     *
     * @var File
     */
    private $printed_form;

    /**
     * @Vich\UploadableField(mapping="payment_orders_references", fileNameProperty="references.name", size="references.size", mimeType="references.mimeType", originalName="references.originalName", dimensions="references.dimensions")
     *
     * @var \Symfony\Component\HttpFoundation\File\File|null
     * @Assert\NotBlank(groups={"frontend"})
     * @Assert\File(
     *     maxSize = "10M",
     *     mimeTypes = {"application/pdf", "application/x-pdf"},
     *     mimeTypesMessage = "validator.upload_pdf"
     * )
     */
    private $references_file;

    /**
     * @var Collection|SEPAExport[]
     * @ORM\ManyToMany(targetEntity="App\Entity\SEPAExport", mappedBy="associated_payment_orders")
     */
    private $associated_sepa_exports;

    /**
     * @ORM\Embedded(class="Vich\UploaderBundle\Entity\File")
     *
     * @var File
     */
    private $references;

    public function __construct()
    {
        $this->bank_info = new PayeeInfo();

        $this->associated_sepa_exports = new ArrayCollection();

        $this->references = new File();
        $this->printed_form = new File();
    }

    public function getId(): ?int
    {
        return $this->id;
    }

    /**
     * Returns the bank info associated with this payment order.
     *
     *@see PayeeInfo
     */
    public function getBankInfo(): PayeeInfo
    {
        return $this->bank_info;
    }

    /**
     * Returns the bank info associated with this payment order.
     *
     *@see PayeeInfo
     */
    public function setBankInfo(PayeeInfo $bank_info): PaymentOrder
    {
        $this->bank_info = $bank_info;

        return $this;
    }

    /**
     * Returns the full name of person which has submitted this payment order.
     */
    public function getFullName(): string
    {
        if (empty($this->getFirstName())) {
            return $this->getLastName();
        }
        if (empty($this->getLastName())) {
            return $this->getFirstName();
        }

        return $this->getFirstName().' '.$this->getLastName();
    }

    /**
     * Returns the first name of the person which has submitted this payment order.
     */
    public function getFirstName(): string
    {
        return $this->first_name;
    }

    /**
     * Sets the first name of the person which has submitted this payment order.
     */
    public function setFirstName(string $first_name): PaymentOrder
    {
        $this->first_name = $first_name;

        return $this;
    }

    /**
     * Returns the last name of the person which has submitted this payment order.
     */
    public function getLastName(): string
    {
        return $this->last_name;
    }

    /**
     * Sets the last name of the person which has submitted this payment order.
     */
    public function setLastName(string $last_name): PaymentOrder
    {
        $this->last_name = $last_name;

        return $this;
    }

    /**
     * Returns the department for which this payment order was submitted.
     *
     * @return Department
     */
    public function getDepartment(): ?Department
    {
        return $this->department;
    }

    /**
     * Returns the department for which this payment order was submitted.
     */
    public function setDepartment(Department $department): PaymentOrder
    {
        $this->department = $department;

        return $this;
    }

    /**
     * Returns the name of the project which caused this payment order.
     * This value will be used in the bank reference value by default.
     */
    public function getProjectName(): string
    {
        return $this->project_name;
    }

    /**
     * Returns the name of the project which caused this payment order.
     * This value will be used in the bank reference value by default.
     */
    public function setProjectName(string $project_name): PaymentOrder
    {
        $this->project_name = $project_name;

        return $this;
    }

    /**
     * Returns the amount that should be paid in (euro) cents.
     *
     * @return int
     */
    public function getAmount(): ?int
    {
        return $this->amount;
    }

    /**
     * Sets the amount that should be paid in (euro) cents.
     */
    public function setAmount(int $amount): PaymentOrder
    {
        $this->amount = $amount;

        return $this;
    }

    /**
     * Returns the amount formatted as euro string (with dot as decimal separator) in the form "123.45" (only 2 digits).
     * Returns null if no amount was set.
     */
    public function getAmountString(): ?string
    {
        if (null === $this->amount) {
            return null;
        }

        //%F (with big F) is important here, to always output with a dot
        return sprintf('%.2F', $this->amount / 100);
    }

    /**
     * Returns whether this payment order was checked as mathematically correct.
     * This means it was checked that the amount and data in this payment order matches the data on the invoice.
     */
    public function isMathematicallyCorrect(): bool
    {
        return $this->mathematically_correct;
    }

    /**
     * Sets whether this payment order was checked as mathematically correct.
     * This means it was checked that the amount and data in this payment order matches the data on the invoice.
     */
    public function setMathematicallyCorrect(bool $mathematically_correct): PaymentOrder
    {
        $this->mathematically_correct = $mathematically_correct;

        return $this;
    }

    /**
     * Returns whether this payment order was checked as factually correct.
     * This means it was checked that this payment is really needed. In our context it also means that an payment order
     * was payed out and is finished.
     */
    public function isFactuallyCorrect(): bool
    {
        return $this->factually_correct;
    }

    /**
     * Sets whether this payment order was checked as factually correct.
     * This means it was checked that this payment is really needed. In our context it also means that an payment order
     * was payed out and is finished.
     */
    public function setFactuallyCorrect(bool $factually_correct): PaymentOrder
    {
        $this->factually_correct = $factually_correct;

        //Update the status of booking date
        if ($factually_correct) {
            $this->booking_date = new \DateTime();
        } else {
            $this->booking_date = null;
        }

        return $this;
    }

    /**
     * Returns whether this payment order was exported as SEPA-XML (and imported in online banking).
     * This is automatically set when payment orders are exported.
     */
    public function isExported(): bool
    {
        return $this->exported;
    }

    /**
     * Sets whether this payment order was exported as SEPA-XML (and imported in online banking).
     * This is automatically set when payment orders are exported.
     */
    public function setExported(bool $exported): PaymentOrder
    {
        $this->exported = $exported;

        return $this;
    }

    /**
     * Returns the comment associated with this payment order.
     * This can be HTML if changed in the backend.
     */
    public function getComment(): string
    {
        return $this->comment;
    }

    /**
     * Returns the comment associated with this payment order.
     * This can be HTML if changed in the backend.
     */
    public function setComment(string $comment): PaymentOrder
    {
        $this->comment = $comment;

        return $this;
    }

    /**
     * Returns the funding ID associated with this payment order (if it existing).
     * Returns an empty string if no funding ID is associated.
     */
    public function getFundingId(): string
    {
        return $this->funding_id;
    }

    /**
     * Sets the funding ID associated with this payment order (if it existing).
     * Set to an empty string if no funding ID is associated.
     */
    public function setFundingId(string $funding_id): self
    {
        $this->funding_id = $funding_id;

        return $this;
    }

    /**
     * Return the HTTPFoundation File associated that contains the PDF version of this payment order.
     */
    public function getPrintedFormFile(): ?\Symfony\Component\HttpFoundation\File\File
    {
        return $this->printed_form_file;
    }

    /**
     * Sets the HTTPFoundation File associated that contains the PDF version of this payment order.
     */
    public function setPrintedFormFile(?\Symfony\Component\HttpFoundation\File\File $printed_form_file): PaymentOrder
    {
        $this->printed_form_file = $printed_form_file;

        if (null !== $printed_form_file) {
            /* It is required that at least one field changes if you are using doctrine
             otherwise the event listeners won't be called and the file is lost
             But we dont really want to change  the last time value, so just copy it and create a new reference
            so doctrine thinks something has changed, but practically everything looks the same */
            $this->last_modified = clone ($this->last_modified ?? new \DateTime());
        }

        return $this;
    }

    /**
     * Return the Vich File associated that contains the PDF version of this payment order.
     */
    public function getPrintedForm(): File
    {
        return $this->printed_form;
    }

    /**
     * Return the Vich File associated that contains the PDF version of this payment order.
     */
    public function setPrintedForm(File $printed_form): PaymentOrder
    {
        $this->printed_form = $printed_form;

        return $this;
    }

    /**
     * Return the HTTPFoundation File associated that contains the invoice for this payment order.
     */
    public function getReferencesFile(): ?\Symfony\Component\HttpFoundation\File\File
    {
        return $this->references_file;
    }

    /**
     * Sets the HTTPFoundation File associated that contains the invoice for this payment order.
     */
    public function setReferencesFile(?\Symfony\Component\HttpFoundation\File\File $references_file): PaymentOrder
    {
        $this->references_file = $references_file;

        if (null !== $references_file) {
            /* It is required that at least one field changes if you are using doctrine
             otherwise the event listeners won't be called and the file is lost
             But we dont really want to change  the last time value, so just copy it and create a new reference
            so doctrine thinks something has changed, but practically everything looks the same */
            $this->last_modified = clone ($this->last_modified ?? new \DateTime());
        }

        return $this;
    }

    /**
     * Return the Vich File associated that contains the invoice for this payment order.
     */
    public function getReferences(): File
    {
        return $this->references;
    }

    /**
     * Sets the HTTPFoundation File associated that contains the invoice for this payment order.
     */
    public function setReferences(File $references): PaymentOrder
    {
        $this->references = $references;

        return $this;
    }

    /**
     * Returns the (hashed) token that can be used to access the confirmation1 page of this payment page.
     * This value be verified with the password_verify() function.
     * Can be null if no confirmation should be possible for this payment order.
     */
    public function getConfirm1Token(): ?string
    {
        return $this->confirm1_token;
    }

    /**
     * Returns the (hashed) token that can be used to access the confirmation1 page of this payment page.
     * This value be created with the password_hash() function.
     * Can be null if no confirmation should be possible for this payment order.
     */
    public function setConfirm1Token(?string $confirm1_token): PaymentOrder
    {
        $this->confirm1_token = $confirm1_token;

        return $this;
    }

    /**
     * Returns the timestamp when the first confirmation for this payment order was submitted.
     * Returns null if this payment order is not confirmed (yet).
     */
    public function getConfirm1Timestamp(): ?DateTime
    {
        return $this->confirm1_timestamp;
    }

    /**
     * Sets the timestamp when the first confirmation for this payment order was submitted.
     * Set to null if this payment order is not confirmed (yet).
     */
    public function setConfirm1Timestamp(?DateTime $confirm1_timestamp): PaymentOrder
    {
        $this->confirm1_timestamp = $confirm1_timestamp;

        return $this;
    }

    /**
     *  Returns the (hashed) token that can be used to access the confirmation2 page of this payment page.
     * This value be verified with the password_verify() function.
     * Can be null if no confirmation should be possible for this payment order.
     */
    public function getConfirm2Token(): ?string
    {
        return $this->confirm2_token;
    }

    /**
     * Sets the (hashed) token that can be used to access the confirmation1 page of this payment page.
     * This value be created with the password_hash() function.
     * Can be null if no confirmation should be possible for this payment order.
     */
    public function setConfirm2Token(?string $confirm2_token): PaymentOrder
    {
        $this->confirm2_token = $confirm2_token;

        return $this;
    }

    /**
     * Returns the timestamp when the second confirmation for this payment order was submitted.
     * Returns null if this payment order is not confirmed (yet).
     */
    public function getConfirm2Timestamp(): ?DateTime
    {
        return $this->confirm2_timestamp;
    }

    /**
     * Sets the timestamp when the second confirmation for this payment order was submitted.
     * Set to null if this payment order is not confirmed (yet).
     */
    public function setConfirm2Timestamp(?DateTime $confirm2_timestamp): PaymentOrder
    {
        $this->confirm2_timestamp = $confirm2_timestamp;

        return $this;
    }

    /**
     * Returns whether this payment order is confirmed (by both instances).
     */
    public function isConfirmed(): bool
    {
        return null !== $this->confirm1_timestamp && null !== $this->confirm2_timestamp;
    }

    /**
     * Returns the email of the person which has submitted this payment order and which is used for answering questions.
     */
    public function getContactEmail(): string
    {
        return $this->contact_email;
    }

    /**
     * Sets the email of the person which has submitted this payment order and which is used for answering questions.
     */
    public function setContactEmail(string $contact_email): PaymentOrder
    {
        $this->contact_email = $contact_email;

        return $this;
    }

    /**
     * Returns whether this is an payment order for an resolution of the FSR-Kom (these are handled differently).
     */
    public function isFsrKomResolution(): bool
    {
        return $this->fsr_kom_resolution;
    }

    /**
     * Sets whether this is an payment order for an resolution of the FSR-Kom (these are handled differently).
     */
    public function setFsrKomResolution(bool $fsr_kom_resolution): PaymentOrder
    {
        $this->fsr_kom_resolution = $fsr_kom_resolution;

        return $this;
    }

    /**
     * Returns the date when the resolution that causes this payment order was passed.
     * This value is optional as not every payment order needs an resolution.
     * Only the date is shown for this DateTime.
     */
    public function getResolutionDate(): ?DateTime
    {
        return $this->resolution_date;
    }

    /**
     * Sets the date when the resolution that causes this payment order was passed.
     * This value is optional as not every payment order needs an resolution.
     * Only the date is shown for this DateTime.
     */
    public function setResolutionDate(?DateTime $resolution_date): PaymentOrder
    {
        $this->resolution_date = $resolution_date;

        return $this;
    }

    /**
     * Returns the datetime when this payment was booked in banking.
     * Returns null if payment_order was not booked yet.
     * The value is set automatically to now when the "factually_checked" field is set.
     */
    public function getBookingDate(): ?DateTime
    {
        return $this->booking_date;
    }

    /**
     * Manually set the datetime when this payment was booked in banking.
     * Set to null if payment_order was not booked yet.
     * The value is set automatically to now when the "factually_checked" field is set.
     */
    public function setBookingDate(?DateTime $booking_date): PaymentOrder
    {
        $this->booking_date = $booking_date;

        return $this;
    }

    /**
     * Returns whether the references for this payment order were already exported.
     */
    public function isReferencesExported(): bool
    {
        return $this->references_exported;
    }

    /**
     * Sets whether the references for this payment order were already exported.
     */
    public function setReferencesExported(bool $references_exported): PaymentOrder
    {
        $this->references_exported = $references_exported;

        return $this;
    }

    /**
     * @return SEPAExport[]|Collection
     */
    public function getAssociatedSepaExports()
    {
        return $this->associated_sepa_exports;
    }



    public function serialize()
    {
        return serialize($this->getId());
    }

    public function unserialize($serialized)
    {
        $this->id = unserialize($serialized);
    }

    /**
     * Get the ID as string like ZA0005.
     */
    public function getIDString(): string
    {
        return sprintf('ZA%04d', $this->getId());
    }
}