Invoice::getMessage() - Code Metrics - Inspection of "Renaming and add attributes" - byrokrat/billing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ee0bf4...f89977 )

by Hannes

created 2016-04-29 11:01 UTC

Invoice::getMessage() A

↳ Parent: Invoice

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace byrokrat\billing;

use byrokrat\amount\Amount;

/**
 * Generic invoice container object
 */
class Invoice
{
    use AttributesTrait;

    /**
     * @var string Invoice serial number
     */
    private $serial;

    /**
     * @var AgentInterface Registered seller
     */
    private $seller;

    /**
     * @var AgentInterface Registered buyer
     */
    private $buyer;

    /**
     * @var string Payment reference number
     */
    private $ocr;

    /**
     * @var ItemBasket Container for charged items
     */
    private $itemBasket = [];

    /**
     * @var \DateTimeImmutable Creation date
     */
    private $billDate;

    /**
     * @var integer Number of days before invoice expires
     */
    private $expiresAfter;

    /**
     * @var Amount Prepaid amound to deduct
     */
    private $deduction;

    /**
     * Construct invoice
     *
     * @param string             $serial       Invoice serial number
     * @param AgentInterface     $seller       Registered seller
     * @param AgentInterface     $buyer        Registered buyer
     * @param string             $message      Invoice message
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param string             $ocr          Payment reference number
     * @param ItemBasket         $itemBasket   Container for charged items
     * @param \DateTimeImmutable $billDate     Date of invoice creation
     * @param integer            $expiresAfter Nr of days before invoice expires
     * @param Amount             $deduction    Prepaid amound to deduct
     */
    public function __construct(
        string $serial,
        AgentInterface $seller,
        AgentInterface $buyer,
        string $ocr = '',
        ItemBasket $itemBasket = null,
        \DateTimeImmutable $billDate = null,
        int $expiresAfter = 30,
        Amount $deduction = null
    ) {
        $this->serial = $serial;
        $this->seller = $seller;
        $this->buyer = $buyer;
        $this->itemBasket = $itemBasket;
        $this->ocr = $ocr;
        $this->billDate = $billDate ?: new \DateTimeImmutable;
        $this->expiresAfter = $expiresAfter;
        $this->deduction = $deduction;
    }

    /**
     * Get invoice serial number
     */
    public function getSerial(): string
    {
        return $this->serial;
    }

    /**
     * Get seller
     */
    public function getSeller(): AgentInterface
    {
        return $this->seller;
    }

    /**
     * Get buyer
     */
    public function getBuyer(): AgentInterface
    {
        return $this->buyer;
    }

    /**
     * Get invoice reference number
     */
    public function getOcr(): string
    {
        return $this->ocr;
    }

    /**
     * Get item container
     */
    public function getItems(): ItemBasket
    {
        return $this->itemBasket;
    }

    /**
     * Get charged amount (including VAT and deduction)
     */
    public function getInvoiceTotal(): Amount
    {
        return $this->getItems()->getTotalCost()->subtract($this->getDeduction());
    }

    /**
     * Get date of invoice creation
     */
    public function getBillDate(): \DateTimeImmutable
    {
        return $this->billDate;
    }

    /**
     * Get number of days before invoice expires
     */
    public function getExpiresAfter(): int
    {
        return $this->expiresAfter;
    }

    /**
     * Get date when invoice expires
     */
    public function getExpirationDate(): \DateTimeImmutable
    {
        return $this->billDate->add(new \DateInterval("P{$this->getExpiresAfter()}D"));
        $expireDate = clone $this->billDate;
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
        $expireDate->add(new \DateInterval("P{$this->getExpiresAfter()}D"));

        return $expireDate;
    }

