Replace more docblocks by type-hints

Author: nicolas-grekas

Command/XliffLintCommand.php

@@ -33,7 +33,7 @@ class XliffLintCommand extends Command
     private $directoryIteratorProvider;
     private $isReadableProvider;
 
-    public function __construct($name = null, $directoryIteratorProvider = null, $isReadableProvider = null)
+    public function __construct(string $name = null, callable $directoryIteratorProvider = null, callable $isReadableProvider = null)
     {
         parent::__construct($name);
 

DependencyInjection/TranslationDumperPass.php

@@ -23,7 +23,7 @@ class TranslationDumperPass implements CompilerPassInterface
     private $writerServiceId;
     private $dumperTag;
 
-    public function __construct($writerServiceId = 'translation.writer', $dumperTag = 'translation.dumper')
+    public function __construct(string $writerServiceId = 'translation.writer', string $dumperTag = 'translation.dumper')
     {
         $this->writerServiceId = $writerServiceId;
         $this->dumperTag = $dumperTag;

DependencyInjection/TranslationExtractorPass.php

@@ -24,7 +24,7 @@ class TranslationExtractorPass implements CompilerPassInterface
     private $extractorServiceId;
     private $extractorTag;
 
-    public function __construct($extractorServiceId = 'translation.extractor', $extractorTag = 'translation.extractor')
+    public function __construct(string $extractorServiceId = 'translation.extractor', string $extractorTag = 'translation.extractor')
     {
         $this->extractorServiceId = $extractorServiceId;
         $this->extractorTag = $extractorTag;

DependencyInjection/TranslatorPass.php

@@ -22,7 +22,7 @@ class TranslatorPass implements CompilerPassInterface
     private $readerServiceId;
     private $loaderTag;
 
-    public function __construct($translatorServiceId = 'translator.default', $readerServiceId = 'translation.reader', $loaderTag = 'translation.loader')
+    public function __construct(string $translatorServiceId = 'translator.default', string $readerServiceId = 'translation.reader', string $loaderTag = 'translation.loader')
     {
         $this->translatorServiceId = $translatorServiceId;
         $this->readerServiceId = $readerServiceId;

Dumper/FileDumper.php

@@ -100,13 +100,8 @@ abstract protected function getExtension();
 
     /**
      * Gets the relative file path using the template.
-     *
-     * @param string $domain The domain
-     * @param string $locale The locale
-     *
-     * @return string The relative file path
      */
-    private function getRelativePath($domain, $locale)
+    private function getRelativePath(string $domain, string $locale): string
     {
         return strtr($this->relativePathTemplate, array(
             '%domain%' => $domain,

Extractor/AbstractFileExtractor.php

@@ -43,12 +43,7 @@ protected function extractFiles($resource)
         return $files;
     }
 
-    /**
-     * @param string $file
-     *
-     * @return \SplFileInfo
-     */
-    private function toSplFileInfo($file)
+    private function toSplFileInfo(string $file): \SplFileInfo
     {
         return ($file instanceof \SplFileInfo) ? $file : new \SplFileInfo($file);
     }

Loader/MoFileLoader.php

@@ -134,11 +134,8 @@ protected function loadResource($resource)
      * Reads an unsigned long from stream respecting endianness.
      *
      * @param resource $stream
-     * @param bool     $isBigEndian
-     *
-     * @return int
      */
-    private function readLong($stream, $isBigEndian)
+    private function readLong($stream, bool $isBigEndian): int
     {
         $result = unpack($isBigEndian ? 'N1' : 'V1', fread($stream, 4));
         $result = current($result);

Loader/XliffFileLoader.php

@@ -75,7 +75,7 @@ private function extract($resource, MessageCatalogue $catalogue, $domain)
      * @param MessageCatalogue $catalogue Catalogue where we'll collect messages and metadata
      * @param string           $domain    The domain
      */
-    private function extractXliff1(\DOMDocument $dom, MessageCatalogue $catalogue, $domain)
+    private function extractXliff1(\DOMDocument $dom, MessageCatalogue $catalogue, string $domain)
     {
         $xml = simplexml_import_dom($dom);
         $encoding = strtoupper($dom->encoding);
@@ -115,12 +115,7 @@ private function extractXliff1(\DOMDocument $dom, MessageCatalogue $catalogue, $
         }
     }
 
-    /**
-     * @param \DOMDocument     $dom
-     * @param MessageCatalogue $catalogue
-     * @param string           $domain
-     */
-    private function extractXliff2(\DOMDocument $dom, MessageCatalogue $catalogue, $domain)
+    private function extractXliff2(\DOMDocument $dom, MessageCatalogue $catalogue, string $domain)
     {
         $xml = simplexml_import_dom($dom);
         $encoding = strtoupper($dom->encoding);
@@ -163,13 +158,8 @@ private function extractXliff2(\DOMDocument $dom, MessageCatalogue $catalogue, $
 
     /**
      * Convert a UTF8 string to the specified encoding.
-     *
-     * @param string $content  String to decode
-     * @param string $encoding Target encoding
-     *
-     * @return string
      */
-    private function utf8ToCharset($content, $encoding = null)
+    private function utf8ToCharset(string $content, string $encoding = null): string
     {
         if ('UTF-8' !== $encoding && !empty($encoding)) {
             return mb_convert_encoding($content, $encoding, 'UTF-8');
@@ -181,13 +171,9 @@ private function utf8ToCharset($content, $encoding = null)
     /**
      * Validates and parses the given file into a DOMDocument.
      *
-     * @param string       $file
-     * @param \DOMDocument $dom
-     * @param string       $schema source of the schema
-     *
      * @throws InvalidResourceException
      */
-    private function validateSchema($file, \DOMDocument $dom, $schema)
+    private function validateSchema(string $file, \DOMDocument $dom, string $schema)
     {
         $internalErrors = libxml_use_internal_errors(true);
 
@@ -224,13 +210,8 @@ private function getSchema($xliffVersion)
 
     /**
      * Internally changes the URI of a dependent xsd to be loaded locally.
-     *
-     * @param string $schemaSource Current content of schema file
-     * @param string $xmlUri       External URI of XML to convert to local
-     *
-     * @return string
      */
-    private function fixXmlLocation($schemaSource, $xmlUri)
+    private function fixXmlLocation(string $schemaSource, string $xmlUri): string
     {
         $newPath = str_replace('\\', '/', __DIR__).'/schema/dic/xliff-core/xml.xsd';
         $parts = explode('/', $newPath);
@@ -250,12 +231,8 @@ private function fixXmlLocation($schemaSource, $xmlUri)
 
     /**
      * Returns the XML errors of the internal XML parser.
-     *
-     * @param bool $internalErrors
-     *
-     * @return array An array of errors
      */
-    private function getXmlErrors($internalErrors)
+    private function getXmlErrors(bool $internalErrors): array
     {
         $errors = array();
         foreach (libxml_get_errors() as $error) {
@@ -279,13 +256,9 @@ private function getXmlErrors($internalErrors)
      * Gets xliff file version based on the root "version" attribute.
      * Defaults to 1.2 for backwards compatibility.
      *
-     * @param \DOMDocument $dom
-     *
      * @throws InvalidArgumentException
-     *
-     * @return string
      */
-    private function getVersionNumber(\DOMDocument $dom)
+    private function getVersionNumber(\DOMDocument $dom): string
     {
         /** @var \DOMNode $xliff */
         foreach ($dom->getElementsByTagName('xliff') as $xliff) {
@@ -308,13 +281,7 @@ private function getVersionNumber(\DOMDocument $dom)
         return '1.2';
     }
 
-    /**
-     * @param \SimpleXMLElement|null $noteElement
-     * @param string|null            $encoding
-     *
-     * @return array
-     */
-    private function parseNotesMetadata(\SimpleXMLElement $noteElement = null, $encoding = null)
+    private function parseNotesMetadata(\SimpleXMLElement $noteElement = null, string $encoding = null): array
     {
         $notes = array();
 

MessageCatalogue.php

@@ -30,7 +30,7 @@ class MessageCatalogue implements MessageCatalogueInterface, MetadataAwareInterf
      * @param string $locale   The locale
      * @param array  $messages An array of messages classified by domain
      */
-    public function __construct($locale, array $messages = array())
+    public function __construct(?string $locale, array $messages = array())
     {
         $this->locale = $locale;
         $this->messages = $messages;

Tests/Writer/TranslationWriterTest.php

@@ -27,7 +27,7 @@ public function testWrite()
 
         $writer = new TranslationWriter();
         $writer->addDumper('test', $dumper);
-        $writer->write(new MessageCatalogue(array()), 'test');
+        $writer->write(new MessageCatalogue('en'), 'test');
     }
 
     public function testDisableBackup()