added docblocks, minor changes here and there, removal of unused prop…

…erties/variables Included psr1 and psr2 fixes
schmittjoh · Apr 3, 2016 · 58dcd6c · 58dcd6c
1 parent ac09e3d
commit 58dcd6c
Show file tree

Hide file tree

Showing 107 changed files with 1,471 additions and 320 deletions.
diff --git a/Annotation/Desc.php b/Annotation/Desc.php
@@ -47,4 +47,4 @@ public function __construct()
 
         $this->text = $values['text'];
     }
-}
+}
diff --git a/Annotation/Ignore.php b/Annotation/Ignore.php
@@ -25,4 +25,4 @@
  */
 final class Ignore
 {
-}
+}
diff --git a/Annotation/Meaning.php b/Annotation/Meaning.php
@@ -30,11 +30,15 @@ final class Meaning
     /** @var string @Required */
     public $text;
 
+    /**
+     * Meaning constructor.
+     */
     public function __construct()
     {
         if (0 === func_num_args()) {
             return;
         }
+
         $values = func_get_arg(0);
 
         if (isset($values['value'])) {
@@ -47,4 +51,4 @@ public function __construct()
 
         $this->text = $values['text'];
     }
-}
+}
diff --git a/Command/ExtractTranslationCommand.php b/Command/ExtractTranslationCommand.php
@@ -35,6 +35,9 @@
  */
 class ExtractTranslationCommand extends ContainerAwareCommand
 {
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         $this
@@ -55,10 +58,15 @@ protected function configure()
             ->addOption('output-format', null, InputOption::VALUE_REQUIRED, 'The output format that should be used (in most cases, it is better to change only the default-output-format).')
             ->addOption('default-output-format', null, InputOption::VALUE_REQUIRED, 'The default output format (defaults to xlf).')
             ->addOption('keep', null, InputOption::VALUE_NONE, 'Define if the updater service should keep the old translation (defaults to false).')
-            ->addOption('external-translations-dir', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED , 'Load external translation ressources')
+            ->addOption('external-translations-dir', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED, 'Load external translation ressources')
         ;
     }
 
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return void
+     */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $builder = $input->getOption('config') ?
@@ -100,20 +108,20 @@ protected function execute(InputInterface $input, OutputInterface $output)
                 $changeSet = $updater->getChangeSet($config);
 
                 $output->writeln('Added Messages: '.count($changeSet->getAddedMessages()));
-                if($input->hasParameterOption('--verbose')){
-                    foreach($changeSet->getAddedMessages() as $message){
+                if ($input->hasParameterOption('--verbose')) {
+                    foreach ($changeSet->getAddedMessages() as $message) {
                         $output->writeln($message->getId(). '-> '.$message->getDesc());
-                    }   
+                    }
                 }
 
                 if ($config->isKeepOldMessages()) {
                     $output->writeln('Deleted Messages: # none as "Keep Old Translations" is true #');
                 } else {
                     $output->writeln('Deleted Messages: '.count($changeSet->getDeletedMessages()));
-                    if($input->hasParameterOption('--verbose')){
-                        foreach($changeSet->getDeletedMessages() as $message){
+                    if ($input->hasParameterOption('--verbose')) {
+                        foreach ($changeSet->getDeletedMessages() as $message) {
                             $output->writeln($message->getId(). '-> '.$message->getDesc());
-                        }   
+                        }
                     }
                 }
 
@@ -126,6 +134,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $output->writeln('done!');
     }
 
+    /**
+     * @param InputInterface $input
+     * @param ConfigBuilder $builder
+     */
     private function updateWithInput(InputInterface $input, ConfigBuilder $builder)
     {
         if ($bundle = $input->getOption('bundle')) {
@@ -188,12 +200,12 @@ private function updateWithInput(InputInterface $input, ConfigBuilder $builder)
 
         if ($input->hasParameterOption('--keep') || $input->hasParameterOption('--keep=true')) {
             $builder->setKeepOldTranslations(true);
-        } else if ($input->hasParameterOption('--keep=false')) {
+        } elseif ($input->hasParameterOption('--keep=false')) {
             $builder->setKeepOldTranslations(false);
         }
 
         if ($loadResource = $input->getOption('external-translations-dir')) {
             $builder->setLoadResources($loadResource);
         }
     }
-}
+}
diff --git a/Command/ResourcesListCommand.php b/Command/ResourcesListCommand.php
@@ -22,7 +22,6 @@
 use JMS\TranslationBundle\Exception\RuntimeException;
 use JMS\TranslationBundle\Translation\Config;
 use JMS\TranslationBundle\Logger\OutputLogger;
