488635888

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/RikudouSage/QrPaymentCZ/commit/<a class=hub.com/RikudouSage/QrPaymentCZ/commit/<a class="double-link" href="https://git"><a class=hub.com/RikudouSage/QrPaymentCZ/commit/<a class="double-link" href="https://git"><a class=hub.com/RikudouSage/QrPaymentCZ/commit/37713b25b57477aa2a4a4a59b0998f5319180a3f">37713b25b<a href="https://github.com/RikudouSage/QrPaymentCZ/commit/37713b25b57477aa2a4a4a59b0998f5319180a3f">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/RikudouSage/QrPaymentCZ/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/RikudouSage/QrPaymentCZ/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/RikudouSage/QrPaymentCZ/commit/37713b25b57477aa2a4a4a59b0998f5319180a3f&quot;&gt;37713b25b&lt;/a&gt;&lt;a href=&quot;https://github.com/RikudouSage/QrPaymentCZ/commit/37713b25b57477aa2a4a4a59b0998f5319180a3f&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/RikudouSage/QrPaymentCZ/commit/37713b25b57477aa2a4a4a59b0998f53&lt;/a&gt;19180a3f&quot;>&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/RikudouSage/QrPaymentCZ/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/RikudouSage/QrPaymentCZ/commit/<a class="double-link" href="https://github.com/RikudouSage/QrPaymentCZ/commit/824e6a6d486ab5c1d82396d3f2f3ef61f71b768a">824e6a6d4</a><a href="https://github.com/RikudouSage/QrPaymentCZ/commit/37713b25b57477aa2a4a4a59b0998f5319180a3f">&amp;quot;&amp;gt;824e6a6d4&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;824e6a6d4&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/RikudouSage/QrPaymentCZ/commit/37713b25b57477aa2a4a4a59b0998f5319180&lt;/a&gt;a3f&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/RikudouSage/QrPaymentCZ/commit/<a class="double-link" href="https://github.com/RikudouSage/QrPaymentCZ/commit/9b76205b8">9b76205b8">9b76205b8</a>

Pull Request Pull Request #24: Release 5.0

Run Details

53 of 53 new or added lines in 1 file covered. (100.0%)

72 of 79 relevant lines covered (91.14%)

5.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.14

/src/QrPayment.php

<?php

namespace Rikudou\CzQrPayment;

use DateTimeImmutable;
use DateTimeInterface;
use Endroid\QrCode\QrCode;
use InvalidArgumentException;
use Rikudou\CzQrPayment\Exception\InvalidValueException;
use Rikudou\CzQrPayment\Exception\MissingLibraryException;
use Rikudou\CzQrPayment\Exception\QrPaymentException;
use Rikudou\Iban\Iban\CzechIbanAdapter;
use Rikudou\Iban\Iban\IbanInterface;
use Rikudou\QrPayment\QrPaymentInterface;

final class QrPayment implements QrPaymentInterface
{
    /**
     * @var int|null
     */
    private $variableSymbol = null;

    /**
     * @var int|null
     */
    private $specificSymbol = null;

    /**
     * @var int|null
     */
    private $constantSymbol = null;

    /**
     * @var string
     */
    private $currency = 'CZK';

    /**
     * @var string|null
     */
    private $comment = null;

    /**
     * @var int
     */
    private $repeat = 7;

    /**
     * @var string|null
     */
    private $internalId = null;

    /**
     * @var DateTimeInterface|null
     */
    private $dueDate = null;

    /**
     * @var float
     */
    private $amount = 0.0;

    /**
     * @var IbanInterface
     */
    private $iban;

    /**
     * @var string|null
     */
    private $payeeName = null;

    /**
     * @param IbanInterface            $iban
     * @param array<string,mixed>|null $options
     */
    public function __construct(IbanInterface $iban, ?array $options = null)
    {
        $this->iban = $iban;
        if ($options !== null) {
            $this->setOptions($options);
        }
    }

    /**
     * @param array<string,mixed> $options
     *
     * @throws QrPaymentException
     *
     * @return $this
     */
    public function setOptions(array $options): self
    {
        foreach ($options as $key => $value) {
            $method = sprintf('set%s', ucfirst($key));
            if (method_exists($this, $method)) {
                /** @var callable $callable */
                $callable = [$this, $method];
                call_user_func($callable, $value);
            } else {
                throw new InvalidArgumentException("The property '{$key}' is not valid");
            }
        }

        $this->checkProperties();

        return $this;
    }

