Payment: variable, constant and specific symbol accept string

Author: h4kuna

.gitignore

@@ -3,4 +3,4 @@ composer.lock
 *~
 /tests/**/output/
 tests/src/E2E/account.ini
-/coverage.html
+coverage.html

changelog.md

@@ -28,6 +28,7 @@ $fioPay->createEuro();
 $fioPay->createEuro();
 $fioPay->send();
 ```
+- variable, constant and specific symbols are type string, integer is deprecated 
 
 ### v 2.0
 - support only php 7.1+

src/Exceptions/InvalidArgument.php

@@ -15,13 +15,12 @@ public static function check(string $text, int $size): string
 	}
 
 
-	public static function checkRange(int $number, int $limit): int
+	public static function checkRange(int|string $number, int $limit): void
 	{
-		if ($number < 0 || $number > $limit) {
-			throw new self(sprintf('Value is out of range "%s" must contain 1-%s positive digits.', $number, strlen((string) $limit)));
+		$check = intval($number);
+		if ($check < 0 || $check > $limit) {
+			throw new self(sprintf('Value is out of range "%s" must contain 1-%s positive digits.', $check, $limit));
 		}
-
-		return $number;
 	}
 
 

src/Pay/Payment/Property.php

@@ -91,7 +91,8 @@ public function setDate(int|string|\DateTimeInterface $date): static
 
 	public function setPaymentReason(int $code): static
 	{
-		$this->paymentReason = InvalidArgument::checkRange($code, 999);
+		InvalidArgument::checkRange($code, 999);
+		$this->paymentReason = $code;
 
 		return $this;
 	}

src/Pay/Payment/Symbols.php

@@ -6,32 +6,44 @@
 
 trait Symbols
 {
-	protected int $ks = 0;
+	protected string $ks = '';
 
-	protected int $vs = 0;
+	protected string $vs = '';
 
-	protected int $ss = 0;
+	protected string $ss = '';
 
 
-	public function setConstantSymbol(int $ks): static
+	/**
+	 * @param string $ks - int is deprecated
+	 */
+	public function setConstantSymbol(int|string $ks): static
 	{
-		$this->ks = InvalidArgument::checkRange($ks, 9999);
+		InvalidArgument::checkRange($ks, 9999);
+		$this->ks = (string) $ks;
 
 		return $this;
 	}
 
 
-	public function setVariableSymbol(int $vs): static
+	/**
+	 * @param string $vs - int is deprecated
+	 */
+	public function setVariableSymbol(int|string $vs): static
 	{
-		$this->vs = InvalidArgument::checkRange($vs, 9999999999);
+		InvalidArgument::checkRange($vs, 9999999999);
+		$this->vs = (string) $vs;
 
 		return $this;
 	}
 
 
-	public function setSpecificSymbol(int $ss): static
+	/**
+	 * @param string $ss - int is deprecated
+	 */
+	public function setSpecificSymbol(int|string $ss): static
 	{
-		$this->ss = InvalidArgument::checkRange($ss, 9999999999);
+		InvalidArgument::checkRange($ss, 9999999999);
+		$this->ss = (string) $ss;
 
 		return $this;
 	}

tests/data/payment/euro-maximum.xml

@@ -1,2 +1,2 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Import xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.fio.cz/schema/importIB.xsd"><Orders><T2Transaction><accountFrom>123456789</accountFrom><currency>USD</currency><amount>500</amount><accountTo>AT611904300234573201</accountTo><ks>321</ks><vs>123456789</vs><ss>378</ss><bic>ABAGATWWXXX</bic><date>2014-01-23</date><comment>Lorem ipsum</comment><benefName>Milan</benefName><benefStreet>Street 44</benefStreet><benefCity>Prague</benefCity><benefCountry>JP</benefCountry><remittanceInfo1>info 1</remittanceInfo1><remittanceInfo2>info 2</remittanceInfo2><remittanceInfo3>info 3</remittanceInfo3><paymentReason>110</paymentReason><paymentType>431009</paymentType></T2Transaction></Orders></Import>
+<Import xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.fio.cz/schema/importIB.xsd"><Orders><T2Transaction><accountFrom>123456789</accountFrom><currency>USD</currency><amount>500</amount><accountTo>AT611904300234573201</accountTo><ks>0321</ks><vs>0123456789</vs><ss>0378</ss><bic>ABAGATWWXXX</bic><date>2014-01-23</date><comment>Lorem ipsum</comment><benefName>Milan</benefName><benefStreet>Street 44</benefStreet><benefCity>Prague</benefCity><benefCountry>JP</benefCountry><remittanceInfo1>info 1</remittanceInfo1><remittanceInfo2>info 2</remittanceInfo2><remittanceInfo3>info 3</remittanceInfo3><paymentReason>110</paymentReason><paymentType>431009</paymentType></T2Transaction></Orders></Import>

tests/data/payment/pay-maximum.xml

@@ -1,2 +1,2 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Import xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.fio.cz/schema/importIB.xsd"><Orders><DomesticTransaction><accountFrom>123456789</accountFrom><currency>EUR</currency><amount>1000</amount><accountTo>987654</accountTo><bankCode>0123</bankCode><ks>321</ks><vs>123456789</vs><ss>378</ss><date>2014-01-23</date><messageForRecipient>Hello Mr. Joe</messageForRecipient><comment>Lorem ipsum</comment><paymentReason>333</paymentReason><paymentType>431005</paymentType></DomesticTransaction></Orders></Import>
+<Import xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.fio.cz/schema/importIB.xsd"><Orders><DomesticTransaction><accountFrom>123456789</accountFrom><currency>EUR</currency><amount>1000</amount><accountTo>987654</accountTo><bankCode>0123</bankCode><ks>321</ks><vs>0123456789</vs><ss>378</ss><date>2014-01-23</date><messageForRecipient>Hello Mr. Joe</messageForRecipient><comment>Lorem ipsum</comment><paymentReason>333</paymentReason><paymentType>431005</paymentType></DomesticTransaction></Orders></Import>

tests/src/Unit/Exceptions/InvalidArgumentExceptionTest.php

@@ -2,6 +2,7 @@
 
 namespace h4kuna\Fio\Tests\Unit\Exceptions;
 
+use h4kuna;
 use h4kuna\Fio\Exceptions\InvalidArgument;
 use h4kuna\Fio\Tests\Fixtures\TestCase;
 use Tester\Assert;
@@ -21,7 +22,7 @@ public function testCheck(): void
 
 
 	/**
-	 * @throws \h4kuna\Fio\Exceptions\InvalidArgument
+	 * @throws h4kuna\Fio\Exceptions\InvalidArgument
 	 */
 	public function testCheckThrow(): void
 	{
@@ -31,16 +32,17 @@ public function testCheckThrow(): void
 
 	public function testCheckRange(): void
 	{
-		Assert::same(10, InvalidArgument::checkRange(10, 99));
+		InvalidArgument::checkRange(10, 99);
+		Assert::true(true);
 	}
 
 
 	/**
-	 * @throws \h4kuna\Fio\Exceptions\InvalidArgument
+	 * @throws h4kuna\Fio\Exceptions\InvalidArgument
 	 */
 	public function testCheckRangeThrow(): void
 	{
-		Assert::same(10, InvalidArgument::checkRange(10, 1));
+		InvalidArgument::checkRange(10, 1);
 	}
 
 
@@ -51,7 +53,7 @@ public function testCheckIsInList(): void
 
 
 	/**
-	 * @throws \h4kuna\Fio\Exceptions\InvalidArgument
+	 * @throws h4kuna\Fio\Exceptions\InvalidArgument
 	 */
 	public function testCheckIsInListThrow(): void
 	{
@@ -66,7 +68,7 @@ public function testCheckLength(): void
 
 
 	/**
-	 * @throws \h4kuna\Fio\Exceptions\InvalidArgument
+	 * @throws h4kuna\Fio\Exceptions\InvalidArgument
 	 */
 	public function testCheckLengthThrow(): void
 	{

tests/src/Unit/Pay/Payment/EuroTest.php

@@ -36,13 +36,13 @@ public function testMaximum(): void
 			->setRemittanceInfo3('info 3')
 			->setStreet('Street 44')
 			->setCountry('jp')
-			->setConstantSymbol(321)
+			->setConstantSymbol('0321')
 			->setCurrency('Usd')
 			->setMyComment('Lorem ipsum')
 			->setDate('2014-01-23')
 			->setPaymentReason(110)
-			->setSpecificSymbol(378)
-			->setVariableSymbol(123456789)
+			->setSpecificSymbol('0378')
+			->setVariableSymbol('0123456789')
 			->setPaymentType(Fio\Pay\Payment\Euro::PAYMENT_PRIORITY);
 		$xml = $this->xmlFile->setData($pay)->getXml();
 		Tester\Assert::equal(Fio\Tests\loadResult('payment/euro-maximum.xml'), $xml);

tests/src/Unit/Pay/Payment/NationalTest.php

@@ -44,14 +44,14 @@ public function testMinimum(): void
 	public function testMaximum(): void
 	{
 		$pay = $this->fioPay->createNational(1000, '987654/0123')
-			->setConstantSymbol(321)
+			->setConstantSymbol('321')
 			->setCurrency('eur')
 			->setMyComment('Lorem ipsum')
 			->setDate('2014-01-23')
 			->setPaymentReason(333)
 			->setMessage('Hello Mr. Joe')
-			->setSpecificSymbol(378)
-			->setVariableSymbol(123456789)
+			->setSpecificSymbol('378')
+			->setVariableSymbol('0123456789')
 			->setPaymentType(Fio\Pay\Payment\National::PAYMENT_PRIORITY);
 		$xml = $this->xmlFile->setData($pay)->getXml();
 

tests/src/bootstrap.php

@@ -4,7 +4,6 @@
 
 use Nette\Utils\FileSystem;
 use Nette\Utils\Json;
-use Nette\Utils\Strings;
 use Tracy;
 use Tester;
 
@@ -25,7 +24,7 @@
 function loadResult(string $name, $save = null)
 {
 	$raw = false;
-	if (Strings::startsWith($name, 'raw://')) {
+	if (str_starts_with($name, 'raw://')) {
 		$name = substr($name, 6);
 		$raw = true;
 	}