User::setMarkedAsPayed() - Code Metrics - Inspection of "resolve #22" - famoser/vseth-musikzimmer-pay - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b55af8...b76ede )

by Florian

created 2020-03-29 20:13 UTC

User::setMarkedAsPayed() A

↳ Parent: User

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	1

<?php

/*
 * This file is part of the vseth-musikzimmer-pay project.
 *
 * (c) Florian Moser <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace App\Entity;

use App\Entity\Base\BaseEntity;
use App\Entity\Traits\IdTrait;
use App\Enum\PaymentRemainderStatusType;
use App\Enum\UserCategoryType;
use App\Model\Bill\Recipient;
use App\Model\PaymentInfo;
use Doctrine\Common\Collections\ArrayCollection;
use Doctrine\ORM\Mapping as ORM;
use Ramsey\Uuid\Uuid;

/**
 * an event determines how the questionnaire looks like.
 *
 * @ORM\Entity(repositoryClass="App\Repository\UserRepository")
 * @ORM\HasLifecycleCallbacks
 */
class User extends BaseEntity
{
    use IdTrait;

    /**
     * @var string
     *
     * @ORM\Column(type="text")
     */
    private $authenticationCode;

    /**
     * @var string
     *
     * @ORM\Column(type="text")
     */
    private $email;

    /**
     * @var string
     *
     * @ORM\Column(type="text")
     */
    private $givenName;

    /**
     * @var string
     *
     * @ORM\Column(type="text")
     */
    private $familyName;

    /**
     * @var string
     *
     * @ORM\Column(type="text")
     */
    private $address;

    /**
     * @var string
     *
     * @ORM\Column(type="text")
     */
    private $phone;

    /**
     * @var int
     *
     * @ORM\Column(type="integer")
     */
    private $category = UserCategoryType::STUDENT;

    /**
     * @var int
     *
     * @ORM\Column(type="integer")
     */
    private $discount = 0;

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

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

    /**
     * this is in francs.
     *
     * @var int
     *
     * @ORM\Column(type="integer")
     */
    private $amountOwed;

    /**
     * this is in cents.
     *
     * @var int|null
     *
     * @ORM\Column(type="integer", nullable=true)
     */
    private $amountPayed;

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

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

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

    /**
     * @var int
     *
     * @ORM\Column(type="integer")
     */
    private $paymentRemainderStatus = PaymentRemainderStatusType::NONE;

    /**
     * @var bool
     *
     * @ORM\Column(type="boolean", options={"default" : false})
     */
    private $markedAsPayed;

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

    /**
     * @var PaymentRemainder|null
     *
     * @ORM\ManyToOne(targetEntity="App\Entity\PaymentRemainder", inversedBy="users")
     */
    private $paymentRemainder;

    /**
     * @var Reservation[]|ArrayCollection
     *
     * @ORM\OneToMany(targetEntity="App\Entity\Reservation", mappedBy="user")
     */
    private $reservations;

    public function __construct()
    {
        $this->reservations = new ArrayCollection();
    }

    public function generateAuthenticationCode(): void
    {
        $this->authenticationCode = Uuid::uuid4()->toString();
    }

    public function getEmail(): string
    {
        return $this->email;
    }

    public function setEmail(string $email): void
    {
        $this->email = $email;
    }

    public function getGivenName(): string
    {
        return $this->givenName;
    }

    public function setGivenName(string $givenName): void
    {
        $this->givenName = $givenName;
    }

    public function getFamilyName(): string
    {
        return $this->familyName;
    }

    public function setFamilyName(string $familyName): void
    {
        $this->familyName = $familyName;
    }

    public function getAddress(): string
    {
        return $this->address;
    }

    public function setAddress(string $address): void
    {
        $this->address = $address;
    }

    public function getPhone(): string
    {
        return $this->phone;
    }

    public function setPhone(string $phone): void
    {
        $this->phone = $phone;
    }

    public function getCategory(): int
    {
        return $this->category;
    }

    public function setCategory(int $category): void
    {
        $this->category = $category;
    }

    public function getDiscount(): int
    {
        return $this->discount;
    }

    public function setDiscount(int $discount): void
    {
        $this->discount = $discount;
    }

    public function getDiscountDescription(): ?string
    {
        return $this->discountDescription;
    }

    public function setDiscountDescription(?string $discountDescription): void
    {
        $this->discountDescription = $discountDescription;
    }

    public function getLastPayedPeriodicFeeEnd(): ?\DateTime
    {
        return $this->lastPayedPeriodicFeeEnd;
    }

    public function setLastPayedPeriodicFeeEnd(?\DateTime $lastPayedPeriodicFeeEnd): void
    {
        $this->lastPayedPeriodicFeeEnd = $lastPayedPeriodicFeeEnd;
    }