    /**
     * @throws QrPaymentException
     */
    public function getQrString(): string
    {
        $this->checkProperties();

        if ($this->iban->getValidator() !== null && !$this->iban->getValidator()->isValid()) {
            throw new InvalidValueException('The IBAN is not a valid IBAN');
        }

        $qr = 'SPD*1.0*';
        $qr .= sprintf('ACC:%s*', $this->iban);
        $qr .= sprintf('AM:%.2f*', $this->amount);
        $qr .= sprintf('CC:%s*', strtoupper($this->currency));
        $qr .= sprintf('X-PER:%d*', $this->repeat);

        if ($this->comment !== null) {
            $qr .= sprintf('MSG:%.60s*', $this->comment);
        }
        if ($this->internalId !== null) {
            $qr .= sprintf('X-ID:%s*', $this->internalId);
        }
        if ($this->variableSymbol !== null) {
            $qr .= sprintf('X-VS:%d*', $this->variableSymbol);
        }
        if ($this->specificSymbol !== null) {
            $qr .= sprintf('X-SS:%d*', $this->specificSymbol);
        }
        if ($this->constantSymbol !== null) {
            $qr .= sprintf('X-KS:%d*', $this->constantSymbol);
        }
        if ($this->payeeName !== null) {
            $qr .= sprintf('RN:%s*', $this->payeeName);
        }
        if ($this->dueDate !== null) {
            $qr .= sprintf('DT:%s*', $this->dueDate->format('Ymd'));
        }

        return substr($qr, 0, -1);
    }

    public function getQrImage(): QrCode
    {
        if (!class_exists("Endroid\QrCode\QrCode")) {
            throw new MissingLibraryException('Error: library endroid/qr-code is not loaded.');
        }

        return new QrCode($this->getQrString());
    }

    public static function fromAccountAndBankCode(string $accountNumber, string $bankCode): self
    {
        return new self(new CzechIbanAdapter($accountNumber, $bankCode));
    }

    public function getVariableSymbol(): ?int
    {
        return $this->variableSymbol;
    }

    public function setVariableSymbol(?int $variableSymbol): self
    {
        $this->variableSymbol = $variableSymbol;

        return $this;
    }

    public function getSpecificSymbol(): ?int
    {
        return $this->specificSymbol;
    }

    public function setSpecificSymbol(?int $specificSymbol): self
    {
        $this->specificSymbol = $specificSymbol;

        return $this;
    }

    public function getConstantSymbol(): ?int
    {
        return $this->constantSymbol;
    }

    public function setConstantSymbol(?int $constantSymbol): self
    {
        $this->constantSymbol = $constantSymbol;

        return $this;
    }

    public function getCurrency(): string
    {
        return $this->currency;
    }

    public function setCurrency(string $currency): self
    {
        $this->currency = $currency;

        return $this;
    }

    public function getComment(): ?string
    {
        return $this->comment;
    }

    public function setComment(?string $comment): self
    {
        $this->comment = $comment;

        return $this;
    }

    public function getRepeat(): int
    {
        return $this->repeat;
    }

    public function setRepeat(int $repeat): self
    {
        $this->repeat = $repeat;

        return $this;
    }

    public function getInternalId(): ?string
    {
        return $this->internalId;
    }

    public function setInternalId(?string $internalId): self
    {
        $this->internalId = $internalId;

        return $this;
    }

    public function getDueDate(): DateTimeInterface
    {
        if ($this->dueDate === null) {
            return new DateTimeImmutable();
        }

        return $this->dueDate;
    }

    public function setDueDate(?DateTimeInterface $dueDate): self
    {
        $this->dueDate = $dueDate;

        return $this;
    }

    public function getAmount(): float
    {
        return $this->amount;
    }

    public function setAmount(float $amount): self
    {
        $this->amount = $amount;

        return $this;
    }

    public function getIban(): IbanInterface
    {
        return $this->iban;
    }

    public function setIban(IbanInterface $iban): self
    {
        $this->iban = $iban;

        return $this;
    }

    public function getPayeeName(): ?string
    {
        return $this->payeeName;
    }

    public function setPayeeName(?string $payeeName): self
    {
        $this->payeeName = $payeeName;

        return $this;
    }

    /**
     * Checks all properties for asterisk and throws exception if asterisk
     * is found
     *
     * @throws QrPaymentException
     */
    private function checkProperties(): void
    {
        foreach (get_object_vars($this) as $property => $value) {
            if (
                (is_string($value) || (is_object($value) && method_exists($value, '__toString')))
                && strpos((string) $value, '*') !== false
            ) {
                throw new InvalidValueException("Error: properties cannot contain asterisk (*). Property {$property} contains it.");
            }
        }
    }
}

