Merge pull request #610 from deguif/review-private-final-type-hints

Add type-hints on private / final methods / properties

Author: goetas

Annotation/Desc.php

@@ -29,8 +29,8 @@
  */
 final class Desc
 {
-    /** @var string @Required */
-    public $text;
+    /** @Required */
+    public string $text;
 
     public function __construct()
     {

Annotation/Meaning.php

@@ -29,8 +29,8 @@
  */
 final class Meaning
 {
-    /** @var string @Required */
-    public $text;
+    /** @Required */
+    public string $text;
 
     public function __construct()
     {

Controller/ApiController.php

@@ -36,15 +36,9 @@
 #[Route('/api')]
 class ApiController
 {
-    /**
-     * @var ConfigFactory
-     */
-    private $configFactory;
+    private ConfigFactory $configFactory;
 
-    /**
-     * @var Updater
-     */
-    private $updater;
+    private Updater $updater;
 
     public function __construct(ConfigFactory $configFactory, Updater $updater)
     {

Controller/TranslateController.php

@@ -37,25 +37,13 @@
  */
 class TranslateController
 {
-    /**
-     * @var ConfigFactory
-     */
-    private $configFactory;
+    private ConfigFactory $configFactory;
 
-    /**
-     * @var LoaderManager
-     */
-    private $loader;
+    private LoaderManager $loader;
 
-    /**
-     * @var Environment|null
-     */
-    private $twig;
+    private Environment|null $twig;
 
-    /**
-     * @var string
-     */
-    private $sourceLanguage;
+    private string|null $sourceLanguage = null;
 
     public function __construct(ConfigFactory $configFactory, LoaderManager $loader, ?Environment $twig = null)
     {

DependencyInjection/Configuration.php

@@ -26,7 +26,7 @@
 
 class Configuration implements ConfigurationInterface
 {
-    private $container;
+    private ContainerBuilder $container;
 
     public function __construct(ContainerBuilder $container)
     {

Logger/OutputLogger.php

@@ -35,15 +35,9 @@ class OutputLogger implements LoggerInterface
     public const DEBUG  = 128;
     public const ALL    = 255;
 
-    /**
-     * @var OutputInterface
-     */
-    private $output;
+    private OutputInterface $output;
 
-    /**
-     * @var int
-     */
-    private $level = self::ALL;
+    private int $level = self::ALL;
 
     public function __construct(OutputInterface $output)
     {

Model/FileSource.php

@@ -22,20 +22,11 @@
 
 class FileSource implements SourceInterface
 {
-    /**
-     * @var string
-     */
-    private $path;
+    private string $path;
 
-    /**
-     * @var int
-     */
-    private $line;
+    private int|null $line;
 
-    /**
-     * @var int
-     */
-    private $column;
+    private int|null $column;
 
     /**
      * @param string $path

Model/Message.php

@@ -31,48 +31,34 @@ class Message
 {
     /**
      * Unique ID of this message (same across the same domain).
-     *
-     * @var string
      */
-    private $id;
+    private string $id;
 
-    /**
-     * @var bool
-     */
-    private $new = true;
+    private bool $new = true;
 
-    /**
-     * @var string
-     */
-    private $domain;
+    private string $domain;
 
     /**
      * This is the translated string.
-     *
-     * @var string
      */
-    private $localeString;
+    private string|null $localeString = null;
 
     /**
      * Additional information about the intended meaning.
-     *
-     * @var string
      */
-    private $meaning;
+    private string|null $meaning = null;
 
     /**
      * The description/sample for translators.
-     *
-     * @var string
      */
-    private $desc;
+    private string|null $desc = null;
 
     /**
      * The sources where this message occurs.
      *
-     * @var array
+     * @var SourceInterface[]
      */
-    private $sources = [];
+    private array $sources = [];
 
     /**
      * @deprecated Will be removed in 2.0. Use the FileSourceFactory

Model/MessageCatalogue.php

@@ -36,15 +36,10 @@
  */
 class MessageCatalogue
 {
-    /**
-     * @var string
-     */
-    private $locale;
+    private string|null $locale = null;
 
-    /**
-     * @var array
-     */
-    private $domains = [];
+    /** @var array<string, MessageCollection> */
+    private array $domains = [];
 
     public function setLocale($locale)
     {
@@ -87,8 +82,6 @@ public function get($id, $domain = 'messages')
     }
 
     /**
-     * @param Message $message
-     *
      * @return bool
      */
     public function has(Message $message)
@@ -139,17 +132,8 @@ public function getDomains()
         return $this->domains;
     }
 
-    /**
-     * @param string $domain
-     *
-     * @return MessageCollection
-     */
-    private function getOrCreateDomain($domain)
+    private function getOrCreateDomain(string $domain): MessageCollection
     {
-        if (!$this->hasDomain($domain)) {
-            $this->domains[$domain] = new MessageCollection($this);
-        }
-
-        return $this->domains[$domain];
+        return $this->domains[$domain] ??= new MessageCollection($this);
     }
 }

Model/MessageCollection.php

@@ -33,15 +33,10 @@
  */
 class MessageCollection
 {
-    /**
-     * @var MessageCatalogue
-     */
-    private $catalogue;
+    private MessageCatalogue|null $catalogue = null;
 
-    /**
-     * @var array
-     */
-    private $messages = [];
+    /** @var array<string, Message> */
+    private array $messages = [];
 
     public function setCatalogue(MessageCatalogue $catalogue)
     {
@@ -155,7 +150,7 @@ public function merge(MessageCollection $domain)
         }
     }
 
-    private function checkConsistency(Message $oldMessage, Message $newMessage)
+    private function checkConsistency(Message $oldMessage, Message $newMessage): void
     {
         $oldDesc = $oldMessage->getDesc();
         $newDesc = $newMessage->getDesc();