[console] Add missing docblocks and apply PSR-2 code style. (#125)

hechoendrupal · Dec 30, 2016 · 221ad3b · 221ad3b
1 parent 604ecca
commit 221ad3b
Show file tree

Hide file tree

Showing 38 changed files with 297 additions and 46 deletions.
diff --git a/src/Application.php b/src/Application.php
@@ -2,6 +2,7 @@
 
 namespace Drupal\Console\Core;
 
+use Drupal\Console\Core\Utils\TranslatorManager;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -53,6 +54,9 @@ public function __construct(
         $this->addOptions();
     }
 
+    /**
+     * @return TranslatorManager
+     */
     public function getTranslator()
     {
         if ($this->container) {
@@ -76,6 +80,9 @@ public function trans($key)
         return null;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function doRun(InputInterface $input, OutputInterface $output)
     {
         $io = new DrupalStyle($input, $output);
@@ -119,6 +126,9 @@ public function doRun(InputInterface $input, OutputInterface $output)
         return $code;
     }
 
+    /**
+     * registerEvents
+     */
     private function registerEvents()
     {
         $dispatcher = new EventDispatcher();
@@ -169,6 +179,9 @@ private function registerEvents()
         $this->setDispatcher($dispatcher);
     }
 
+    /**
+     * addOptions
+     */
     private function addOptions()
     {
         $this->getDefinition()->addOption(
@@ -253,6 +266,9 @@ private function addOptions()
         );
     }
 
+    /**
+     * registerCommandsFromAutoWireConfiguration
+     */
     private function registerCommandsFromAutoWireConfiguration()
     {
         $configuration = $this->container->get('console.configuration_manager')
@@ -339,6 +355,9 @@ private function registerCommandsFromAutoWireConfiguration()
         }
     }
 
+    /**
+     * registerChainCommands
+     */
     public function registerChainCommands()
     {
         /**

diff --git a/src/Bootstrap/DrupalConsoleCore.php b/src/Bootstrap/DrupalConsoleCore.php
@@ -1,11 +1,20 @@
 <?php
 
+/**
+ * @file
+ * Contains \Drupal\Console\Core\Bootstrap.
+ */
+
 namespace Drupal\Console\Core\Bootstrap;
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
+/**
+ * Class DrupalConsoleCore
+ * @package Drupal\Console\Core\Bootstrap
+ */
 class DrupalConsoleCore
 {
     /**
@@ -17,6 +26,7 @@ class DrupalConsoleCore
      * @var string
      */
     protected $appRoot;
+
     /**
      * DrupalConsole constructor.
      * @param $root
@@ -28,6 +38,9 @@ public function __construct($root, $appRoot = null)
         $this->appRoot = $appRoot;
     }
 
+    /**
+     * @return ContainerBuilder
+     */
     public function boot()
     {
         $container = new ContainerBuilder();

diff --git a/src/Command/AboutCommand.php b/src/Command/AboutCommand.php
@@ -48,23 +48,23 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $commands = [
             'init' => [
                 $this->trans('commands.init.description'),
-                'drupal init --override --no-interaction'
+                'drupal init'
             ],
             //            'quick-start' => [
             //                $this->trans('commands.common.messages.quick-start'),
-            //                'drupal chain --file=~/.console/chain/quick-start.yml'
+            //                'drupal quick:start'
             //            ],
             //            'site-new' => [
             //                $this->trans('commands.site.new.description'),
-            //                'drupal site:new drupal8.dev --latest'
+            //                'drupal site:new'
             //            ],
             'site-install' => [
                 $this->trans('commands.site.install.description'),
                 sprintf(
                     'drupal site:install'
                 )
             ],
-            'links' => [
+            'list' => [
                 $this->trans('commands.list.description'),
                 'drupal list',
             ]

diff --git a/src/Command/Chain/ChainCommand.php b/src/Command/Chain/ChainCommand.php
@@ -42,9 +42,8 @@ class ChainCommand extends Command
 
     /**
      * ChainCommand constructor.
-     * @param ChainQueue           $chainQueue
-     * @param ChainDiscovery       $chainDiscovery
-
+     * @param ChainQueue     $chainQueue
+     * @param ChainDiscovery $chainDiscovery
      */
     public function __construct(
         ChainQueue $chainQueue,

diff --git a/src/Command/Chain/ChainCustomCommand.php b/src/Command/Chain/ChainCustomCommand.php
@@ -88,7 +88,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $arguments['--placeholder'] = $this->inlineValueAsArray($placeholder);
         }
 
-        foreach($input->getOptions() as $option => $value) {
+        foreach ($input->getOptions() as $option => $value) {
             if ($option != 'placeholder' && $value) {
                 if (is_bool($value)) {
                     $value = true;

diff --git a/src/Command/Chain/ChainDebugCommand.php b/src/Command/Chain/ChainDebugCommand.php
@@ -39,6 +39,7 @@ public function __construct(
 
         parent::__construct();
     }
+
     /**
      * {@inheritdoc}
      */

diff --git a/src/Command/CheckCommand.php b/src/Command/CheckCommand.php
@@ -106,6 +106,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
                     $checks['php']['required']
                 )
             );
+
+            return 1;
         }
 
         if ($extensions = $checks['extensions']['required']['missing']) {

diff --git a/src/Command/CompleteCommand.php b/src/Command/CompleteCommand.php
@@ -34,5 +34,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $commands = array_keys($this->getApplication()->all());
         asort($commands);
         $output->writeln($commands);
+
+        return 0;
     }
 }
diff --git a/src/Command/Exclude/DrupliconCommand.php b/src/Command/Exclude/DrupliconCommand.php
@@ -15,10 +15,17 @@
 use Drupal\Console\Core\Utils\TwigRenderer;
 use Drupal\Console\Core\Style\DrupalStyle;
 
+/**
+ * Class DrupliconCommand
+ * @package Drupal\Console\Core\Command\Exclude
+ */
 class DrupliconCommand extends Command
 {
     use CommandTrait;
 
+    /**
+     * @var string
+     */
     protected $appRoot;
     /**
      * @var TwigRenderer
@@ -39,13 +46,19 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         $this
             ->setName('druplicon')
             ->setDescription($this->trans('application.commands.druplicon.description'));
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $io = new DrupalStyle($input, $output);
@@ -61,7 +74,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
             ->in($directory);
 
         $templates = [];
-
         foreach ($finder as $template) {
             $templates[] = $template->getRelativePathname();
         }
@@ -74,5 +86,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
         );
 
         $io->writeln($druplicon);
+        return 0;
     }
 }
diff --git a/src/Command/Exclude/DrushCommand.php b/src/Command/Exclude/DrushCommand.php
@@ -16,6 +16,10 @@
 use Drupal\Console\Core\Utils\ChainQueue;
 use Drupal\Console\Core\Style\DrupalStyle;
 
+/**
+ * Class DrushCommand
+ * @package Drupal\Console\Core\Command\Exclude
+ */
 class DrushCommand extends Command
 {
     use CommandTrait;
@@ -44,6 +48,9 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         $this
@@ -57,6 +64,9 @@ protected function configure()
             );
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $io = new DrupalStyle($input, $output);

diff --git a/src/Command/Exclude/ElephpantCommand.php b/src/Command/Exclude/ElephpantCommand.php
@@ -15,11 +15,19 @@
 use Drupal\Console\Core\Utils\TwigRenderer;
 use Drupal\Console\Core\Style\DrupalStyle;
 
+/**
+ * Class ElephpantCommand
+ * @package Drupal\Console\Core\Command\Exclude
+ */
 class ElephpantCommand extends Command
 {
     use CommandTrait;
 
+    /**
+     * @var string
+     */
     protected $appRoot;
+
     /**
      * @var TwigRenderer
      */
@@ -39,13 +47,19 @@ public function __construct(
         parent::__construct();
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function configure()
     {
         $this
             ->setName('elephpant')
             ->setDescription($this->trans('application.commands.elephpant.description'));
     }
 
+    /**
+     * {@inheritdoc}
+     */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $io = new DrupalStyle($input, $output);
@@ -74,5 +88,6 @@ protected function execute(InputInterface $input, OutputInterface $output)
         );
 
         $io->writeln($elephpant);
+        return 0;
     }
 }
diff --git a/src/Command/Exec/ExecCommand.php b/src/Command/Exec/ExecCommand.php
@@ -56,8 +56,7 @@ protected function configure()
                 null,
                 InputOption::VALUE_OPTIONAL,
                 $this->trans('commands.exec.options.working-directory')
-            )
-        ;
+            );
     }
 
     /**

diff --git a/src/Command/InitCommand.php b/src/Command/InitCommand.php
@@ -127,8 +127,7 @@ protected function interact(InputInterface $input, OutputInterface $output)
                     $this->trans('commands.init.questions.destination'),
                     $this->configurationManager->getConfigurationDirectories()
                 );
-            }
-            else {
+            } else {
                 $destination = $this->configurationManager
                     ->getConsoleDirectory();
             }
@@ -238,6 +237,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         );
 
         $io->writeln($this->trans('application.messages.autocomplete'));
+
+        return 0;
     }
 
     /**

diff --git a/src/Command/ListCommand.php b/src/Command/ListCommand.php
@@ -15,6 +15,10 @@
 use Drupal\Console\Core\Command\Shared\CommandTrait;
 use Drupal\Console\Core\Style\DrupalStyle;
 
+/**
+ * Class ListCommand
+ * @package Drupal\Console\Core\Command
+ */
 class ListCommand extends Command
 {
     use CommandTrait;

diff --git a/src/Command/Settings/SetCommand.php b/src/Command/Settings/SetCommand.php
@@ -36,7 +36,6 @@ class SetCommand extends Command
      */
     protected $nestedArray;
 
-
     /**
      * CheckCommand constructor.
      * @param ConfigurationManager $configurationManager

diff --git a/src/Command/ShellCommand.php b/src/Command/ShellCommand.php
@@ -9,8 +9,12 @@
 use Symfony\Component\Console\Command\Command;
 use Drupal\Console\Core\Command\Shared\CommandTrait;
 
-class ShellCommand extends Command {
-
+/**
+ * Class ShellCommand
+ * @package Drupal\Console\Core\Command
+ */
+class ShellCommand extends Command
+{
     use CommandTrait;
 
     /**
@@ -27,7 +31,8 @@ protected function configure()
     /**
      * {@inheritdoc}
      */
-    protected function execute(InputInterface $input, OutputInterface $output) {
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
         $config = new Configuration;
         $shell = new Shell($config);
         $shell->run();

diff --git a/src/Command/Site/DebugCommand.php b/src/Command/Site/DebugCommand.php
@@ -117,7 +117,7 @@ private function siteDetail($target)
     }
 
     /**
-     * @param string      $sitesDirectory
+     * @param string $sitesDirectory
      * @return array
      */
     private function siteList($sitesDirectory)