1	<?php
2
3	namespace Rikudou\CzQrPayment;
4
5	use DateTimeImmutable;
6	use DateTimeInterface;
7	use Endroid\QrCode\QrCode;
8	use InvalidArgumentException;
9	use Rikudou\CzQrPayment\Exception\InvalidValueException;
10	use Rikudou\CzQrPayment\Exception\MissingLibraryException;
11	use Rikudou\CzQrPayment\Exception\QrPaymentException;
12	use Rikudou\Iban\Iban\CzechIbanAdapter;
13	use Rikudou\Iban\Iban\IbanInterface;
14	use Rikudou\QrPayment\QrPaymentInterface;
15
16	final class QrPayment implements QrPaymentInterface
17	{
18	/**
19	* @var int\|null
20	*/
21	private $variableSymbol = null;
22
23	/**
24	* @var int\|null
25	*/
26	private $specificSymbol = null;
27
28	/**
29	* @var int\|null
30	*/
31	private $constantSymbol = null;
32
33	/**
34	* @var string
35	*/
36	private $currency = 'CZK';
37
38	/**
39	* @var string\|null
40	*/
41	private $comment = null;
42
43	/**
44	* @var int
45	*/
46	private $repeat = 7;
47
48	/**
49	* @var string\|null
50	*/
51	private $internalId = null;
52
53	/**
54	* @var DateTimeInterface\|null
55	*/
56	private $dueDate = null;
57
58	/**
59	* @var float
60	*/
61	private $amount = 0.0;
62
63	/**
64	* @var IbanInterface
65	*/
66	private $iban;
67
68	/**
69	* @var string\|null
70	*/
71	private $payeeName = null;
72
73	/**
74	* @param IbanInterface $iban
75	* @param array<string,mixed>\|null $options
76	*/
77	public function __construct(IbanInterface $iban, ?array $options = null)
78	{
79	$this->iban = $iban;	17✔
80	if ($options !== null) {	17✔
81	$this->setOptions($options);	1✔
82	}
83	}	17✔
84
85	/**
86	* @param array<string,mixed> $options
87	*
88	* @throws QrPaymentException
89	*
90	* @return $this
91	*/
92	public function setOptions(array $options): self
93	{
94	foreach ($options as $key => $value) {	3✔
95	$method = sprintf('set%s', ucfirst($key));	3✔
96	if (method_exists($this, $method)) {	3✔
97	/** @var callable $callable */
98	$callable = [$this, $method];	2✔
99	call_user_func($callable, $value);	2✔
100	} else {
101	throw new InvalidArgumentException("The property '{$key}' is not valid");	1✔
102	}
103	}
104
105	$this->checkProperties();	2✔
106
107	return $this;	2✔
108	}
109
110	/**
111	* @throws QrPaymentException
112	*/
113	public function getQrString(): string
114	{
115	$this->checkProperties();	15✔
116
117	if ($this->iban->getValidator() !== null && !$this->iban->getValidator()->isValid()) {	15✔
118	throw new InvalidValueException('The IBAN is not a valid IBAN');	1✔
119	}
120
121	$qr = 'SPD1.0';	15✔
122	$qr .= sprintf('ACC:%s*', $this->iban);	15✔
123	$qr .= sprintf('AM:%.2f*', $this->amount);	15✔
124	$qr .= sprintf('CC:%s*', strtoupper($this->currency));	15✔
125	$qr .= sprintf('X-PER:%d*', $this->repeat);	15✔
126
127	if ($this->comment !== null) {	15✔
128	$qr .= sprintf('MSG:%.60s*', $this->comment);	3✔
129	}
130	if ($this->internalId !== null) {	15✔
131	$qr .= sprintf('X-ID:%s*', $this->internalId);	3✔
132	}
133	if ($this->variableSymbol !== null) {	15✔
134	$qr .= sprintf('X-VS:%d*', $this->variableSymbol);	3✔
135	}
136	if ($this->specificSymbol !== null) {	15✔
137	$qr .= sprintf('X-SS:%d*', $this->specificSymbol);	3✔
138	}
139	if ($this->constantSymbol !== null) {	15✔
140	$qr .= sprintf('X-KS:%d*', $this->constantSymbol);	3✔
141	}
142	if ($this->payeeName !== null) {	15✔
143	$qr .= sprintf('RN:%s*', $this->payeeName);	3✔
144	}
145	if ($this->dueDate !== null) {	15✔
146	$qr .= sprintf('DT:%s*', $this->dueDate->format('Ymd'));	3✔
147	}
148
149	return substr($qr, 0, -1);	15✔
150	}
151
152	public function getQrImage(): QrCode
153	{
154	if (!class_exists("Endroid\QrCode\QrCode")) {	2✔
155	throw new MissingLibraryException('Error: library endroid/qr-code is not loaded.');	1✔
156	}
157
158	return new QrCode($this->getQrString());	1✔
159	}
160
161	public static function fromAccountAndBankCode(string $accountNumber, string $bankCode): self
162	{
163	return new self(new CzechIbanAdapter($accountNumber, $bankCode));	1✔
164	}
165
166	public function getVariableSymbol(): ?int
167	{
168	return $this->variableSymbol;	×
169	}
170
171	public function setVariableSymbol(?int $variableSymbol): self
172	{
173	$this->variableSymbol = $variableSymbol;	3✔
174
175	return $this;	3✔
176	}
177
178	public function getSpecificSymbol(): ?int
179	{
180	return $this->specificSymbol;	×
181	}
182
183	public function setSpecificSymbol(?int $specificSymbol): self
184	{
185	$this->specificSymbol = $specificSymbol;	3✔
186
187	return $this;	3✔
188	}
189
190	public function getConstantSymbol(): ?int
191	{
192	return $this->constantSymbol;	×
193	}
194
195	public function setConstantSymbol(?int $constantSymbol): self
196	{
197	$this->constantSymbol = $constantSymbol;	3✔
198
199	return $this;	3✔
200	}
201
202	public function getCurrency(): string
203	{
204	return $this->currency;	1✔
205	}
206
207	public function setCurrency(string $currency): self
208	{
209	$this->currency = $currency;	3✔
210
211	return $this;	3✔
212	}
213
214	public function getComment(): ?string
215	{
216	return $this->comment;	×
217	}
218
219	public function setComment(?string $comment): self
220	{
221	$this->comment = $comment;	3✔
222
223	return $this;	3✔
224	}
225
226	public function getRepeat(): int
227	{
228	return $this->repeat;	1✔
229	}
230
231	public function setRepeat(int $repeat): self
232	{
233	$this->repeat = $repeat;	3✔
234
235	return $this;	3✔
236	}
237
238	public function getInternalId(): ?string
239	{
240	return $this->internalId;	×
241	}
242
243	public function setInternalId(?string $internalId): self
244	{
245	$this->internalId = $internalId;	3✔
246
247	return $this;	3✔
248	}
249
250	public function getDueDate(): DateTimeInterface
251	{
252	if ($this->dueDate === null) {	1✔
253	return new DateTimeImmutable();	1✔
254	}
255
256	return $this->dueDate;	×
257	}
258
259	public function setDueDate(?DateTimeInterface $dueDate): self
260	{
261	$this->dueDate = $dueDate;	3✔
262
263	return $this;	3✔
264	}
265
266	public function getAmount(): float
267	{
268	return $this->amount;	1✔
269	}
270
271	public function setAmount(float $amount): self
272	{
273	$this->amount = $amount;	3✔
274
275	return $this;	3✔
276	}
277
278	public function getIban(): IbanInterface
279	{
280	return $this->iban;	1✔
281	}
282
283	public function setIban(IbanInterface $iban): self
284	{
285	$this->iban = $iban;	1✔
286
287	return $this;	1✔
288	}
289
290	public function getPayeeName(): ?string
291	{
292	return $this->payeeName;	×
293	}
294
295	public function setPayeeName(?string $payeeName): self
296	{
297	$this->payeeName = $payeeName;	3✔
298
299	return $this;	3✔
300	}
301
302	/**
303	* Checks all properties for asterisk and throws exception if asterisk
304	* is found
305	*
306	* @throws QrPaymentException
307	*/
308	private function checkProperties(): void
309	{
310	foreach (get_object_vars($this) as $property => $value) {	15✔
311	if (
312	(is_string($value) \|\| (is_object($value) && method_exists($value, '__toString')))	15✔
313	&& strpos((string) $value, '*') !== false	15✔
314	) {
315	throw new InvalidValueException("Error: properties cannot contain asterisk (*). Property {$property} contains it.");	7✔
316	}
317	}
318	}	15✔
319	}

RikudouSage / QrPaymentCZ / 488635888

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous