OrderLine::getVatPct() - Code Metrics - Inspection of "added helper methods for excl/incl vat" - loevgaard/dandomain-foundation-entities - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 257f70...0f3ddf )

by Joachim

created 2017-12-29 16:05 UTC

OrderLine::getVatPct() A

↳ Parent: OrderLine

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

namespace Loevgaard\DandomainFoundation\Entity;

use Doctrine\ORM\Mapping as ORM;
use Loevgaard\DandomainFoundation;
use Loevgaard\DandomainFoundation\Entity\Generated\OrderLineInterface;
filter:
    dependency_paths: ["lib/*"]
use Loevgaard\DandomainFoundation\Entity\Generated\OrderLineTrait;
filter:
    dependency_paths: ["lib/*"]
use Loevgaard\DandomainFoundation\Entity\Generated\ProductInterface;
filter:
    dependency_paths: ["lib/*"]
use Money\Money;

/**
 * @ORM\Entity()
 * @ORM\Table(name="ldf_order_lines")
 */
class OrderLine extends AbstractEntity implements OrderLineInterface
{
    use OrderLineTrait;

    protected $hydrateConversions = [
        'id' => 'externalId',
        'productId' => 'productNumber'
    ];

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

    /**
     * @var int
     *
     * @ORM\Column(type="integer", unique=true)
     */
    protected $externalId;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true, type="string", length=191)
     */
    protected $fileUrl;

    /**
     * @var int|null
     *
     * @ORM\Column(nullable=true, type="string", length=191)
     */
    protected $productNumber;

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

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

    /**
     * This number is excl vat
     *
     * @var int|null
     *
     * @ORM\Column(nullable=true, type="integer")
     */
    protected $unitPrice;

    /**
     * This number is excl vat
     *
     * @var int|null
     *
     * @ORM\Column(nullable=true, type="integer")
     */
    protected $totalPrice;

    /**
     * @var float|null
     *
     * @ORM\Column(nullable=true, type="decimal", precision=5, scale=2)
     */
    protected $vatPct;

    /**
     * @var string|null
     *
     * @ORM\Column(nullable=true, type="string", length=191)
     */
    protected $variant;

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

    /**
     * @var Order
     *
     * @ORM\JoinColumn(onDelete="CASCADE", nullable=false)
     * @ORM\ManyToOne(inversedBy="orderLines", targetEntity="Order")
     */
    protected $order;

    /**
     * @var ProductInterface|null
     *
     * @ORM\JoinColumn(onDelete="SET NULL")
     * @ORM\ManyToOne(targetEntity="Product", cascade={"persist"})
     */
    protected $product;

    // @todo implement withVat and withoutVat methods

    public function hydrate(array $data, bool $useConversions = false, $scalarsOnly = true)
    {
        if (is_null($this->order)) {
            throw new \RuntimeException('Cannot hydrate order line without an associated order');
        }

        $currency = $this->order->getCurrencyCode();

        if (isset($data['unitPrice'])) {
            $data['unitPrice'] = DandomainFoundation\createMoneyFromFloat($currency, $data['unitPrice']);
        }

        if (isset($data['totalPrice'])) {
            $data['totalPrice'] = DandomainFoundation\createMoneyFromFloat($currency, $data['totalPrice']);
        }

        parent::hydrate($data, $useConversions, $scalarsOnly);
    }

    /*
     * Helper methods
     */
    public function getUnitPriceInclVat() : ?Money
    {
        $unitPrice = $this->getUnitPrice();
        if(!$unitPrice) {
            return null;
        }

        $multiplier = (100 + $this->vatPct) / 100;

        return $unitPrice->multiply($multiplier);
    }

    public function getUnitPriceExclVat() : ?Money
    {
        return $this->getUnitPrice();
    }

    public function getTotalPriceInclVat() : ?Money
    {
        $totalPrice = $this->getTotalPrice();
        if(!$totalPrice) {
            return null;
        }

        $multiplier = (100 + $this->vatPct) / 100;

        return $totalPrice->multiply($multiplier);
    }

    public function getTotalPriceExclVat() : ?Money
    {
        return $this->getTotalPrice();
    }

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

    /**
     * @param int $id
     * @return OrderLineInterface
     */
    public function setId(int $id)
    {
        $this->id = $id;
        return $this;
    }

    /**
     * @return int
     */
    public function getExternalId(): int
    {
        return (int)$this->externalId;
    }

    /**
     * @param int $externalId
     * @return OrderLineInterface
     */
    public function setExternalId(int $externalId)
    {
        $this->externalId = $externalId;
        return $this;
    }

    /**
     * @return null|string
     */
    public function getFileUrl()
    {
        return $this->fileUrl;
    }

    /**
     * @param null|string $fileUrl
     * @return OrderLineInterface
     */
    public function setFileUrl($fileUrl)
    {
        $this->fileUrl = $fileUrl;
        return $this;
    }

    /**
     * @return int|null
     */
    public function getProductNumber()
    {
        return $this->productNumber;
    }

    /**
     * @param int|null $productNumber
     * @return OrderLineInterface
     */
    public function setProductNumber($productNumber)
    {
        $this->productNumber = $productNumber;
        return $this;
    }

    /**
     * @return null|string
     */
    public function getProductName()
    {
        return $this->productName;
    }

    /**
     * @param null|string $productName
     * @return OrderLineInterface
     */
    public function setProductName($productName)
    {
        $this->productName = $productName;
        return $this;
    }

    /**
     * @return int|null
     */
    public function getQuantity()
    {
        return $this->quantity;
    }

    /**
     * @param int|null $quantity
     * @return OrderLineInterface
     */
    public function setQuantity($quantity)
    {
        $this->quantity = $quantity;
        return $this;
    }

    /**
     * @return Money|null
     */
    public function getTotalPrice()
    {
        return DandomainFoundation\createMoney((string)$this->getOrder()->getCurrencyCode(), (int)$this->totalPrice);
    }

    /**
     * @param Money|null $totalPrice
     * @return OrderLineInterface
     */
    public function setTotalPrice(Money $totalPrice = null)
    {
        $this->totalPrice = $totalPrice ? $totalPrice->getAmount() : $totalPrice;

        return $this;
    }

    /**
     * @return Money|null
     */
    public function getUnitPrice()
    {
        return DandomainFoundation\createMoney((string)$this->getOrder()->getCurrencyCode(), (int)$this->unitPrice);
    }

    /**
     * @param Money|null $unitPrice
     * @return OrderLineInterface
     */
    public function setUnitPrice(Money $unitPrice = null)
    {
        $this->unitPrice = $unitPrice ? $unitPrice->getAmount() : $unitPrice;
        return $this;
    }

    /**
     * @return float|null
     */
    public function getVatPct()
    {
        return $this->vatPct;
    }

    /**
     * @param float|null $vatPct
     * @return OrderLineInterface
     */
    public function setVatPct($vatPct)
    {
        $this->vatPct = $vatPct;
        return $this;
    }

    /**
     * @return null|string
     */
    public function getVariant()
    {
        return $this->variant;
    }

    /**
     * @param null|string $variant
     * @return OrderLineInterface
     */
    public function setVariant($variant)
    {
        $this->variant = $variant;
        return $this;
    }

    /**
     * @return null|string
     */
    public function getXmlParams()
    {
        return $this->xmlParams;
    }

    /**
     * @param null|string $xmlParams
     * @return OrderLineInterface
     */
    public function setXmlParams($xmlParams)
    {
        $this->xmlParams = $xmlParams;
        return $this;
    }

    /**
     * @return Order
     */
    public function getOrder(): Order
    {
        return $this->order;
    }

    /**
     * @param Order|null $order
     * @return OrderLineInterface
     */
    public function setOrder(Order $order)
    {
        $this->order = $order;
        return $this;
    }

    /**
     * @return ProductInterface|null
     */
    public function getProduct()
    {
        return $this->product;
    }

    /**
     * @param ProductInterface|null $product
     * @return OrderLineInterface
     */
    public function setProduct(ProductInterface $product = null)
    {
        $this->product = $product;
        return $this;
    }
}