    public function getAmountOwed(): int
    {
        return $this->amountOwed;
    }

    public function setAmountOwed(int $amountOwed): void
    {
        $this->amountOwed = $amountOwed;
    }

    public function getInvoiceId(): ?int
    {
        return $this->invoiceId;
    }

    public function setInvoiceId(?int $invoiceId): void
    {
        $this->invoiceId = $invoiceId;
    }

    public function getInvoiceLink(): ?string
    {
        return $this->invoiceLink;
    }

    public function setInvoiceLink(?string $invoiceLink): void
    {
        $this->invoiceLink = $invoiceLink;
    }

    public function getPaymentRemainderStatus(): int
    {
        return $this->paymentRemainderStatus;
    }

    public function setPaymentRemainderStatus(int $paymentRemainderStatus): void
    {
        $this->paymentRemainderStatus = $paymentRemainderStatus;
        $this->paymentRemainderStatusAt = new \DateTime();
    }

    public function getPaymentRemainderStatusAt(): ?\DateTime
    {
        return $this->paymentRemainderStatusAt;
    }

    public function getPaymentRemainder(): ?PaymentRemainder
    {
        return $this->paymentRemainder;
    }

    public function setPaymentRemainder(?PaymentRemainder $paymentRemainder): void
    {
        $this->paymentRemainder = $paymentRemainder;
    }

    /**
     * @return Reservation[]|ArrayCollection
     */
    public function getReservations()
    {
        return $this->reservations;
    }

    public function writePaymentInfo(PaymentInfo $paymentInfo)
    {
        $this->invoiceId = $paymentInfo->getInvoiceId();
        $this->invoiceLink = $paymentInfo->getInvoiceLink();
    }

    /**
     * @return PaymentInfo
     */
    public function getPaymentInfo()
    {
        if ($this->invoiceId === null || $this->invoiceLink === null) {
            throw new \Exception('no payment info available');
        }

        $paymentInfo = new PaymentInfo();

        $paymentInfo->setInvoiceId($this->invoiceId);
        $paymentInfo->setInvoiceLink($this->invoiceLink);

        return $paymentInfo;
    }

    public function clearPaymentInfo()
    {
        $this->invoiceLink = null;
        $this->invoiceId = null;
    }

    /**
     * @return Recipient
     */
    public function createRecipient()
    {
        $recipient = new Recipient();
        $recipient->setEmail($this->email);

        $recipient->setGivenName($this->givenName);
        $recipient->setFamilyName($this->familyName);

        $addressLines = explode("\n", $this->address);
        if (\count($addressLines) > 0) {
            $recipient->setStreet($addressLines[0]);
        }

        if (\count($addressLines) > 1) {
            $cityLine = $addressLines[\count($addressLines) - 1];
            $firstSpace = mb_strpos($cityLine, ' ');
            if ($firstSpace !== false) {
                $recipient->setPostcode(mb_substr($cityLine, 0, $firstSpace));
                $recipient->setPlace(mb_substr($cityLine, $firstSpace + 1));
            } else {
                $recipient->setPlace($cityLine);
            }
        }

        return $recipient;
    }

    public function getAuthenticationCode(): string
    {
        return $this->authenticationCode;
    }

    public function getAmountPayed(): ?int
    {
        return $this->amountPayed;
    }

    public function setAmountPayed(?int $amountPayed): void
    {
        $this->amountPayed = $amountPayed;
    }

    public function getTransactionId(): ?string
    {
        return $this->transactionId;
    }

    public function setTransactionId(?string $transactionId): void
    {
        $this->transactionId = $transactionId;
    }

    public function getMarkedAsPayed(): bool
    {
        return $this->markedAsPayed;
    }

    public function setMarkedAsPayed(bool $markedAsPayed): void
    {
        $this->markedAsPayed = $markedAsPayed;
    }
}


