Add getMessages method to CategorySource (#94)

* Add getMessages method

* [ci-review] Apply changes from Rector action.

* Add changelog

* Add a test

* PR fixes

Co-authored-by: rector-bot <rector@yiiframework.com>
Co-authored-by: Sergei Predvoditelev <sergei@predvoditelev.ru>

CHANGELOG.md

@@ -6,7 +6,8 @@
 
 ## 2.1.1 November 23, 2022
 
-- Bug #93: Throw exceptions on empty and not passed parameters, cast `null` to empty string in `SimpleMessageFormatter` 
+- New #94: Add `getMessages()` method to `CategorySource` (@xepozz)
+- Bug #93: Throw exceptions on empty and not passed parameters, cast `null` to empty string in `SimpleMessageFormatter`
   (@arogachev)
 
 ## 2.1.0 November 15, 2022

src/CategorySource.php

@@ -51,6 +51,35 @@ public function getMessage(string $id, string $locale, array $parameters = []):
         return $this->reader->getMessage($id, $this->name, $locale, $parameters);
     }
 
+    /**
+     * @param string $locale Locale of messages to get.
+     *
+     * @psalm-return array<string, array<string, string>>
+     *
+     * @return array All messages from category. The format is the following:
+     *
+     * ```php
+     * [
+     *   'key1' => [
+     *     'message' => 'translation1',
+     *     // Extra metadata that writer may use:
+     *     'comment' => 'Translate carefully!',
+     *   ],
+     *   'key2' => [
+     *     'message' => 'translation2',
+     *     // Extra metadata that writer may use:
+     *     'comment' => 'Translate carefully!',
+     *   ],
+     * ]
+     * ```
+     *
+     * @see MessageReaderInterface::getMessages()
+     */
+    public function getMessages(string $locale): array
+    {
+        return $this->reader->getMessages($this->name, $locale);
+    }
+
     /**
      * Format the message given parameters and locale.
      *

tests/CategoryTest.php

@@ -68,6 +68,39 @@ public function testWithoutFormatter(
         );
     }
 
+    public function testGetMessages(): void
+    {
+        $categorySource = new CategorySource(
+            'test',
+            new class () implements MessageReaderInterface {
+                public function getMessage(
+                    string $id,
+                    string $category,
+                    string $locale,
+                    array $parameters = []
+                ): ?string {
+                    return null;
+                }
+
+                public function getMessages(string $category, string $locale): array
+                {
+                    return [
+                        'message1' => ['message' => 'message1'],
+                        'message2' => ['message' => 'message2'],
+                    ];
+                }
+            }
+        );
+
+        $this->assertEquals(
+            [
+                'message1' => ['message' => 'message1'],
+                'message2' => ['message' => 'message2'],
+            ],
+            $categorySource->getMessages('en'),
+        );
+    }
+
     private function createMessageReader(): MessageReaderInterface
     {
         return new class () implements MessageReaderInterface {