Docblocks and such

Author: JeffreyWay

src/Laracasts/Commander/CommandHandler.php

@@ -3,7 +3,7 @@
 interface CommandHandler {
 
     /**
-     * Handle the command
+     * Handle the command.
      *
      * @param $command
      * @return mixed

src/Laracasts/Commander/CommandTranslator.php

@@ -3,7 +3,7 @@
 interface CommandTranslator {
 
     /**
-     * Translate a command to its handler counterpart
+     * Translate a command to its handler counterpart.
      *
      * @param $command
      * @return mixed
@@ -12,7 +12,7 @@ interface CommandTranslator {
     public function toCommandHandler($command);
 
     /**
-     * Translate a command to its validator counterpart
+     * Translate a command to its validator counterpart.
      *
      * @param $command
      * @return mixed

src/Laracasts/Commander/CommanderServiceProvider.php

@@ -37,15 +37,15 @@ public function provides()
     }
 
     /**
-     * Register the command translator binding
+     * Register the command translator binding.
      */
     protected function registerCommandTranslator()
     {
         $this->app->bind('Laracasts\Commander\CommandTranslator', 'Laracasts\Commander\BasicCommandTranslator');
     }
 
     /**
-     * Register the desired command bus implementation
+     * Register the command bus implementation.
      */
     protected function registerCommandBus()
     {
@@ -59,7 +59,7 @@ protected function registerCommandBus()
     }
 
     /**
-     * Register the Artisan command
+     * Register the Artisan command.
      *
      * @return void
      */

src/Laracasts/Commander/CommanderTrait.php

@@ -7,7 +7,7 @@
 trait CommanderTrait {
 
     /**
-     * Execute the command
+     * Execute the command.
      *
      * @param  string $command
      * @param  array $input
@@ -22,10 +22,8 @@ protected function execute($command, array $input = null, $decorators = [])
 
         $bus = $this->getCommandBus();
 
-        // If any decorators are passed, we'll
-        // filter through and register them
-        // with the CommandBus, so that they
-        // are executed first.
+        // If any decorators are passed, we'll filter through and register them
+        // with the CommandBus, so that they are executed first.
         foreach ($decorators as $decorator)
         {
             $bus->decorate($decorator);
@@ -46,11 +44,11 @@ public function getCommandBus()
 
     /**
      * Map an array of input to a command's properties.
-     * - Code courtesy of Taylor Otwell.
      *
      * @param  string $command
      * @param  array $input
      * @throws InvalidArgumentException
+     * @author Taylor Otwell
      *
      * @return mixed
      */

src/Laracasts/Commander/Console/CommandGenerator.php

@@ -5,16 +5,31 @@
 
 class CommandGenerator {
 
+    /**
+     * @var Filesystem
+     */
     protected $file;
 
+    /**
+     * @var Mustache_Engine
+     */
     protected $mustache;
 
+    /**
+     * @param Filesystem $file
+     * @param Mustache_Engine $mustache
+     */
     public function __construct(Filesystem $file, Mustache_Engine $mustache)
     {
         $this->file = $file;
         $this->mustache = $mustache;
     }
 
+    /**
+     * @param CommandInput $input
+     * @param $template
+     * @param $destination
+     */
     public function make(CommandInput $input, $template, $destination)
     {
         $template = $this->file->get($template);

src/Laracasts/Commander/Console/CommandInput.php

@@ -2,19 +2,36 @@
 
 class CommandInput {
 
+    /**
+     * @var string
+     */
     public $name;
 
+    /**
+     * @var string
+     */
     public $namespace;
 
+    /**
+     * @var array
+     */
     public $properties = [];
 
+    /**
+     * @param $name
+     * @param $namespace
+     * @param $properties
+     */
     public function __construct($name, $namespace, $properties)
     {
         $this->name = $name;
         $this->namespace = $namespace;
         $this->properties = $properties;
     }
 
+    /**
+     * @return string
+     */
     public function arguments()
     {
         return implode(', ', array_map(function($property)

src/Laracasts/Commander/Console/CommandInputParser.php

@@ -2,6 +2,11 @@
 
 class CommandInputParser {
 
+    /**
+     * @param $path
+     * @param $properties
+     * @return CommandInput
+     */
     public function parse($path, $properties)
     {
         $segments = explode('\\', str_replace('/', '\\', $path));
@@ -13,6 +18,10 @@ public function parse($path, $properties)
         return new CommandInput($name, $namespace, $properties);
     }
 
+    /**
+     * @param $properties
+     * @return array
+     */
     private function parseProperties($properties)
     {
         return preg_split('/ ?, ?/', $properties, null, PREG_SPLIT_NO_EMPTY);