-
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -31,13 +30,15 @@
 use Symfony\Component\Finder\Finder;
 use JMS\TranslationBundle\Util\FileUtils;
 
-
 /**
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  */
 class ResourcesListCommand extends ContainerAwareCommand
 {
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         $this
@@ -50,7 +51,7 @@ protected function configure()
     /**
      * @param \Symfony\Component\Console\Input\InputInterface $input
      * @param \Symfony\Component\Console\Output\OutputInterface $output
-     * @return mixed
+     * @return void
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
@@ -93,7 +94,7 @@ private function retrieveFiles(array $dirs)
         $files = array();
         // Register translation resources
         foreach ($dirs as $dir) {
-            foreach(FileUtils::findTranslationFiles($dir) as $catalogue => $locales) {
+            foreach (FileUtils::findTranslationFiles($dir) as $catalogue => $locales) {
                 foreach ($locales as $file) {
                     $files[] = $file[1];
                 }
@@ -125,4 +126,4 @@ private function retrieveDirs()
 
         return $dirs;
     }
-}
+}
diff --git a/Controller/ApiController.php b/Controller/ApiController.php
@@ -19,6 +19,8 @@
 namespace JMS\TranslationBundle\Controller;
 
 use JMS\TranslationBundle\Exception\RuntimeException;
+use JMS\TranslationBundle\Translation\ConfigFactory;
+use JMS\TranslationBundle\Translation\Updater;
 use Symfony\Component\HttpFoundation\Response;
 use JMS\TranslationBundle\Util\FileUtils;
 use JMS\DiExtraBundle\Annotation as DI;
@@ -33,18 +35,30 @@
  */
 class ApiController
 {
-    /** @DI\Inject("jms_translation.config_factory") */
+    /**
+     * @DI\Inject("jms_translation.config_factory")
+     * @var ConfigFactory
+     */
     private $configFactory;
 
-    /** @DI\Inject("jms_translation.updater") */
+    /**
+     * @DI\Inject("jms_translation.updater")
+     * @var Updater
+     */
     private $updater;
 
     /**
      * @Route("/configs/{config}/domains/{domain}/locales/{locale}/messages",
-     * 			name="jms_translation_update_message",
-     * 			defaults = {"id" = null},
-     * 			options = {"i18n" = false})
+     *            name="jms_translation_update_message",
+     *            defaults = {"id" = null},
+     *            options = {"i18n" = false})
      * @Method("PUT")
+     * @param Request $request
+     * @param string $config
+     * @param string $domain
+     * @param string $locale
+     *
+     * @return Response
      */
     public function updateMessageAction(Request $request, $config, $domain, $locale)
     {

diff --git a/Controller/TranslateController.php b/Controller/TranslateController.php
@@ -19,6 +19,8 @@
 namespace JMS\TranslationBundle\Controller;
 
 use JMS\TranslationBundle\Exception\RuntimeException;
+use JMS\TranslationBundle\Translation\ConfigFactory;
+use JMS\TranslationBundle\Translation\LoaderManager;
 use JMS\TranslationBundle\Util\FileUtils;
 use JMS\DiExtraBundle\Annotation as DI;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
@@ -33,13 +35,22 @@
  */
 class TranslateController
 {
-    /** @DI\Inject("jms_translation.config_factory") */
+    /**
+     * @DI\Inject("jms_translation.config_factory")
+     * @var ConfigFactory
+     */
     private $configFactory;
 
-    /** @DI\Inject("jms_translation.loader_manager") */
+    /**
+     * @DI\Inject("jms_translation.loader_manager")
+     * @var LoaderManager
+     */
     private $loader;
 
-    /** @DI\Inject("%jms_translation.source_language%") */
+    /**
+     * @DI\Inject("%jms_translation.source_language%")
+     * @var string
+     */
     private $sourceLanguage;
 
     /**
@@ -128,4 +139,4 @@ public function indexAction(Request $request)
             'sourceLanguage' => $this->sourceLanguage,
         );
     }
-}
+}
diff --git a/DependencyInjection/Compiler/IntegrationPass.php b/DependencyInjection/Compiler/IntegrationPass.php
@@ -30,7 +30,7 @@ public function process(ContainerBuilder $container)
         }
 
         $def = $container->getDefinition('translation.loader.xliff');
-	if ('%translation.loader.xliff.class%' !== $def->getClass() && 'Symfony\Component\Translation\Loader\XliffFileLoader' !== $def->getClass()) {
+        if ('%translation.loader.xliff.class%' !== $def->getClass() && 'Symfony\Component\Translation\Loader\XliffFileLoader' !== $def->getClass()) {
             // user needs to manually integrate as desired
             return;
         }

diff --git a/DependencyInjection/Compiler/MountDumpersPass.php b/DependencyInjection/Compiler/MountDumpersPass.php
@@ -59,4 +59,4 @@ public function process(ContainerBuilder $container)
             ->addArgument($dumpers)
         ;
     }
-}
+}
diff --git a/DependencyInjection/Compiler/MountExtractorsPass.php b/DependencyInjection/Compiler/MountExtractorsPass.php
@@ -43,4 +43,4 @@ public function process(ContainerBuilder $container)
 
         $def->addArgument($extractors);
     }
-}
+}
diff --git a/DependencyInjection/Compiler/MountFileVisitorsPass.php b/DependencyInjection/Compiler/MountFileVisitorsPass.php
@@ -37,4 +37,4 @@ public function process(ContainerBuilder $container)
         }
         $def->addArgument($visitors);
     }
-}
+}
diff --git a/DependencyInjection/Compiler/MountLoadersPass.php b/DependencyInjection/Compiler/MountLoadersPass.php
@@ -59,4 +59,4 @@ public function process(ContainerBuilder $container)
             ->addArgument($loaders)
         ;
     }
-}
+}
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -62,7 +62,7 @@ public function getConfigTreeBuilder()
                                     ->requiresAtLeastOneElement()
                                     ->prototype('scalar')
                                         ->validate()
-                                            ->always(function($v) use ($c) {
+                                            ->always(function ($v) use ($c) {
                                                 $v = str_replace(DIRECTORY_SEPARATOR, '/', $v);
 
                                                 if ('@' === $v[0]) {
@@ -118,4 +118,4 @@ public function getConfigTreeBuilder()
 
         return $tb;
     }
-}
+}
diff --git a/DependencyInjection/JMSTranslationExtension.php b/DependencyInjection/JMSTranslationExtension.php
@@ -101,4 +101,4 @@ public function load(array $configs, ContainerBuilder $container)
             ->addArgument($requests)
         ;
     }
-}
+}
diff --git a/Exception/Exception.php b/Exception/Exception.php
@@ -25,4 +25,4 @@
  */
 interface Exception
 {
-}
+}
diff --git a/Exception/InvalidArgumentException.php b/Exception/InvalidArgumentException.php
@@ -25,4 +25,4 @@
  */
 class InvalidArgumentException extends \InvalidArgumentException implements Exception
 {
-}
+}
diff --git a/Exception/RuntimeException.php b/Exception/RuntimeException.php
@@ -25,4 +25,4 @@
  */
 class RuntimeException extends \RuntimeException implements Exception
 {
-}
+}
diff --git a/Logger/LoggerAwareInterface.php b/Logger/LoggerAwareInterface.php
@@ -28,5 +28,5 @@ interface LoggerAwareInterface
     /**
      * @param LoggerInterface $logger
      */
-    function setLogger(LoggerInterface $logger);
-}
+    public function setLogger(LoggerInterface $logger);
+}