    /**
     * Get prepaid amound to deduct
     */
    public function getDeduction(): Amount
    {
        if (!isset($this->deduction)) {
            return $this->itemBasket->createCurrencyObject('0');
        }

        return $this->deduction;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace byrokrat\billing;
6
7		use byrokrat\amount\Amount;
8
9		/**
10		* Generic invoice container object
11		*/
12		class Invoice
13		{
14		use AttributesTrait;
15
16		/**
17		* @var string Invoice serial number
18		*/
19		private $serial;
20
21		/**
22		* @var AgentInterface Registered seller
23		*/
24		private $seller;
25
26		/**
27		* @var AgentInterface Registered buyer
28		*/
29		private $buyer;
30
31		/**
32		* @var string Payment reference number
33		*/
34		private $ocr;
35
36		/**
37		* @var ItemBasket Container for charged items
38		*/
39		private $itemBasket = [];
40
41		/**
42		* @var \DateTimeImmutable Creation date
43		*/
44		private $billDate;
45
46		/**
47		* @var integer Number of days before invoice expires
48		*/
49		private $expiresAfter;
50
51		/**
52		* @var Amount Prepaid amound to deduct
53		*/
54		private $deduction;
55
56		/**
57		* Construct invoice
58		*
59		* @param string $serial Invoice serial number
60		* @param AgentInterface $seller Registered seller
61		* @param AgentInterface $buyer Registered buyer
62		* @param string $message Invoice message
		0 ignored issues – show Bug introduced 2016-04-29 11:03 UTC by Report Bug Copy Issue Report There is no parameter named `$message`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
63		* @param string $ocr Payment reference number
64		* @param ItemBasket $itemBasket Container for charged items
65		* @param \DateTimeImmutable $billDate Date of invoice creation
66		* @param integer $expiresAfter Nr of days before invoice expires
67		* @param Amount $deduction Prepaid amound to deduct
68		*/
69	15	public function __construct(
70		string $serial,
71		AgentInterface $seller,
72		AgentInterface $buyer,
73		string $ocr = '',
74		ItemBasket $itemBasket = null,
75		\DateTimeImmutable $billDate = null,
76		int $expiresAfter = 30,
77		Amount $deduction = null
78		) {
79	15	$this->serial = $serial;
80	15	$this->seller = $seller;
81	15	$this->buyer = $buyer;
82	15	$this->itemBasket = $itemBasket;
83	15	$this->ocr = $ocr;
84	15	$this->billDate = $billDate ?: new \DateTimeImmutable;
85	15	$this->expiresAfter = $expiresAfter;
86	15	$this->deduction = $deduction;
87	15	}
88
89		/**
90		* Get invoice serial number
91		*/
92	1	public function getSerial(): string
93		{
94	1	return $this->serial;
95		}
96
97		/**
98		* Get seller
99		*/
100	1	public function getSeller(): AgentInterface
101		{
102	1	return $this->seller;
103		}
104
105		/**
106		* Get buyer
107		*/
108	1	public function getBuyer(): AgentInterface
109		{
110	1	return $this->buyer;
111		}
112
113		/**
114		* Get invoice reference number
115		*/
116	4	public function getOcr(): string
117		{
118	4	return $this->ocr;
119		}
120
121		/**
122		* Get item container
123		*/
124	4	public function getItems(): ItemBasket
125		{
126	4	return $this->itemBasket;
127		}
128
129		/**
130		* Get charged amount (including VAT and deduction)
131		*/
132	3	public function getInvoiceTotal(): Amount
133		{
134	3	return $this->getItems()->getTotalCost()->subtract($this->getDeduction());
135		}
136
137		/**
138		* Get date of invoice creation
139		*/
140	3	public function getBillDate(): \DateTimeImmutable
141		{
142	3	return $this->billDate;
143		}
144
145		/**
146		* Get number of days before invoice expires
147		*/
148	1	public function getExpiresAfter(): int
149		{
150	1	return $this->expiresAfter;
151		}
152
153		/**
154		* Get date when invoice expires
155		*/
156	1	public function getExpirationDate(): \DateTimeImmutable
157		{
158	1	return $this->billDate->add(new \DateInterval("P{$this->getExpiresAfter()}D"));
159		$expireDate = clone $this->billDate;
		0 ignored issues – show Unused Code introduced 2016-04-29 11:03 UTC by Report Bug Copy Issue Report `$expireDate = clone $this->billDate;` does not seem to be reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
160		$expireDate->add(new \DateInterval("P{$this->getExpiresAfter()}D"));
161
162		return $expireDate;
163		}
164
165		/**
166		* Get prepaid amound to deduct
167		*/
168	5	public function getDeduction(): Amount
169		{
170	5	if (!isset($this->deduction)) {
171	1	return $this->itemBasket->createCurrencyObject('0');
172		}
173
174	4	return $this->deduction;
175		}
176		}
177

byrokrat / billing

Push — master ( ee0bf4...f89977 )

Invoice::getMessage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like