[Components] Convert to native return types

wouterj · nicolas-grekas · commit b70eb704bc81 · 2023-07-05T15:06:06.000+02:00
diff --git a/Catalogue/AbstractOperation.php b/Catalogue/AbstractOperation.php
@@ -183,8 +183,6 @@ public function moveMessagesToIntlDomainsIfPossible(string $batch = self::ALL_BA
      * stores the results.
      *
      * @param string $domain The domain which the operation will be performed for
-     *
-     * @return void
      */
-    abstract protected function processDomain(string $domain);
+    abstract protected function processDomain(string $domain): void;
 }
diff --git a/Catalogue/MergeOperation.php b/Catalogue/MergeOperation.php
@@ -24,10 +24,7 @@
  */
 class MergeOperation extends AbstractOperation
 {
-    /**
-     * @return void
-     */
-    protected function processDomain(string $domain)
+    protected function processDomain(string $domain): void
     {
         $this->messages[$domain] = [
             'all' => [],
diff --git a/Catalogue/TargetOperation.php b/Catalogue/TargetOperation.php
@@ -25,10 +25,7 @@
  */
 class TargetOperation extends AbstractOperation
 {
-    /**
-     * @return void
-     */
-    protected function processDomain(string $domain)
+    protected function processDomain(string $domain): void
     {
         $this->messages[$domain] = [
             'all' => [],
diff --git a/CatalogueMetadataAwareInterface.php b/CatalogueMetadataAwareInterface.php
@@ -31,18 +31,14 @@ public function getCatalogueMetadata(string $key = '', string $domain = 'message
 
     /**
      * Adds catalogue metadata to a message domain.
-     *
-     * @return void
      */
-    public function setCatalogueMetadata(string $key, mixed $value, string $domain = 'messages');
+    public function setCatalogueMetadata(string $key, mixed $value, string $domain = 'messages'): void;
 
     /**
      * Deletes catalogue metadata for the given key and domain.
      *
      * Passing an empty domain will delete all catalogue metadata. Passing an empty key will
      * delete all metadata for the given domain.
-     *
-     * @return void
      */
-    public function deleteCatalogueMetadata(string $key = '', string $domain = 'messages');
+    public function deleteCatalogueMetadata(string $key = '', string $domain = 'messages'): void;
 }
diff --git a/Command/XliffLintCommand.php b/Command/XliffLintCommand.php
@@ -50,10 +50,7 @@ public function __construct(string $name = null, callable $directoryIteratorProv
         $this->requireStrictFileNames = $requireStrictFileNames;
     }
 
-    /**
-     * @return void
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')
diff --git a/DataCollectorTranslator.php b/DataCollectorTranslator.php
@@ -48,10 +48,7 @@ public function trans(?string $id, array $parameters = [], string $domain = null
         return $trans;
     }
 
-    /**
-     * @return void
-     */
-    public function setLocale(string $locale)
+    public function setLocale(string $locale): void
     {
         $this->translator->setLocale($locale);
     }
@@ -95,10 +92,7 @@ public function getFallbackLocales(): array
         return [];
     }
 
-    /**
-     * @return mixed
-     */
-    public function __call(string $method, array $args)
+    public function __call(string $method, array $args): mixed
     {
         return $this->translator->{$method}(...$args);
     }
diff --git a/DependencyInjection/TranslationDumperPass.php b/DependencyInjection/TranslationDumperPass.php
@@ -20,10 +20,7 @@
  */
 class TranslationDumperPass implements CompilerPassInterface
 {
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('translation.writer')) {
             return;
diff --git a/DependencyInjection/TranslationExtractorPass.php b/DependencyInjection/TranslationExtractorPass.php
@@ -21,10 +21,7 @@
  */
 class TranslationExtractorPass implements CompilerPassInterface
 {
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('translation.extractor')) {
             return;
diff --git a/DependencyInjection/TranslatorPass.php b/DependencyInjection/TranslatorPass.php
@@ -18,10 +18,7 @@
 
 class TranslatorPass implements CompilerPassInterface
 {
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('translator.default')) {
             return;
diff --git a/DependencyInjection/TranslatorPathsPass.php b/DependencyInjection/TranslatorPathsPass.php
@@ -42,10 +42,7 @@ class TranslatorPathsPass extends AbstractRecursivePass
      */
     private array $controllers = [];
 
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition('translator')) {
             return;
diff --git a/Dumper/CsvFileDumper.php b/Dumper/CsvFileDumper.php
@@ -40,10 +40,8 @@ public function formatCatalogue(MessageCatalogue $messages, string $domain, arra
 
     /**
      * Sets the delimiter and escape character for CSV.
-     *
-     * @return void
      */
-    public function setCsvControl(string $delimiter = ';', string $enclosure = '"')
+    public function setCsvControl(string $delimiter = ';', string $enclosure = '"'): void
     {
         $this->delimiter = $delimiter;
         $this->enclosure = $enclosure;
diff --git a/Dumper/DumperInterface.php b/Dumper/DumperInterface.php
@@ -25,8 +25,6 @@ interface DumperInterface
      * Dumps the message catalogue.
      *
      * @param array $options Options that are used by the dumper
-     *
-     * @return void
      */
-    public function dump(MessageCatalogue $messages, array $options = []);
+    public function dump(MessageCatalogue $messages, array $options = []): void;
 }
diff --git a/Dumper/FileDumper.php b/Dumper/FileDumper.php
@@ -36,18 +36,13 @@ abstract class FileDumper implements DumperInterface
      * Sets the template for the relative paths to files.
      *
      * @param string $relativePathTemplate A template for the relative paths to files
-     *
-     * @return void
      */
-    public function setRelativePathTemplate(string $relativePathTemplate)
+    public function setRelativePathTemplate(string $relativePathTemplate): void
     {
         $this->relativePathTemplate = $relativePathTemplate;
     }
 
-    /**
-     * @return void
-     */
-    public function dump(MessageCatalogue $messages, array $options = [])
+    public function dump(MessageCatalogue $messages, array $options = []): void
     {
         if (!\array_key_exists('path', $options)) {
             throw new InvalidArgumentException('The file dumper needs a path option.');
diff --git a/Extractor/AbstractFileExtractor.php b/Extractor/AbstractFileExtractor.php
@@ -55,13 +55,7 @@ protected function isFile(string $file): bool
         return true;
     }
 
-    /**
-     * @return bool
-     */
-    abstract protected function canBeExtracted(string $file);
+    abstract protected function canBeExtracted(string $file): bool;
 
-    /**
-     * @return iterable
-     */
-    abstract protected function extractFromDirectory(string|array $resource);
+    abstract protected function extractFromDirectory(string|array $resource): iterable;
 }
diff --git a/Extractor/ChainExtractor.php b/Extractor/ChainExtractor.php
@@ -29,28 +29,20 @@ class ChainExtractor implements ExtractorInterface
 
     /**
      * Adds a loader to the translation extractor.
-     *
-     * @return void
      */
-    public function addExtractor(string $format, ExtractorInterface $extractor)
+    public function addExtractor(string $format, ExtractorInterface $extractor): void
     {
         $this->extractors[$format] = $extractor;
     }
 
-    /**
-     * @return void
-     */
-    public function setPrefix(string $prefix)
+    public function setPrefix(string $prefix): void
     {
         foreach ($this->extractors as $extractor) {
             $extractor->setPrefix($prefix);
         }
     }
 
-    /**
-     * @return void
-     */
-    public function extract(string|iterable $directory, MessageCatalogue $catalogue)
+    public function extract(string|iterable $directory, MessageCatalogue $catalogue): void
     {
         foreach ($this->extractors as $extractor) {
             $extractor->extract($directory, $catalogue);
diff --git a/Extractor/ExtractorInterface.php b/Extractor/ExtractorInterface.php
@@ -25,15 +25,11 @@ interface ExtractorInterface
      * Extracts translation messages from files, a file or a directory to the catalogue.
      *
      * @param string|iterable<string> $resource Files, a file or a directory
-     *
-     * @return void
      */
-    public function extract(string|iterable $resource, MessageCatalogue $catalogue);
+    public function extract(string|iterable $resource, MessageCatalogue $catalogue): void;
 
     /**
      * Sets the prefix that should be used for new found messages.
-     *
-     * @return void
      */
-    public function setPrefix(string $prefix);
+    public function setPrefix(string $prefix): void;
 }
diff --git a/Loader/CsvFileLoader.php b/Loader/CsvFileLoader.php
@@ -52,10 +52,8 @@ protected function loadResource(string $resource): array
 
     /**
      * Sets the delimiter, enclosure, and escape character for CSV.
-     *
-     * @return void
      */
-    public function setCsvControl(string $delimiter = ';', string $enclosure = '"', string $escape = '\\')
+    public function setCsvControl(string $delimiter = ';', string $enclosure = '"', string $escape = '\\'): void
     {
         $this->delimiter = $delimiter;
         $this->enclosure = $enclosure;
diff --git a/LoggingTranslator.php b/LoggingTranslator.php
@@ -45,10 +45,7 @@ public function trans(?string $id, array $parameters = [], string $domain = null
         return $trans;
     }
 
-    /**
-     * @return void
-     */
-    public function setLocale(string $locale)
+    public function setLocale(string $locale): void
     {
         $prev = $this->translator->getLocale();
         $this->translator->setLocale($locale);
@@ -86,10 +83,7 @@ public function getFallbackLocales(): array
         return [];
     }
 
-    /**
-     * @return mixed
-     */
-    public function __call(string $method, array $args)
+    public function __call(string $method, array $args): mixed
     {
         return $this->translator->{$method}(...$args);
     }
diff --git a/MessageCatalogue.php b/MessageCatalogue.php
@@ -80,10 +80,7 @@ public function all(string $domain = null): array
         return $allMessages;
     }
 
-    /**
-     * @return void
-     */
-    public function set(string $id, string $translation, string $domain = 'messages')
+    public function set(string $id, string $translation, string $domain = 'messages'): void
     {
         $this->add([$id => $translation], $domain);
     }
@@ -123,20 +120,14 @@ public function get(string $id, string $domain = 'messages'): string
         return $id;
     }
 
-    /**
-     * @return void
-     */
-    public function replace(array $messages, string $domain = 'messages')
+    public function replace(array $messages, string $domain = 'messages'): void
     {
         unset($this->messages[$domain], $this->messages[$domain.self::INTL_DOMAIN_SUFFIX]);
 
         $this->add($messages, $domain);
     }
 
-    /**
-     * @return void
-     */
-    public function add(array $messages, string $domain = 'messages')
+    public function add(array $messages, string $domain = 'messages'): void
     {
         $altDomain = str_ends_with($domain, self::INTL_DOMAIN_SUFFIX) ? substr($domain, 0, -\strlen(self::INTL_DOMAIN_SUFFIX)) : $domain.self::INTL_DOMAIN_SUFFIX;
         foreach ($messages as $id => $message) {
@@ -149,10 +140,7 @@ public function add(array $messages, string $domain = 'messages')
         }
     }
 
-    /**
-     * @return void
-     */
-    public function addCatalogue(MessageCatalogueInterface $catalogue)
+    public function addCatalogue(MessageCatalogueInterface $catalogue): void
     {
         if ($catalogue->getLocale() !== $this->locale) {
             throw new LogicException(sprintf('Cannot add a catalogue for locale "%s" as the current locale for this catalogue is "%s".', $catalogue->getLocale(), $this->locale));
@@ -181,10 +169,7 @@ public function addCatalogue(MessageCatalogueInterface $catalogue)
         }
     }
 
-    /**
-     * @return void
-     */
-    public function addFallbackCatalogue(MessageCatalogueInterface $catalogue)
+    public function addFallbackCatalogue(MessageCatalogueInterface $catalogue): void
     {
         // detect circular references
         $c = $catalogue;
@@ -223,10 +208,7 @@ public function getResources(): array
         return array_values($this->resources);
     }
 
-    /**
-     * @return void
-     */
-    public function addResource(ResourceInterface $resource)
+    public function addResource(ResourceInterface $resource): void
     {
         $this->resources[$resource->__toString()] = $resource;
     }
@@ -250,18 +232,12 @@ public function getMetadata(string $key = '', string $domain = 'messages'): mixe
         return null;
     }
 
-    /**
-     * @return void
-     */
-    public function setMetadata(string $key, mixed $value, string $domain = 'messages')
+    public function setMetadata(string $key, mixed $value, string $domain = 'messages'): void
     {
         $this->metadata[$domain][$key] = $value;
     }
 
-    /**
-     * @return void
-     */
-    public function deleteMetadata(string $key = '', string $domain = 'messages')
+    public function deleteMetadata(string $key = '', string $domain = 'messages'): void
     {
         if ('' == $domain) {
             $this->metadata = [];
@@ -291,18 +267,12 @@ public function getCatalogueMetadata(string $key = '', string $domain = 'message
         return null;
     }
 
-    /**
-     * @return void
-     */
-    public function setCatalogueMetadata(string $key, mixed $value, string $domain = 'messages')
+    public function setCatalogueMetadata(string $key, mixed $value, string $domain = 'messages'): void
     {
         $this->catalogueMetadata[$domain][$key] = $value;
     }
 
-    /**
-     * @return void
-     */
-    public function deleteCatalogueMetadata(string $key = '', string $domain = 'messages')
+    public function deleteCatalogueMetadata(string $key = '', string $domain = 'messages'): void
     {
         if (!$domain) {
             $this->catalogueMetadata = [];
diff --git a/MessageCatalogueInterface.php b/MessageCatalogueInterface.php
diff --git a/MetadataAwareInterface.php b/MetadataAwareInterface.php
diff --git a/Reader/TranslationReader.php b/Reader/TranslationReader.php
diff --git a/Reader/TranslationReaderInterface.php b/Reader/TranslationReaderInterface.php
diff --git a/Translator.php b/Translator.php
diff --git a/Writer/TranslationWriter.php b/Writer/TranslationWriter.php
diff --git a/Writer/TranslationWriterInterface.php b/Writer/TranslationWriterInterface.php

Original file line number	Diff line number	Diff line change
`@@ -183,8 +183,6 @@ public function moveMessagesToIntlDomainsIfPossible(string $batch = self::ALL_BA`
`183`	`183`	`* stores the results.`
`184`	`184`	`*`
`185`	`185`	`* @param string $domain The domain which the operation will be performed for`
`186`		`- *`
`187`		`- * @return void`
`188`	`186`	`*/`
`189`		`- abstract protected function processDomain(string $domain);`
	`187`	`+ abstract protected function processDomain(string $domain): void;`
`190`	`188`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,10 +24,7 @@`
`24`	`24`	`*/`
`25`	`25`	`class MergeOperation extends AbstractOperation`
`26`	`26`	`{`
`27`		`- /**`
`28`		`- * @return void`
`29`		`- */`
`30`		`- protected function processDomain(string $domain)`
	`27`	`+ protected function processDomain(string $domain): void`
`31`	`28`	`{`
`32`	`29`	`$this->messages[$domain] = [`
`33`	`30`	`'all' => [],`
Original file line number	Diff line number	Diff line change
`@@ -25,10 +25,7 @@`
`25`	`25`	`*/`
`26`	`26`	`class TargetOperation extends AbstractOperation`
`27`	`27`	`{`
`28`		`- /**`
`29`		`- * @return void`
`30`		`- */`
`31`		`- protected function processDomain(string $domain)`
	`28`	`+ protected function processDomain(string $domain): void`
`32`	`29`	`{`
`33`	`30`	`$this->messages[$domain] = [`
`34`	`31`	`'all' => [],`
Original file line number	Diff line number	Diff line change
`@@ -50,10 +50,7 @@ public function __construct(string $name = null, callable $directoryIteratorProv`
`50`	`50`	`$this->requireStrictFileNames = $requireStrictFileNames;`
`51`	`51`	`}`
`52`	`52`
`53`		`- /**`
`54`		`- * @return void`
`55`		`- */`
`56`		`- protected function configure()`
	`53`	`+ protected function configure(): void`
`57`	`54`	`{`
`58`	`55`	`$this`
`59`	`56`	`->addArgument('filename', InputArgument::IS_ARRAY, 'A file, a directory or "-" for reading from STDIN')`
Original file line number	Diff line number	Diff line change
`@@ -48,10 +48,7 @@ public function trans(?string $id, array $parameters = [], string $domain = null`
`48`	`48`	`return $trans;`
`49`	`49`	`}`
`50`	`50`
`51`		`- /**`
`52`		`- * @return void`
`53`		`- */`
`54`		`- public function setLocale(string $locale)`
	`51`	`+ public function setLocale(string $locale): void`
`55`	`52`	`{`
`56`	`53`	`$this->translator->setLocale($locale);`
`57`	`54`	`}`
`@@ -95,10 +92,7 @@ public function getFallbackLocales(): array`
`95`	`92`	`return [];`
`96`	`93`	`}`
`97`	`94`
`98`		`- /**`
`99`		`- * @return mixed`
`100`		`- */`
`101`		`- public function __call(string $method, array $args)`
	`95`	`+ public function __call(string $method, array $args): mixed`
`102`	`96`	`{`
`103`	`97`	`return $this->translator->{$method}(...$args);`
`104`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,10 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`class TranslationDumperPass implements CompilerPassInterface`
`22`	`22`	`{`
`23`		`- /**`
`24`		`- * @return void`
`25`		`- */`
`26`		`- public function process(ContainerBuilder $container)`
	`23`	`+ public function process(ContainerBuilder $container): void`
`27`	`24`	`{`
`28`	`25`	`if (!$container->hasDefinition('translation.writer')) {`
`29`	`26`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,7 @@`
`21`	`21`	`*/`
`22`	`22`	`class TranslationExtractorPass implements CompilerPassInterface`
`23`	`23`	`{`
`24`		`- /**`
`25`		`- * @return void`
`26`		`- */`
`27`		`- public function process(ContainerBuilder $container)`
	`24`	`+ public function process(ContainerBuilder $container): void`
`28`	`25`	`{`
`29`	`26`	`if (!$container->hasDefinition('translation.extractor')) {`
`30`	`27`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -18,10 +18,7 @@`
`18`	`18`
`19`	`19`	`class TranslatorPass implements CompilerPassInterface`
`20`	`20`	`{`
`21`		`- /**`
`22`		`- * @return void`
`23`		`- */`
`24`		`- public function process(ContainerBuilder $container)`
	`21`	`+ public function process(ContainerBuilder $container): void`
`25`	`22`	`{`
`26`	`23`	`if (!$container->hasDefinition('translator.default')) {`
`27`	`24`	`return;`