tarsana / command

src/Command.php

Doc Comments +3 added lines, -3 removed lines

@@ -185,7 +185,7 @@ 
      * @param  string $name
      * @param  string $description
      * @param  mixed  $default
-     * @return Tarsana\Command\Syntax\SyntaxBuilder
+     * @return Command
      */
     public function describe($name, $description, $default = null)
     {
@@ -212,7 +212,7 @@ 
      * adds/overrides or gets a sub command.
      *
      * @param  string  $name
-     * @param  Tarsana\Command\Command|null $cmd
+     * @param  null|Command $cmd
      * @return Tarsana\Command\Command
      */
     public function command ($name, Command $cmd = null)
@@ -299,7 +299,7 @@ 
      * Runs the command.
      *
      * @param  string|null $args
-     * @param  League\CLImate\CLImate|null $console
+     * @param  null|CLImate $console
      * @return void
      */
     public function run ($args = null, CLImate $console = null)

Spacing +17 added lines, -17 removed lines

@@ -86,7 +86,7 @@ 
      * Creates a new Command.
      *
      */
-    public function __construct ()
+    public function __construct()
     {
         $this->templateLoader = new TemplateLoader;
         $this->fs = new Filesystem('.');
@@ -107,7 +107,7 @@ 
      * @param  string|void $value
      * @return string|self
      */
-    public function name ($value = null)
+    public function name($value = null)
     {
         if (null === $value)
             return $this->name;
@@ -122,7 +122,7 @@ 
      * @param  string|void $value
      * @return string|self
      */
-    public function description ($value = null)
+    public function description($value = null)
     {
         if (null === $value)
             return $this->description;
@@ -137,7 +137,7 @@ 
      * @param  string|void $value
      * @return string|self
      */
-    public function version ($value = null)
+    public function version($value = null)
     {
         if (null === $value)
             return $this->version;
@@ -152,7 +152,7 @@ 
      * @param  League\CLImate\CLImate|void $value
      * @return League\CLImate\CLImate|self
      */
-    public function console ($value = null)
+    public function console($value = null)
     {
         if (null === $value)
             return $this->console;
@@ -168,7 +168,7 @@ 
      * @return Tarsana\Syntax\Syntax|self
      * @throws InvalidArgumentException
      */
-    public function syntax ($value = null)
+    public function syntax($value = null)
     {
         if (null === $value)
             return $this->syntaxBuilder->get();
@@ -215,7 +215,7 @@ 
      * @param  Tarsana\Command\Command|null $cmd
      * @return Tarsana\Command\Command
      */
-    public function command ($name, Command $cmd = null)
+    public function command($name, Command $cmd = null)
     {
         if (null === $cmd) {
             if (!$this->hasCommand($name))
@@ -233,7 +233,7 @@ 
      * @param  string  $name
      * @return boolean
      */
-    public function hasCommand ($name) {
+    public function hasCommand($name) {
         return isset($this->subCommands[$name]);
     }
 
@@ -302,7 +302,7 @@ 
      * @param  League\CLImate\CLImate|null $console
      * @return void
      */
-    public function run ($args = null, CLImate $console = null)
+    public function run($args = null, CLImate $console = null)
     {
         try {
 
@@ -317,7 +317,7 @@ 
                 $this->command($firstArg)->run($args, $console);
             } else {
                 $this->console($console);
-                if (! $this->syntax()->canParse($args)) {
+                if (!$this->syntax()->canParse($args)) {
                     $errors = F\s($this->syntax()->checkParse($args))
                         ->then(F\append("Invalid arguments: '{$args}' for command '{$this->name}'"))
                         ->then(F\join(PHP_EOL))
@@ -357,7 +357,7 @@ 
      *
      * @return string
      */
-    protected function consoleArguments ()
+    protected function consoleArguments()
     {
         return Stream::of($_SERVER['argv'])    // ['script.php', foo', 'lorem ipsum']
             ->then(F\f('tail'))                // ['foo', 'lorem ipsum']
@@ -373,9 +373,9 @@ 
     /**
      * Adds Help and Version sub commands.
      */
-    protected function addDefaultSubCommands ()
+    protected function addDefaultSubCommands()
     {
-        if (! ($this instanceof HelpCommand) && ! ($this instanceof VersionCommand)) {
+        if (!($this instanceof HelpCommand) && !($this instanceof VersionCommand)) {
             $helpCommand = new HelpCommand($this);
             $this->command('--help', $helpCommand)
                  ->command('help', $helpCommand);
@@ -391,7 +391,7 @@ 
      * @param  string $message
      * @return void
      */
-    protected function error ($message)
+    protected function error($message)
     {
         $this->console->style->addCommand('error', 'white');
         $this->console->backgroundRed()->error($message);
@@ -406,7 +406,7 @@ 
      * @param  CLImate $console
      * @return void
      */
-    protected function call ($name, $args = null, CLImate $console = null)
+    protected function call($name, $args = null, CLImate $console = null)
     {
         return Environment::get()
             ->command($name)
@@ -420,12 +420,12 @@ 
      *
      * @return void
      */
-    protected function init () {}
+    protected function init() {}
 
     /**
      * The logic of the command goes in this method.
      *
      * @return self
      */
-    abstract protected function execute ();
+    abstract protected function execute();
 }

src/Commands/HelpCommand.php

Doc Comments +6 added lines

@@ -74,6 +74,9 @@ 
         }
     }
 
+    /**
+     * @param integer $level
+     */
     protected function showSyntax($name, $syntax, $level)
     {
         $type = $this->typeOf($syntax);
@@ -102,6 +105,9 @@ 
         }
     }
 
+    /**
+     * @return integer
+     */
     protected function typeOf(Syntax $syntax)
     {
         if ($syntax instanceof ObjectSyntax) {

Spacing +3 added lines, -3 removed lines

@@ -12,7 +12,7 @@ 
 
 class HelpCommand extends SubCommand {
 
-    protected function init ()
+    protected function init()
     {
         $this
             ->name('Help')
@@ -21,7 +21,7 @@ 
             ->syntax('[command]');
     }
 
-    protected function execute ()
+    protected function execute()
     {
         $command = trim($this->args->command);
         if (empty($command) || !$this->parent()->hasCommand($command))
@@ -30,7 +30,7 @@ 
             $this->showHelpOf($this->parent->command($command));
     }
 
-    protected function showHelpOf (Command $command)
+    protected function showHelpOf(Command $command)
     {
         $c = $this->console();
 

src/Syntax/SyntaxBuilder.php

Doc Comments +5 added lines, -5 removed lines

@@ -23,7 +23,7 @@ 
     /**
      * A constructor alias; If you don't like the 'new' keyword.
      * @param  string|Tarsana\Syntax\ObjectSyntax $syntax
-     * @return Tarsana\Command\Syntax\SyntaxBuilder
+     * @return SyntaxBuilder
      * @throws Tarsana\Command\Exceptions\SyntaxBuilderException
      */
     public static function of($syntax)
@@ -88,7 +88,7 @@ 
      * @param  string $name
      * @param  string $description
      * @param  mixed  $default
-     * @return Tarsana\Command\Syntax\SyntaxBuilder
+     * @return SyntaxBuilder
      */
     public function describe($name, $description, $default = null)
     {
@@ -104,7 +104,7 @@ 
     /**
      * Gets a field or subfield from an Syntax.
      *
-     * @param  Tarsana\Syntax\Syntax $syntax
+     * @param  Syntax $syntax
      * @param  array $names
      * @return Tarsana\Syntax\Syntax
      * @throws Tarsana\Command\Exceptions\SyntaxBuilderException
@@ -122,8 +122,8 @@ 
      * Ensures that `$syntax` is an ObjectSyntax or an ArraySyntax of ObjectSyntaxes,
      * and returns the ObjectSyntax or throws a SyntaxBuilderException.
      *
-     * @param  Tarsana\Syntax\Syntax $syntax
-     * @return Tarsana\Syntax\Syntax
+     * @param  Syntax $syntax
+     * @return ObjectSyntax
      * @throws Tarsana\Command\Exceptions\SyntaxBuilderException
      */
     protected function ensureObject(Syntax $syntax)

Spacing +6 added lines, -7 removed lines

@@ -41,7 +41,7 @@ 
     {
         if (is_string($syntax)) {
             $syntax = self::syntaxFromString($syntax);
-        } else if (! ($syntax instanceof ObjectSyntax)) {
+        } else if (!($syntax instanceof ObjectSyntax)) {
             throw new SyntaxBuilderException("The command syntax should be an insatnce of ObjectSyntax");
         }
 
@@ -65,11 +65,11 @@ 
      * @return Tarsana\Syntax\Syntax
      * @throws Tarsana\Command\Exceptions\SyntaxBuilderException
      */
-    protected static function syntaxFromString ($value)
+    protected static function syntaxFromString($value)
     {
         $syntax = F\s($value)->then(        // "first name" [#age]
-            F\chunks('(){}[]""', ' '),      // ["first name", [#age]]
-            F\join(','),                    // "first name",[#age]
+            F\chunks('(){}[]""', ' '), // ["first name", [#age]]
+            F\join(','), // "first name",[#age]
             F\prepend('{ ,'), F\append('}') // { ,"first name",[#age]}
         )->get();
 
@@ -111,8 +111,7 @@ 
      */
     protected function field(Syntax $syntax, $names)
     {
-        return empty($names) ? $syntax :
-            $this->field(
+        return empty($names) ? $syntax : $this->field(
                 $this->ensureObject($syntax)->field(F\head($names)),
                 F\tail($names)
             );
@@ -131,7 +130,7 @@ 
         while ($syntax instanceof ArraySyntax) {
             $syntax = $syntax->itemSyntax();
         }
-        if (! ($syntax instanceof ObjectSyntax)) {
+        if (!($syntax instanceof ObjectSyntax)) {
             throw new SyntaxBuilderException("Could not retreive field of non object syntax '{$syntax}'");
         }
         return $syntax;

src/TemplateLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -58,7 +58,7 @@
     /**
      * Filesystem getter and setter.
      *
-     * @param  Tarsana\IO\Filesystem|void $value
+     * @param  null|Filesystem $value
      * @return Tarsana\IO\Filesystem|self
      */
     public function fs (Filesystem $value = null)

Spacing +2 added lines, -2 removed lines

@@ -61,7 +61,7 @@ 
      * @param  Tarsana\IO\Filesystem|void $value
      * @return Tarsana\IO\Filesystem|self
      */
-    public function fs (Filesystem $value = null)
+    public function fs(Filesystem $value = null)
     {
         if (null === $value)
             return $this->fs;
@@ -81,7 +81,7 @@ 
      * @throws Tarsana\Command\Exceptions\TemplateNotFound
      * @throws Tarsana\Command\Exceptions\TemplateNameConflict
      */
-    public function load ($name)
+    public function load($name)
     {
         $suportedExtensions = array_keys(self::$providers);
 

src/Templates/TwigTemplateLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
      * Loads a template.
      *
      * @param  string $name
-     * @return Tarsana\Command\Templates\TwigTemplate
+     * @return TwigTemplate
      */
     public function load($name)
     {

src/Templates/TwigTemplate.php

Spacing +3 added lines, -3 removed lines

@@ -21,7 +21,7 @@ 
      */
     protected $data;
 
-    public function __construct (\Twig_TemplateInterface $twig)
+    public function __construct(\Twig_TemplateInterface $twig)
     {
         $this->twig = $twig;
         $this->data = [];
@@ -33,7 +33,7 @@ 
      * @param  array $data
      * @return self
      */
-    public function bind ($data)
+    public function bind($data)
     {
         $this->data = array_merge($this->data, $data);
         return $this;
@@ -57,7 +57,7 @@ 
      *
      * @return self
      */
-    public function clean ()
+    public function clean()
     {
         $this->data = [];
     }

src/Environment.php

Spacing +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
     public function command($name, $value = null)
     {
         if (null === $value) {
-            if (! $this->hasCommand($name)) {
+            if (!$this->hasCommand($name)) {
                 throw new EnvironmentException("Unable to find the command '{$name}'");
             }
             return $this->store->get($name);

src/Commands/VersionCommand.php

Spacing +2 added lines, -2 removed lines

@@ -7,7 +7,7 @@ 
 
 class VersionCommand extends SubCommand {
 
-    protected function init ()
+    protected function init()
     {
         $this
             ->name('Version')
@@ -15,7 +15,7 @@ 
             ->description('Shows the version of the command');
     }
 
-    protected function execute ()
+    protected function execute()
     {
         $c = $this->parent();
         $this->console

src/Utils/Store.php

Spacing +3 added lines, -3 removed lines

@@ -71,7 +71,7 @@ 
     public function store($name, $value)
     {
         // Validates the name
-        if (! is_string($name)) {
+        if (!is_string($name)) {
             $this->error('The name must be a string');
         }
         if ($this->contains($name)) {
@@ -80,7 +80,7 @@ 
 
         // Validates the value
         if (is_string($value)) {
-            if (! class_exists($value)) {
+            if (!class_exists($value)) {
                 $this->error("Trying to store an unknow class '{$value}'");
             }
             if ($value != $this->type && !is_subclass_of($value, $this->type)) {
@@ -120,7 +120,7 @@ 
      */
     public function get($name)
     {
-        if (! $this->contains($name)) {
+        if (!$this->contains($name)) {
             $this->error("The element with name '{$name}' is missing");
         }