Add doc blocks to specify array contents

sprain · Jun 23, 2024 · 8449b48 · 8449b48
1 parent 0e99f88
commit 8449b48
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/src/QrBill.php b/src/QrBill.php
@@ -163,6 +163,9 @@ public function addAlternativeScheme(AlternativeScheme $alternativeScheme): self
     }
 
     /**
+     * @param string|null $fileFormat
+     * @param array<string, string> $unsupportedCharacterReplacements
+     * @return QrCode
      * @throws InvalidQrBillDataException
      */
     public function getQrCode(?string $fileFormat = null, array $unsupportedCharacterReplacements = []): QrCode

diff --git a/src/QrCode/QrCode.php b/src/QrCode/QrCode.php
@@ -36,6 +36,13 @@ final class QrCode
     /** @var array<string, bool> $writerOptions */
     private array $writerOptions = [SvgWriter::WRITER_OPTION_FORCE_XLINK_HREF => true];
 
+    /**
+     * @param string $data
+     * @param string|null $fileFormat
+     * @param array<string, string> $unsupportedCharacterReplacements
+     * @return self
+     * @throws UnsupportedFileExtensionException
+     */
     public static function create(string $data, string $fileFormat = null, array $unsupportedCharacterReplacements = []): self
     {
         if (null === $fileFormat) {
@@ -45,6 +52,12 @@ public static function create(string $data, string $fileFormat = null, array $un
         return new self($data, $fileFormat, $unsupportedCharacterReplacements);
     }
 
+    /**
+     * @param string $data
+     * @param string $fileFormat
+     * @param array<string, string> $unsupportedCharacterReplacements
+     * @throws UnsupportedFileExtensionException
+     */
     private function __construct(string $data, string $fileFormat, array $unsupportedCharacterReplacements)
     {
         $data = $this->replaceUnsupportedCharacters($data, $unsupportedCharacterReplacements);
@@ -132,6 +145,11 @@ public function avoidCompactSvgs(): void
         }
     }
 
+    /**
+     * @param string $data
+     * @param array<string, string> $unsupportedCharacterReplacements
+     * @return string
+     */
     private function replaceUnsupportedCharacters(string $data, array $unsupportedCharacterReplacements): string
     {
         foreach ($unsupportedCharacterReplacements as $character => $replacement) {