Type generators and loaders

Author: devnix

src/Generator/MoGenerator.php

@@ -8,6 +8,9 @@
 
 final class MoGenerator extends Generator
 {
+    /**
+     * @var bool
+     */
     private $includeHeaders = false;
 
     public function includeHeaders(bool $includeHeaders = true): self

src/Generator/PoGenerator.php

@@ -102,6 +102,8 @@ public function generateString(Translations $translations): string
 
     /**
      * Add one or more lines depending whether the string is multiline or not.
+     *
+     * @param array<int, string> $lines
      */
     private static function appendLines(array &$lines, string $prefix, string $name, string $value): void
     {

src/Loader/MoLoader.php

@@ -11,8 +11,19 @@
  */
 final class MoLoader extends Loader
 {
+    /**
+     * @var string
+     */
     private $string;
+
+    /**
+     * @var int<0, max>
+     */
     private $position;
+
+    /**
+     * @var int<0, max>
+     */
     private $length;
 
     private const MAGIC1 = -1794895138;
@@ -132,6 +143,12 @@ private function readInt(string $byteOrder): int
         return (int) array_shift($read);
     }
 
+    /**
+     * @param string $byteOrder
+     * @param int    $count
+     *
+     * @return array<int, int>
+     */
     private function readIntArray(string $byteOrder, int $count): array
     {
         return unpack($byteOrder.$count, $this->read(4 * $count)) ?: [];

src/Loader/PoLoader.php

@@ -153,6 +153,11 @@ public function loadString(string $string, ?Translations $translations = null):
         return $translations;
     }
 
+    /**
+     * @param string|null $string
+     *
+     * @return array<string, string>
+     */
     private static function parseHeaders(?string $string): array
     {
         if (empty($string)) {

src/Loader/StrictPoLoader.php

@@ -167,7 +167,7 @@ private function readCommentString(): string
     private function readQuotedString(?string $context = null): string
     {
         $this->readWhitespace();
-        for ($data = '', $isNewPart = true, $checkpoint = null;;) {
+        for ($data = '', $isNewPart = true, $checkpoint = null; ;) {
             if ($isNewPart && !$this->readChar('"')) {
                 // The data is over (e.g. beginning of an identifier) or perhaps there's an error
                 // Restore the checkpoint and let the next parser handle it
@@ -437,6 +437,8 @@ private function processHeader(): void
 
     /**
      * Parses the translation header data into an array
+     *
+     * @return array<string, string>
      */
     private function readHeaders(string $data): array
     {