1			<?php
2
3			namespace Loevgaard\DandomainFoundation\Entity;
4
5			use Doctrine\ORM\Mapping as ORM;
6			use Loevgaard\DandomainFoundation;
7			use Loevgaard\DandomainFoundation\Entity\Generated\OrderLineInterface;
			0 ignored issues – show Bug introduced 2017-12-04 09:23 UTC by Report Bug Copy Issue Report The type `Loevgaard\DandomainFound...ated\OrderLineInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
8			use Loevgaard\DandomainFoundation\Entity\Generated\OrderLineTrait;
			0 ignored issues – show Bug introduced 2017-12-04 09:23 UTC by Report Bug Copy Issue Report The type `Loevgaard\DandomainFound...enerated\OrderLineTrait` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
9			use Loevgaard\DandomainFoundation\Entity\Generated\ProductInterface;
			0 ignored issues – show Bug introduced 2017-12-04 09:23 UTC by Report Bug Copy Issue Report The type `Loevgaard\DandomainFound...erated\ProductInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use Money\Money;
11
12			/**
13			* @ORM\Entity()
14			* @ORM\Table(name="ldf_order_lines")
15			*/
16			class OrderLine extends AbstractEntity implements OrderLineInterface
17			{
18			use OrderLineTrait;
19
20			protected $hydrateConversions = [
21			'id' => 'externalId',
22			'productId' => 'productNumber'
23			];
24
25			/**
26			* @var int
27			*
28			* @ORM\Id
29			* @ORM\GeneratedValue
30			* @ORM\Column(type="integer")
31			**/
32			protected $id;
33
34			/**
35			* @var int
36			*
37			* @ORM\Column(type="integer", unique=true)
38			*/
39			protected $externalId;
40
41			/**
42			* @var string\|null
43			*
44			* @ORM\Column(nullable=true, type="string", length=191)
45			*/
46			protected $fileUrl;
47
48			/**
49			* @var int\|null
50			*
51			* @ORM\Column(nullable=true, type="string", length=191)
52			*/
53			protected $productNumber;
54
55			/**
56			* @var string\|null
57			*
58			* @ORM\Column(nullable=true, type="text")
59			*/
60			protected $productName;
61
62			/**
63			* @var int\|null
64			*
65			* @ORM\Column(nullable=true, type="integer")
66			*/
67			protected $quantity;
68
69			/**
70			* This number is excl vat
71			*
72			* @var int\|null
73			*
74			* @ORM\Column(nullable=true, type="integer")
75			*/
76			protected $unitPrice;
77
78			/**
79			* This number is excl vat
80			*
81			* @var int\|null
82			*
83			* @ORM\Column(nullable=true, type="integer")
84			*/
85			protected $totalPrice;
86
87			/**
88			* @var float\|null
89			*
90			* @ORM\Column(nullable=true, type="decimal", precision=5, scale=2)
91			*/
92			protected $vatPct;
93
94			/**
95			* @var string\|null
96			*
97			* @ORM\Column(nullable=true, type="string", length=191)
98			*/
99			protected $variant;
100
101			/**
102			* @var string\|null
103			*
104			* @ORM\Column(nullable=true, type="text")
105			*/
106			protected $xmlParams;
107
108			/**
109			* @var Order
110			*
111			* @ORM\JoinColumn(onDelete="CASCADE", nullable=false)
112			* @ORM\ManyToOne(inversedBy="orderLines", targetEntity="Order")
113			*/
114			protected $order;
115
116			/**
117			* @var ProductInterface\|null
118			*
119			* @ORM\JoinColumn(onDelete="SET NULL")
120			* @ORM\ManyToOne(targetEntity="Product", cascade={"persist"})
121			*/
122			protected $product;
123
124			// @todo implement withVat and withoutVat methods
125
126			public function hydrate(array $data, bool $useConversions = false, $scalarsOnly = true)
127			{
128			if (is_null($this->order)) {
129			throw new \RuntimeException('Cannot hydrate order line without an associated order');
130			}
131
132			$currency = $this->order->getCurrencyCode();
133
134			if (isset($data['unitPrice'])) {
135			$data['unitPrice'] = DandomainFoundation\createMoneyFromFloat($currency, $data['unitPrice']);
136			}
137
138			if (isset($data['totalPrice'])) {
139			$data['totalPrice'] = DandomainFoundation\createMoneyFromFloat($currency, $data['totalPrice']);
140			}
141
142			parent::hydrate($data, $useConversions, $scalarsOnly);
143			}
144
145			/*
146			* Helper methods
147			*/
148			public function getUnitPriceInclVat() : ?Money
149			{
150			$unitPrice = $this->getUnitPrice();
151			if(!$unitPrice) {
152			return null;
153			}
154
155			$multiplier = (100 + $this->vatPct) / 100;
156
157			return $unitPrice->multiply($multiplier);
158			}
159
160			public function getUnitPriceExclVat() : ?Money
161			{
162			return $this->getUnitPrice();
163			}
164
165			public function getTotalPriceInclVat() : ?Money
166			{
167			$totalPrice = $this->getTotalPrice();
168			if(!$totalPrice) {
169			return null;
170			}
171
172			$multiplier = (100 + $this->vatPct) / 100;
173
174			return $totalPrice->multiply($multiplier);
175			}
176
177			public function getTotalPriceExclVat() : ?Money
178			{
179			return $this->getTotalPrice();
180			}
181
182			/**
183			* @return int
184			*/
185			public function getId(): int
186			{
187			return (int)$this->id;
188			}
189
190			/**
191			* @param int $id
192			* @return OrderLineInterface
193			*/
194			public function setId(int $id)
195			{
196			$this->id = $id;
197			return $this;
198			}
199
200			/**
201			* @return int
202			*/
203			public function getExternalId(): int
204			{
205			return (int)$this->externalId;
206			}
207
208			/**
209			* @param int $externalId
210			* @return OrderLineInterface
211			*/
212			public function setExternalId(int $externalId)
213			{
214			$this->externalId = $externalId;
215			return $this;
216			}
217
218			/**
219			* @return null\|string
220			*/
221			public function getFileUrl()
222			{
223			return $this->fileUrl;
224			}
225
226			/**
227			* @param null\|string $fileUrl
228			* @return OrderLineInterface
229			*/
230			public function setFileUrl($fileUrl)
231			{
232			$this->fileUrl = $fileUrl;
233			return $this;
234			}
235
236			/**
237			* @return int\|null
238			*/
239			public function getProductNumber()
240			{
241			return $this->productNumber;
242			}
243
244			/**
245			* @param int\|null $productNumber
246			* @return OrderLineInterface
247			*/
248			public function setProductNumber($productNumber)
249			{
250			$this->productNumber = $productNumber;
251			return $this;
252			}
253
254			/**
255			* @return null\|string
256			*/
257			public function getProductName()
258			{
259			return $this->productName;
260			}
261
262			/**
263			* @param null\|string $productName
264			* @return OrderLineInterface
265			*/
266			public function setProductName($productName)
267			{
268			$this->productName = $productName;
269			return $this;
270			}
271
272			/**
273			* @return int\|null
274			*/
275			public function getQuantity()
276			{
277			return $this->quantity;
278			}
279
280			/**
281			* @param int\|null $quantity
282			* @return OrderLineInterface
283			*/
284			public function setQuantity($quantity)
285			{
286			$this->quantity = $quantity;
287			return $this;
288			}
289
290			/**
291			* @return Money\|null
292			*/
293			public function getTotalPrice()
294			{
295			return DandomainFoundation\createMoney((string)$this->getOrder()->getCurrencyCode(), (int)$this->totalPrice);
296			}
297
298			/**
299			* @param Money\|null $totalPrice
300			* @return OrderLineInterface
301			*/
302			public function setTotalPrice(Money $totalPrice = null)
303			{
304			$this->totalPrice = $totalPrice ? $totalPrice->getAmount() : $totalPrice;
305
306			return $this;
307			}
308
309			/**
310			* @return Money\|null
311			*/
312			public function getUnitPrice()
313			{
314			return DandomainFoundation\createMoney((string)$this->getOrder()->getCurrencyCode(), (int)$this->unitPrice);
315			}
316
317			/**
318			* @param Money\|null $unitPrice
319			* @return OrderLineInterface
320			*/
321			public function setUnitPrice(Money $unitPrice = null)
322			{
323			$this->unitPrice = $unitPrice ? $unitPrice->getAmount() : $unitPrice;
324			return $this;
325			}
326
327			/**
328			* @return float\|null
329			*/
330			public function getVatPct()
331			{
332			return $this->vatPct;
333			}
334
335			/**
336			* @param float\|null $vatPct
337			* @return OrderLineInterface
338			*/
339			public function setVatPct($vatPct)
340			{
341			$this->vatPct = $vatPct;
342			return $this;
343			}
344
345			/**
346			* @return null\|string
347			*/
348			public function getVariant()
349			{
350			return $this->variant;
351			}
352
353			/**
354			* @param null\|string $variant
355			* @return OrderLineInterface
356			*/
357			public function setVariant($variant)
358			{
359			$this->variant = $variant;
360			return $this;
361			}
362
363			/**
364			* @return null\|string
365			*/
366			public function getXmlParams()
367			{
368			return $this->xmlParams;
369			}
370
371			/**
372			* @param null\|string $xmlParams
373			* @return OrderLineInterface
374			*/
375			public function setXmlParams($xmlParams)
376			{
377			$this->xmlParams = $xmlParams;
378			return $this;
379			}
380
381			/**
382			* @return Order
383			*/
384			public function getOrder(): Order
385			{
386			return $this->order;
387			}
388
389			/**
390			* @param Order\|null $order
391			* @return OrderLineInterface
392			*/
393			public function setOrder(Order $order)
394			{
395			$this->order = $order;
396			return $this;
397			}
398
399			/**
400			* @return ProductInterface\|null
401			*/
402			public function getProduct()
403			{
404			return $this->product;
405			}
406
407			/**
408			* @param ProductInterface\|null $product
409			* @return OrderLineInterface
410			*/
411			public function setProduct(ProductInterface $product = null)
412			{
413			$this->product = $product;
414			return $this;
415			}
416			}
417

loevgaard / dandomain-foundation-entities

Push — master ( 257f70...0f3ddf )

OrderLine::getVatPct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like