QrBill::create() - Code Metrics - Inspection of "Refactor QrBillTest" - sprain/php-swiss-qr-bill - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9d642a...6a24bf )

by Manuel

created 2018-02-24 15:20 UTC

QrBill::create() A

↳ Parent: QrBill

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	7
nc	1
nop	0
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0

<?php

namespace Sprain\SwissQrBill;

use Endroid\QrCode\QrCode;
use Sprain\SwissQrBill\DataGroups\AlternativeScheme;
use Sprain\SwissQrBill\DataGroups\Creditor;
use Sprain\SwissQrBill\DataGroups\CreditorInformation;
use Sprain\SwissQrBill\DataGroups\Header;
use Sprain\SwissQrBill\DataGroups\Interfaces\QrCodeData;
use Sprain\SwissQrBill\DataGroups\PaymentAmountInformation;
use Sprain\SwissQrBill\DataGroups\PaymentReference;
use Sprain\SwissQrBill\DataGroups\UltimateCreditor;
use Sprain\SwissQrBill\DataGroups\UltimateDebtor;
use Sprain\SwissQrBill\Exception\InvalidQrBillDataException;
use Sprain\SwissQrBill\Validator\Interfaces\Validatable;
use Sprain\SwissQrBill\Validator\ValidatorTrait;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class QrBill implements Validatable
{
    use ValidatorTrait;

    const SWISS_CROSS_LOGO_FILE = __DIR__ . '/../assets/swiss-cross.png';

    /** @var Header */
    private $header;

    /** @var CreditorInformation */
    private $creditorInformation;

    /** @var Creditor */
    private $creditor;

    /** @var UltimateCreditor */
    private $ultimateCreditor;

    /** @var PaymentAmountInformation */
    private $paymentAmountInformation;

    /** @var UltimateDebtor */
    private $ultimateDebtor;

    /** @var PaymentReference */
    private $paymentReference;

    /** @var AlternativeScheme[] */
    private $alternativeSchemes = [];

    public static function create() : self
    {
        $header = new Header();
        $header->setCoding(Header::CODING_LATIN);
        $header->setQrType(Header::QRTYPE_SPC);
        $header->setVersion(Header::VERSION_0100);

        $qrBill = new self();
        $qrBill->setHeader($header);

        return $qrBill;
    }

    public function getHeader(): Header
    {
        return $this->header;
    }

    public function setHeader(Header $header) : self
    {
        $this->header = $header;
        
        return $this;
    }

    public function getCreditorInformation(): CreditorInformation
    {
        return $this->creditorInformation;
    }

    public function setCreditorInformation(CreditorInformation $creditorInformation) : self
    {
        $this->creditorInformation = $creditorInformation;

        return $this;
    }

    public function getCreditor(): Creditor
    {
        return $this->creditor;
    }

    public function setCreditor(Creditor $creditor) : self
    {
        $this->creditor = $creditor;
        
        return $this;
    }

    public function getUltimateCreditor(): ?UltimateCreditor
    {
        return $this->ultimateCreditor;
    }

    public function setUltimateCreditor(UltimateCreditor $ultimateCreditor) : self
    {
        $this->ultimateCreditor = $ultimateCreditor;
        
        return $this;
    }

    public function getPaymentAmountInformation(): PaymentAmountInformation
    {
        return $this->paymentAmountInformation;
    }

    public function setPaymentAmountInformation(PaymentAmountInformation $paymentAmountInformation) : self
    {
        $this->paymentAmountInformation = $paymentAmountInformation;
        
        return $this;
    }

    public function getUltimateDebtor(): ?UltimateDebtor
    {
        return $this->ultimateDebtor;
    }

    public function setUltimateDebtor(UltimateDebtor $ultimateDebtor) : self
    {
        $this->ultimateDebtor = $ultimateDebtor;
        
        return $this;
    }

    public function getPaymentReference(): PaymentReference
    {
        return $this->paymentReference;
    }

    public function setPaymentReference(PaymentReference $paymentReference) : self
    {
        $this->paymentReference = $paymentReference;
        
        return $this;
    }

    public function getAlternativeSchemes(): array
    {
        return $this->alternativeSchemes;
    }

    public function setAlternativeSchemes(array $alternativeSchemes) : self
    {
        $this->alternativeSchemes = $alternativeSchemes;

        return $this;
    }

    public function getQrCode() : QrCode
    {
        if (!$this->isValid()) {
            throw new InvalidQrBillDataException(
                'The provided data is not valid to generate a qr code. Use getViolations() to find details.'
            );
        }

        $qrCode = new QrCode();
        $qrCode->setText($this->getQrCodeData());
        $qrCode->setSize(543); // recommended 46x46 mm in px @ 300dpi
        $qrCode->setMargin(19); // recommended 1,6 mm in px @ 300dpi
        $qrCode->setLogoPath(self::SWISS_CROSS_LOGO_FILE);
        $qrCode->setLogoWidth(83); // recommended 7x7 mm in px @ 300dpi

        return $qrCode;
    }

    private function getQrCodeData() : string
    {
        $elements = [
            $this->getHeader(),
            $this->getCreditorInformation(),
            $this->getCreditor(),
            $this->getUltimateCreditor() ?: new UltimateCreditor(),
            $this->getPaymentAmountInformation(),
            $this->getUltimateDebtor() ?: new UltimateDebtor(),
            $this->getPaymentReference(),
            $this->getAlternativeSchemes()
        ];

        return $this->extractQrCodeDataFromElements($elements);
    }

    private function extractQrCodeDataFromElements(array $elements) : string
    {
        $qrCodeElements = [];

        foreach ($elements as $element) {
            if ($element instanceof QrCodeData) {
                $qrCodeElements = array_merge($qrCodeElements, $element->getQrCodeData());
            }
        }

        return implode("\r\n", $qrCodeElements);
    }

    public static function loadValidatorMetadata(ClassMetadata $metadata)
    {
        $metadata->addPropertyConstraints('header', [
            new Assert\NotNull(),
            new Assert\Valid()
        ]);

        $metadata->addPropertyConstraints('creditorInformation', [
            new Assert\NotNull(),
            new Assert\Valid()
        ]);

        $metadata->addPropertyConstraints('creditor', [
            new Assert\NotNull(),
            new Assert\Valid()
        ]);

        $metadata->addPropertyConstraints('ultimateCreditor', [
            new Assert\Valid()
        ]);

        $metadata->addPropertyConstraints('paymentAmountInformation', [
            new Assert\NotNull(),
            new Assert\Valid()
        ]);

        $metadata->addPropertyConstraints('ultimateDebtor', [
            new Assert\Valid()
        ]);

        $metadata->addPropertyConstraints('paymentReference', [
            new Assert\NotNull(),
            new Assert\Valid()
        ]);
    }
}