1			<?php
2
3			/*
4			* This file is part of the vseth-musikzimmer-pay project.
5			*
6			* (c) Florian Moser <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace App\Entity;
13
14			use App\Entity\Base\BaseEntity;
15			use App\Entity\Traits\IdTrait;
16			use App\Enum\PaymentRemainderStatusType;
17			use App\Enum\UserCategoryType;
18			use App\Model\Bill\Recipient;
19			use App\Model\PaymentInfo;
20			use Doctrine\Common\Collections\ArrayCollection;
21			use Doctrine\ORM\Mapping as ORM;
22			use Ramsey\Uuid\Uuid;
23
24			/**
25			* an event determines how the questionnaire looks like.
26			*
27			* @ORM\Entity(repositoryClass="App\Repository\UserRepository")
28			* @ORM\HasLifecycleCallbacks
29			*/
30			class User extends BaseEntity
31			{
32			use IdTrait;
33
34			/**
35			* @var string
36			*
37			* @ORM\Column(type="text")
38			*/
39			private $authenticationCode;
40
41			/**
42			* @var string
43			*
44			* @ORM\Column(type="text")
45			*/
46			private $email;
47
48			/**
49			* @var string
50			*
51			* @ORM\Column(type="text")
52			*/
53			private $givenName;
54
55			/**
56			* @var string
57			*
58			* @ORM\Column(type="text")
59			*/
60			private $familyName;
61
62			/**
63			* @var string
64			*
65			* @ORM\Column(type="text")
66			*/
67			private $address;
68
69			/**
70			* @var string
71			*
72			* @ORM\Column(type="text")
73			*/
74			private $phone;
75
76			/**
77			* @var int
78			*
79			* @ORM\Column(type="integer")
80			*/
81			private $category = UserCategoryType::STUDENT;
82
83			/**
84			* @var int
85			*
86			* @ORM\Column(type="integer")
87			*/
88			private $discount = 0;
89
90			/**
91			* @var string\|null
92			*
93			* @ORM\Column(type="text", nullable=true)
94			*/
95			private $discountDescription;
96
97			/**
98			* @var \DateTime\|null
99			*
100			* @ORM\Column(type="datetime", nullable=true)
101			*/
102			private $lastPayedPeriodicFeeEnd;
103
104			/**
105			* this is in francs.
106			*
107			* @var int
108			*
109			* @ORM\Column(type="integer")
110			*/
111			private $amountOwed;
112
113			/**
114			* this is in cents.
115			*
116			* @var int\|null
117			*
118			* @ORM\Column(type="integer", nullable=true)
119			*/
120			private $amountPayed;
121
122			/**
123			* @var string\|null
124			*
125			* @ORM\Column(type="text", nullable=true)
126			*/
127			private $transactionId;
128
129			/**
130			* @var int\|null
131			*
132			* @ORM\Column(type="integer", nullable=true)
133			*/
134			private $invoiceId;
135
136			/**
137			* @var string\|null
138			*
139			* @ORM\Column(type="text", nullable=true)
140			*/
141			private $invoiceLink;
142
143			/**
144			* @var int
145			*
146			* @ORM\Column(type="integer")
147			*/
148			private $paymentRemainderStatus = PaymentRemainderStatusType::NONE;
149
150			/**
151			* @var bool
152			*
153			* @ORM\Column(type="boolean", options={"default" : false})
154			*/
155			private $markedAsPayed;
156
157			/**
158			* @var \DateTime\|null
159			*
160			* @ORM\Column(type="datetime",nullable=true)
161			*/
162			private $paymentRemainderStatusAt;
163
164			/**
165			* @var PaymentRemainder\|null
166			*
167			* @ORM\ManyToOne(targetEntity="App\Entity\PaymentRemainder", inversedBy="users")
168			*/
169			private $paymentRemainder;
170
171			/**
172			* @var Reservation[]\|ArrayCollection
173			*
174			* @ORM\OneToMany(targetEntity="App\Entity\Reservation", mappedBy="user")
175			*/
176			private $reservations;
177
178			public function __construct()
179			{
180			$this->reservations = new ArrayCollection();
181			}
182
183			public function generateAuthenticationCode(): void
184			{
185			$this->authenticationCode = Uuid::uuid4()->toString();
186			}
187
188			public function getEmail(): string
189			{
190			return $this->email;
191			}
192
193			public function setEmail(string $email): void
194			{
195			$this->email = $email;
196			}
197
198			public function getGivenName(): string
199			{
200			return $this->givenName;
201			}
202
203			public function setGivenName(string $givenName): void
204			{
205			$this->givenName = $givenName;
206			}
207
208			public function getFamilyName(): string
209			{
210			return $this->familyName;
211			}
212
213			public function setFamilyName(string $familyName): void
214			{
215			$this->familyName = $familyName;
216			}
217
218			public function getAddress(): string
219			{
220			return $this->address;
221			}
222
223			public function setAddress(string $address): void
224			{
225			$this->address = $address;
226			}
227
228			public function getPhone(): string
229			{
230			return $this->phone;
231			}
232
233			public function setPhone(string $phone): void
234			{
235			$this->phone = $phone;
236			}
237
238			public function getCategory(): int
239			{
240			return $this->category;
241			}
242
243			public function setCategory(int $category): void
244			{
245			$this->category = $category;
246			}
247
248			public function getDiscount(): int
249			{
250			return $this->discount;
251			}
252
253			public function setDiscount(int $discount): void
254			{
255			$this->discount = $discount;
256			}
257
258			public function getDiscountDescription(): ?string
259			{
260			return $this->discountDescription;
261			}
262
263			public function setDiscountDescription(?string $discountDescription): void
264			{
265			$this->discountDescription = $discountDescription;
266			}
267
268			public function getLastPayedPeriodicFeeEnd(): ?\DateTime
269			{
270			return $this->lastPayedPeriodicFeeEnd;
271			}
272
273			public function setLastPayedPeriodicFeeEnd(?\DateTime $lastPayedPeriodicFeeEnd): void
274			{
275			$this->lastPayedPeriodicFeeEnd = $lastPayedPeriodicFeeEnd;
276			}
277
278			public function getAmountOwed(): int
279			{
280			return $this->amountOwed;
281			}
282
283			public function setAmountOwed(int $amountOwed): void
284			{
285			$this->amountOwed = $amountOwed;
286			}
287
288			public function getInvoiceId(): ?int
289			{
290			return $this->invoiceId;
291			}
292
293			public function setInvoiceId(?int $invoiceId): void
294			{
295			$this->invoiceId = $invoiceId;
296			}
297
298			public function getInvoiceLink(): ?string
299			{
300			return $this->invoiceLink;
301			}
302
303			public function setInvoiceLink(?string $invoiceLink): void
304			{
305			$this->invoiceLink = $invoiceLink;
306			}
307
308			public function getPaymentRemainderStatus(): int
309			{
310			return $this->paymentRemainderStatus;
311			}
312
313			public function setPaymentRemainderStatus(int $paymentRemainderStatus): void
314			{
315			$this->paymentRemainderStatus = $paymentRemainderStatus;
316			$this->paymentRemainderStatusAt = new \DateTime();
317			}
318
319			public function getPaymentRemainderStatusAt(): ?\DateTime
320			{
321			return $this->paymentRemainderStatusAt;
322			}
323
324			public function getPaymentRemainder(): ?PaymentRemainder
325			{
326			return $this->paymentRemainder;
327			}
328
329			public function setPaymentRemainder(?PaymentRemainder $paymentRemainder): void
330			{
331			$this->paymentRemainder = $paymentRemainder;
332			}
333
334			/**
335			* @return Reservation[]\|ArrayCollection
336			*/
337			public function getReservations()
338			{
339			return $this->reservations;
340			}
341
342			public function writePaymentInfo(PaymentInfo $paymentInfo)
343			{
344			$this->invoiceId = $paymentInfo->getInvoiceId();
345			$this->invoiceLink = $paymentInfo->getInvoiceLink();
346			}
347
348			/**
349			* @return PaymentInfo
350			*/
351			public function getPaymentInfo()
352			{
353			if ($this->invoiceId === null \|\| $this->invoiceLink === null) {
354			throw new \Exception('no payment info available');
355			}
356
357			$paymentInfo = new PaymentInfo();
358
359			$paymentInfo->setInvoiceId($this->invoiceId);
360			$paymentInfo->setInvoiceLink($this->invoiceLink);
361
362			return $paymentInfo;
363			}
364
365			public function clearPaymentInfo()
366			{
367			$this->invoiceLink = null;
368			$this->invoiceId = null;
369			}
370
371			/**
372			* @return Recipient
373			*/
374			public function createRecipient()
375			{
376			$recipient = new Recipient();
377			$recipient->setEmail($this->email);
378
379			$recipient->setGivenName($this->givenName);
380			$recipient->setFamilyName($this->familyName);
381
382			$addressLines = explode("\n", $this->address);
383			if (\count($addressLines) > 0) {
384			$recipient->setStreet($addressLines[0]);
385			}
386
387			if (\count($addressLines) > 1) {
388			$cityLine = $addressLines[\count($addressLines) - 1];
389			$firstSpace = mb_strpos($cityLine, ' ');
390			if ($firstSpace !== false) {
391			$recipient->setPostcode(mb_substr($cityLine, 0, $firstSpace));
392			$recipient->setPlace(mb_substr($cityLine, $firstSpace + 1));
393			} else {
394			$recipient->setPlace($cityLine);
395			}
396			}
397
398			return $recipient;
399			}
400
401			public function getAuthenticationCode(): string
402			{
403			return $this->authenticationCode;
404			}
405
406			public function getAmountPayed(): ?int
407			{
408			return $this->amountPayed;
409			}
410
411			public function setAmountPayed(?int $amountPayed): void
412			{
413			$this->amountPayed = $amountPayed;
414			}
415
416			public function getTransactionId(): ?string
417			{
418			return $this->transactionId;
419			}
420
421			public function setTransactionId(?string $transactionId): void
422			{
423			$this->transactionId = $transactionId;
424			}
425
426			public function getMarkedAsPayed(): bool
427			{
428			return $this->markedAsPayed;
429			}
430
431			public function setMarkedAsPayed(bool $markedAsPayed): void
432			{
433			$this->markedAsPayed = $markedAsPayed;
434			}
435			}
436

famoser / vseth-musikzimmer-pay

Push — master ( b55af8...b76ede )

User::setMarkedAsPayed() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like