Skip to content

Commit 99cf235

Browse files
committed
Methods documentation.
1 parent e9fbc7e commit 99cf235

44 files changed

Lines changed: 773 additions & 153 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

phpstan.neon

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,3 @@ parameters:
22
level: 7
33
paths:
44
- src
5-
ignoreErrors:
6-
- '#has no value type specified in iterable type#'
7-
- '#generic class .+ does not specify its types#'

src/Contexts/BTFContext.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
*/
1111
abstract class BTFContext extends ServiceContext
1212
{
13+
/** @var array<string, string> */
1314
private array $parameters = [];
1415

1516
public function setParameter(string $name, string $value): self
@@ -19,6 +20,7 @@ public function setParameter(string $name, string $value): self
1920
return $this;
2021
}
2122

23+
/** @return array<string, string> */
2224
public function getParameters(): array
2325
{
2426
return $this->parameters;

src/Contexts/FFLContext.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
abstract class FFLContext implements OrderContextInterface
1414
{
1515
private string $fileFormat;
16+
/** @var array<string, string> */
1617
private array $parameters = [];
1718
private ?string $countryCode = null;
1819

@@ -35,6 +36,7 @@ public function setParameter(string $name, string $value): self
3536
return $this;
3637
}
3738

39+
/** @return array<string, string> */
3840
public function getParameters(): array
3941
{
4042
return $this->parameters;

src/Contracts/Crypt/ASN1Interface.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public function loadOIDs(array $oids);
3030
*
3131
* @param string $encoded Bytes.
3232
*
33-
* @return array
33+
* @return array<int, array<string, mixed>|false>
3434
*/
3535
public function decodeBER(string $encoded);
3636

@@ -45,7 +45,7 @@ public function decodeBER(string $encoded);
4545
* @param array<string, mixed> $mapping
4646
* @param array<string, callable> $special
4747
*
48-
* @return array|string|false|null
48+
* @return list<array<int|string, mixed>|string|false|null>|array<int|string, mixed>|string|false|null
4949
*/
5050
public function asn1map(array $decoded, array $mapping, array $special = []);
5151

@@ -91,14 +91,14 @@ public function convert(string $in, int $from = ASN1::TYPE_UTF8_STRING, int $to
9191
/**
9292
* Get property ANYmap.
9393
*
94-
* @return array
94+
* @return array<int, bool|string>
9595
*/
9696
public function getANYmap();
9797

9898
/**
9999
* Get property stringTypeSize.
100100
*
101-
* @return array
101+
* @return array<int, int>
102102
*/
103103
public function getStringTypeSize();
104104
}

src/Contracts/Crypt/BigIntegerInterface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ public function modInverse(BigIntegerInterface $n);
147147
*
148148
* @param BigIntegerInterface $y
149149
*
150-
* @return array
150+
* @return array{0: BigIntegerInterface, 1: BigIntegerInterface}
151151
* @internal This function is based off of
152152
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=9 HAC 14.20}.
153153
*/

src/Contracts/Crypt/X509Interface.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ public function computeKeyIdentifier($key = null);
183183
/**
184184
* Format a public key as appropriate.
185185
*
186-
* @return array|null
186+
* @return array<string, mixed>|null
187187
*/
188188
public function formatSubjectPublicKey(): ?array;
189189

src/Contracts/EbicsClientInterface.php

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,10 +64,13 @@ public function createUserSignatures(?array $options = null): void;
6464
*
6565
* The certificate is used in the INI/HIA/H3K initialization processes.
6666
*
67-
* @return array Certificate data array containing:
68-
* - 'certificate': The X.509 certificate in PEM format
69-
* - 'private_key': The corresponding private key
70-
* - 'public_key': The corresponding public key
67+
* @return array{
68+
* publickey: mixed,
69+
* publickey_type: int,
70+
* privatekey: mixed,
71+
* privatekey_type: int,
72+
* certificate: string|null
73+
* } Certificate data array
7174
*/
7275
public function generateIssuerCertificate(): array;
7376

src/EbicsClient.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -785,7 +785,8 @@ private function createDownloadOrderResult(
785785
$orderResult->setDataFiles($this->documentFactory->createMultipleXml($files));
786786
break;
787787
case self::FILE_PARSER_FORMAT_ZIP_FILES:
788-
$orderResult->setDataFiles($this->zipService->extractFilesFromString($orderResult->getData()));
788+
$zipFiles = $this->zipService->extractFilesFromString($orderResult->getData());
789+
$orderResult->setDataFiles(array_filter($zipFiles, fn($v) => $v !== false));
789790
break;
790791
default:
791792
throw new LogicException('Incorrect format');

src/Factories/KeyringFactory.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ private function buildKeyringFromDataForTypeKeyring(
9797
/**
9898
* @param Keyring $keyring
9999
*
100-
* @return array
100+
* @return array<string, mixed>
101101
*/
102102
public function buildDataFromKeyring(Keyring $keyring): array
103103
{

src/Handlers/AuthSignatureHandler.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
namespace EbicsApi\Ebics\Handlers;
44

55
use DOMDocument;
6+
use DOMNameSpaceNode;
67
use DOMNode;
8+
use DOMNodeList;
79
use EbicsApi\Ebics\Exceptions\EbicsException;
810
use EbicsApi\Ebics\Handlers\Traits\C14NTrait;
911
use EbicsApi\Ebics\Handlers\Traits\H00XTrait;

0 commit comments

Comments
 (0)