1			<?php
2
3			namespace Sprain\SwissQrBill;
4
5			use Endroid\QrCode\QrCode;
6			use Sprain\SwissQrBill\DataGroups\AlternativeScheme;
7			use Sprain\SwissQrBill\DataGroups\Creditor;
8			use Sprain\SwissQrBill\DataGroups\CreditorInformation;
9			use Sprain\SwissQrBill\DataGroups\Header;
10			use Sprain\SwissQrBill\DataGroups\Interfaces\QrCodeData;
11			use Sprain\SwissQrBill\DataGroups\PaymentAmountInformation;
12			use Sprain\SwissQrBill\DataGroups\PaymentReference;
13			use Sprain\SwissQrBill\DataGroups\UltimateCreditor;
14			use Sprain\SwissQrBill\DataGroups\UltimateDebtor;
15			use Sprain\SwissQrBill\Exception\InvalidQrBillDataException;
16			use Sprain\SwissQrBill\Validator\Interfaces\Validatable;
17			use Sprain\SwissQrBill\Validator\ValidatorTrait;
18			use Symfony\Component\Validator\Constraints as Assert;
19			use Symfony\Component\Validator\Mapping\ClassMetadata;
20
21			class QrBill implements Validatable
22			{
23			use ValidatorTrait;
24
25			const SWISS_CROSS_LOGO_FILE = __DIR__ . '/../assets/swiss-cross.png';
26
27			/** @var Header */
28			private $header;
29
30			/** @var CreditorInformation */
31			private $creditorInformation;
32
33			/** @var Creditor */
34			private $creditor;
35
36			/** @var UltimateCreditor */
37			private $ultimateCreditor;
38
39			/** @var PaymentAmountInformation */
40			private $paymentAmountInformation;
41
42			/** @var UltimateDebtor */
43			private $ultimateDebtor;
44
45			/** @var PaymentReference */
46			private $paymentReference;
47
48			/** @var AlternativeScheme[] */
49			private $alternativeSchemes = [];
50
51			public static function create() : self
52			{
53			$header = new Header();
54			$header->setCoding(Header::CODING_LATIN);
55			$header->setQrType(Header::QRTYPE_SPC);
56			$header->setVersion(Header::VERSION_0100);
57
58			$qrBill = new self();
59			$qrBill->setHeader($header);
60
61			return $qrBill;
62			}
63
64			public function getHeader(): Header
65			{
66			return $this->header;
67			}
68
69			public function setHeader(Header $header) : self
70			{
71			$this->header = $header;
72
73			return $this;
74			}
75
76			public function getCreditorInformation(): CreditorInformation
77			{
78			return $this->creditorInformation;
79			}
80
81			public function setCreditorInformation(CreditorInformation $creditorInformation) : self
82			{
83			$this->creditorInformation = $creditorInformation;
84
85			return $this;
86			}
87
88			public function getCreditor(): Creditor
89			{
90			return $this->creditor;
91			}
92
93			public function setCreditor(Creditor $creditor) : self
94			{
95			$this->creditor = $creditor;
96
97			return $this;
98			}
99
100			public function getUltimateCreditor(): ?UltimateCreditor
101			{
102			return $this->ultimateCreditor;
103			}
104
105			public function setUltimateCreditor(UltimateCreditor $ultimateCreditor) : self
106			{
107			$this->ultimateCreditor = $ultimateCreditor;
108
109			return $this;
110			}
111
112			public function getPaymentAmountInformation(): PaymentAmountInformation
113			{
114			return $this->paymentAmountInformation;
115			}
116
117			public function setPaymentAmountInformation(PaymentAmountInformation $paymentAmountInformation) : self
118			{
119			$this->paymentAmountInformation = $paymentAmountInformation;
120
121			return $this;
122			}
123
124			public function getUltimateDebtor(): ?UltimateDebtor
125			{
126			return $this->ultimateDebtor;
127			}
128
129			public function setUltimateDebtor(UltimateDebtor $ultimateDebtor) : self
130			{
131			$this->ultimateDebtor = $ultimateDebtor;
132
133			return $this;
134			}
135
136			public function getPaymentReference(): PaymentReference
137			{
138			return $this->paymentReference;
139			}
140
141			public function setPaymentReference(PaymentReference $paymentReference) : self
142			{
143			$this->paymentReference = $paymentReference;
144
145			return $this;
146			}
147
148			public function getAlternativeSchemes(): array
149			{
150			return $this->alternativeSchemes;
151			}
152
153			public function setAlternativeSchemes(array $alternativeSchemes) : self
154			{
155			$this->alternativeSchemes = $alternativeSchemes;
156
157			return $this;
158			}
159
160			public function getQrCode() : QrCode
161			{
162			if (!$this->isValid()) {
163			throw new InvalidQrBillDataException(
164			'The provided data is not valid to generate a qr code. Use getViolations() to find details.'
165			);
166			}
167
168			$qrCode = new QrCode();
169			$qrCode->setText($this->getQrCodeData());
170			$qrCode->setSize(543); // recommended 46x46 mm in px @ 300dpi
171			$qrCode->setMargin(19); // recommended 1,6 mm in px @ 300dpi
172			$qrCode->setLogoPath(self::SWISS_CROSS_LOGO_FILE);
173			$qrCode->setLogoWidth(83); // recommended 7x7 mm in px @ 300dpi
174
175			return $qrCode;
176			}
177
178			private function getQrCodeData() : string
179			{
180			$elements = [
181			$this->getHeader(),
182			$this->getCreditorInformation(),
183			$this->getCreditor(),
184			$this->getUltimateCreditor() ?: new UltimateCreditor(),
185			$this->getPaymentAmountInformation(),
186			$this->getUltimateDebtor() ?: new UltimateDebtor(),
187			$this->getPaymentReference(),
188			$this->getAlternativeSchemes()
189			];
190
191			return $this->extractQrCodeDataFromElements($elements);
192			}
193
194			private function extractQrCodeDataFromElements(array $elements) : string
195			{
196			$qrCodeElements = [];
197
198			foreach ($elements as $element) {
199			if ($element instanceof QrCodeData) {
200			$qrCodeElements = array_merge($qrCodeElements, $element->getQrCodeData());
201			}
202			}
203
204			return implode("\r\n", $qrCodeElements);
205			}
206
207			public static function loadValidatorMetadata(ClassMetadata $metadata)
208			{
209			$metadata->addPropertyConstraints('header', [
210			new Assert\NotNull(),
211			new Assert\Valid()
212			]);
213
214			$metadata->addPropertyConstraints('creditorInformation', [
215			new Assert\NotNull(),
216			new Assert\Valid()
217			]);
218
219			$metadata->addPropertyConstraints('creditor', [
220			new Assert\NotNull(),
221			new Assert\Valid()
222			]);
223
224			$metadata->addPropertyConstraints('ultimateCreditor', [
225			new Assert\Valid()
226			]);
227
228			$metadata->addPropertyConstraints('paymentAmountInformation', [
229			new Assert\NotNull(),
230			new Assert\Valid()
231			]);
232
233			$metadata->addPropertyConstraints('ultimateDebtor', [
234			new Assert\Valid()
235			]);
236
237			$metadata->addPropertyConstraints('paymentReference', [
238			new Assert\NotNull(),
239			new Assert\Valid()
240			]);
241			}
242			}
243

sprain / php-swiss-qr-bill

Push — master ( 9d642a...6a24bf )

QrBill::create() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like