Invoice::getTotalUnitCost() - Code Metrics - Inspection of "Add ItemBasket" - byrokrat/billing - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 308de5...6bfaa4 )

by Hannes

created 2016-04-28 10:31 UTC

Invoice::getTotalUnitCost() A

↳ Parent: Invoice

Complexity

Conditions	1
Paths	1

Size

Total Lines	10
Code Lines	6

Duplication

Lines	10
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace byrokrat\billing;

use byrokrat\amount\Amount;

/**
 * Generic invoice container object
 */
class Invoice
{
    /**
     * @var string Invoice serial number
     */
    private $serial;

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

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

    /**
     * @var string Message to buyer
     */
    private $message;

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

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

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

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

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

    /**
     * @var string 3-letter ISO 4217 currency code indicating currency
     */
    private $currency;

    /**
     * Construct invoice
     *
     * @param string         $serial       Invoice serial number
     * @param Seller         $seller       Registered seller
     * @param Buyer          $buyer        Registered buyer
     * @param string         $message      Invoice message
     * @param string         $ocr          Payment reference number
     * @param ItemBasket     $itemBasket  Container for charged items
     * @param \DateTime|null $billDate     Date of invoice creation
     * @param integer        $expiresAfter Nr of days before invoice expires
     * @param Amount|null    $deduction    Prepaid amound to deduct
     * @param string         $currency     3-letter ISO 4217 currency code indicating currency
     */
    public function __construct(
        string $serial,
        Seller $seller,
        Buyer $buyer,
        string $message = '',
        string $ocr = '',
        ItemBasket $itemBasket = null,
        \DateTime $billDate = null,
        int $expiresAfter = 30,
        Amount $deduction = null,
        string $currency = 'SEK'
    ) {
        $this->serial = $serial;
        $this->seller = $seller;
        $this->buyer = $buyer;
        $this->itemBasket = $itemBasket;
        $this->ocr = $ocr;
        $this->message = $message;
        $this->billDate = $billDate ?: new \DateTime;
        $this->expiresAfter = $expiresAfter;
        $this->deduction = $deduction ?: new Amount('0');
        $this->currency = $currency;
    }

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

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

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

    /**
     * Get invoice message
     */
    public function getMessage(): string
    {
        return $this->message;
    }

    /**
     * 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(): \DateTime
    {
        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(): \DateTime
    {
        $expireDate = clone $this->billDate;
        $expireDate->add(new \DateInterval("P{$this->getExpiresAfter()}D"));

        return $expireDate;
    }

    /**
     * Get prepaid amound to deduct
     */
    public function getDeduction(): Amount
    {
        return $this->deduction;
    }

    /**
     * Get the 3-letter ISO 4217 currency code indicating the invoice currency
     */
    public function getCurrency(): string
    {
        return $this->currency;
    }
}


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		/**
15		* @var string Invoice serial number
16		*/
17		private $serial;
18
19		/**
20		* @var Seller Registered seller
21		*/
22		private $seller;
23
24		/**
25		* @var Buyer Registered buyer
26		*/
27		private $buyer;
28
29		/**
30		* @var string Message to buyer
31		*/
32		private $message;
33
34		/**
35		* @var string Payment reference number
36		*/
37		private $ocr;
38
39		/**
40		* @var ItemBasket Container for charged items
41		*/
42		private $itemBasket = [];
43
44		/**
45		* @var \DateTime Creation date
46		*/
47		private $billDate;
48
49		/**
50		* @var integer Number of days before invoice expires
51		*/
52		private $expiresAfter;
53
54		/**
55		* @var Amount Prepaid amound to deduct
56		*/
57		private $deduction;
58
59		/**
60		* @var string 3-letter ISO 4217 currency code indicating currency
61		*/
62		private $currency;
63
64		/**
65		* Construct invoice
66		*
67		* @param string $serial Invoice serial number
68		* @param Seller $seller Registered seller
69		* @param Buyer $buyer Registered buyer
70		* @param string $message Invoice message
71		* @param string $ocr Payment reference number
72		* @param ItemBasket $itemBasket Container for charged items
73		* @param \DateTime\|null $billDate Date of invoice creation
74		* @param integer $expiresAfter Nr of days before invoice expires
75		* @param Amount\|null $deduction Prepaid amound to deduct
76		* @param string $currency 3-letter ISO 4217 currency code indicating currency
77		*/
78	15	public function __construct(
79		string $serial,
80		Seller $seller,
81		Buyer $buyer,
82		string $message = '',
83		string $ocr = '',
84		ItemBasket $itemBasket = null,
85		\DateTime $billDate = null,
86		int $expiresAfter = 30,
87		Amount $deduction = null,
88		string $currency = 'SEK'
89		) {
90	15	$this->serial = $serial;
91	15	$this->seller = $seller;
92	15	$this->buyer = $buyer;
93	15	$this->itemBasket = $itemBasket;
94	15	$this->ocr = $ocr;
95	15	$this->message = $message;
96	15	$this->billDate = $billDate ?: new \DateTime;
97	15	$this->expiresAfter = $expiresAfter;
98	15	$this->deduction = $deduction ?: new Amount('0');
99	15	$this->currency = $currency;
100	15	}
101
102		/**
103		* Get invoice serial number
104		*/
105	1	public function getSerial(): string
106		{
107	1	return $this->serial;
108		}
109
110		/**
111		* Get seller
112		*/
113	1	public function getSeller(): Seller
114		{
115	1	return $this->seller;
116		}
117
118		/**
119		* Get buyer
120		*/
121	1	public function getBuyer(): Buyer
122		{
123	1	return $this->buyer;
124		}
125
126		/**
127		* Get invoice message
128		*/
129	2	public function getMessage(): string
130		{
131	2	return $this->message;
132		}
133
134		/**
135		* Get invoice reference number
136		*/
137	4	public function getOcr(): string
138		{
139	4	return $this->ocr;
140		}
141
142		/**
143		* Get item container
144		*/
145	2	public function getItems(): ItemBasket
146		{
147	2	return $this->itemBasket;
148		}
149
150		/**
151		* Get charged amount (including VAT and deduction)
152		*/
153	1	public function getInvoiceTotal(): Amount
154		{
155	1	return $this->getItems()->getTotalCost()->subtract($this->getDeduction());
156		}
157
158		/**
159		* Get date of invoice creation
160		*/
161	3	public function getBillDate(): \DateTime
162		{
163	3	return $this->billDate;
164		}
165
166		/**
167		* Get number of days before invoice expires
168		*/
169	2	public function getExpiresAfter(): int
170		{
171	2	return $this->expiresAfter;
172		}
173
174		/**
175		* Get date when invoice expires
176		*/
177	1	public function getExpirationDate(): \DateTime
178		{
179	1	$expireDate = clone $this->billDate;
180	1	$expireDate->add(new \DateInterval("P{$this->getExpiresAfter()}D"));
181
182	1	return $expireDate;
183		}
184
185		/**
186		* Get prepaid amound to deduct
187		*/
188	3	public function getDeduction(): Amount
189		{
190	3	return $this->deduction;
191		}
192
193		/**
194		* Get the 3-letter ISO 4217 currency code indicating the invoice currency
195		*/
196	2	public function getCurrency(): string
197		{
198	2	return $this->currency;
199		}
200		}
201

byrokrat / billing

Push — master ( 308de5...6bfaa4 )

Invoice::getTotalUnitCost() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like