Updated descriptions

rougin · Jan 8, 2016 · 1169501 · 1169501
1 parent 4c742c6
commit 1169501
Show file tree

Hide file tree

Showing 19 changed files with 127 additions and 86 deletions.
diff --git a/src/Common/AbstractCommand.php → src/Commands/AbstractCommand.php b/src/Common/AbstractCommand.php → src/Commands/AbstractCommand.php
@@ -16,12 +16,19 @@
  */
 abstract class AbstractCommand extends Command
 {
+    /**
+     * @var \Rougin\Describe\Describe
+     */
     protected $describe;
+
+    /**
+     * @var \Twig_Environment
+     */
     protected $renderer;
 
     /**
-     * @param Twig_Environment $renderer
-     * @param Describe         $describe
+     * @param \Twig_Environment         $renderer
+     * @param \Rougin\Describe\Describe $describe
      */
     public function __construct(Describe $describe, Twig_Environment $renderer)
     {

diff --git a/src/Commands/CreateControllerCommand.php b/src/Commands/CreateControllerCommand.php
@@ -6,7 +6,6 @@
 use Rougin\Combustor\Common\File;
 use Rougin\Combustor\Common\Tools;
 use Rougin\Combustor\Validator\Validator;
-use Rougin\Combustor\Common\AbstractCommand;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;

diff --git a/src/Commands/CreateLayoutCommand.php b/src/Commands/CreateLayoutCommand.php
@@ -3,7 +3,6 @@
 namespace Rougin\Combustor\Commands;
 
 use Rougin\Combustor\Common\Tools;
-use Rougin\Combustor\Common\AbstractCommand;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -106,7 +105,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             array_push($data['scripts'], $bootstrapJs);
         }
 
-        if ( ! @mkdir($filePath, 0777, TRUE)) {
+        if ( ! @mkdir($filePath, 0777, true)) {
             $message = 'The layout directory already exists!';
 
             return $output->writeln('<error>'.$message.'</error>');

diff --git a/src/Commands/CreateModelCommand.php b/src/Commands/CreateModelCommand.php
@@ -6,7 +6,6 @@
 use Rougin\Combustor\Common\File;
 use Rougin\Combustor\Common\Tools;
 use Rougin\Combustor\Validator\Validator;
-use Rougin\Combustor\Common\AbstractCommand;
 use Rougin\Combustor\Generator\ModelGenerator;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;

diff --git a/src/Commands/CreateScaffoldCommand.php b/src/Commands/CreateScaffoldCommand.php
@@ -2,7 +2,6 @@
 
 namespace Rougin\Combustor\Commands;
 
-use Rougin\Combustor\Common\AbstractCommand;
 use Rougin\Combustor\Common\Tools;
 use Symfony\Component\Console\Input\ArrayInput;
 use Symfony\Component\Console\Input\InputArgument;

diff --git a/src/Commands/CreateViewCommand.php b/src/Commands/CreateViewCommand.php
@@ -6,7 +6,6 @@
 use Rougin\Combustor\Common\File;
 use Rougin\Combustor\Common\Tools;
 use Rougin\Combustor\Common\FileCollection;
-use Rougin\Combustor\Common\AbstractCommand;
 use Rougin\Combustor\Generator\ViewGenerator;
 use Rougin\Combustor\Validator\ViewValidator;
 use Symfony\Component\Console\Command\Command;
@@ -36,10 +35,10 @@ class CreateViewCommand extends AbstractCommand
     public function isEnabled()
     {
         if ( ! Tools::isCommandEnabled() && ! Tools::hasLayout()) {
-            return FALSE;
+            return false;
         }
 
-        return TRUE;
+        return true;
     }
 
     /**

diff --git a/src/Commands/InstallDoctrineCommand.php b/src/Commands/InstallDoctrineCommand.php
@@ -3,7 +3,6 @@
 namespace Rougin\Combustor\Commands;
 
 use Rougin\Combustor\Common\Tools;
-use Rougin\Combustor\Common\AbstractCommand;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -30,10 +29,10 @@ class InstallDoctrineCommand extends AbstractCommand
     public function isEnabled()
     {
         if (file_exists(APPPATH.'libraries/Doctrine.php')) {
-            return FALSE;
+            return false;
         }
 
-        return TRUE;
+        return true;
     }
 
     /**
@@ -133,8 +132,8 @@ protected function execute(InputInterface $input, OutputInterface $output)
         $schemaTool = 'use Doctrine\ORM\Tools\SchemaTool;';
         $coreModel = 'include BASEPATH . \'core/Model.php\';';
 
-        if (strpos($abstractCommand, $schemaTool) !== FALSE) {
-            if (strpos($abstractCommand, $coreModel) === FALSE) {
+        if (strpos($abstractCommand, $schemaTool) !== false) {
+            if (strpos($abstractCommand, $coreModel) === false) {
                 $contents = str_replace($search, $replace, $abstractCommand);
             }
         }

diff --git a/src/Commands/InstallWildfireCommand.php b/src/Commands/InstallWildfireCommand.php
@@ -3,7 +3,6 @@
 namespace Rougin\Combustor\Commands;
 
 use Rougin\Combustor\Common\Tools;
-use Rougin\Combustor\Common\AbstractCommand;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
@@ -30,10 +29,10 @@ class InstallWildfireCommand extends AbstractCommand
     public function isEnabled()
     {
         if (file_exists(APPPATH.'libraries/Wildfire.php')) {
-            return FALSE;
+            return false;
         }
 
-        return TRUE;
+        return true;
     }
 
     /**

diff --git a/src/Commands/RemoveDoctrineCommand.php b/src/Commands/RemoveDoctrineCommand.php
@@ -3,7 +3,6 @@
 namespace Rougin\Combustor\Commands;
 
 use Rougin\Combustor\Common\Tools;
-use Rougin\Combustor\Common\AbstractCommand;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;

diff --git a/src/Commands/RemoveWildfireCommand.php b/src/Commands/RemoveWildfireCommand.php
@@ -3,7 +3,6 @@
 namespace Rougin\Combustor\Commands;
 
 use Rougin\Combustor\Common\Tools;
-use Rougin\Combustor\Common\AbstractCommand;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;

diff --git a/src/Common/File.php b/src/Common/File.php
@@ -12,7 +12,14 @@
  */
 class File
 {
+    /**
+     * @var File pointer
+     */
     protected $file;
+
+    /**
+     * @var string
+     */
     protected $path;
 
     /**

diff --git a/src/Common/FileCollection.php b/src/Common/FileCollection.php
@@ -14,7 +14,10 @@
  */
 class FileCollection
 {
-    protected $files;
+    /**
+     * @var array
+     */
+    protected $files = [];
 
     /**
      * Adds a File object to the listing of files.
@@ -38,11 +41,11 @@ public function close()
     {
         foreach ($this->files as $file) {
             if ( ! $file->close()) {
-                return FALSE;
+                return false;
             }
         }
 
-        return TRUE;
+        return true;
     }
 
     /**

diff --git a/src/Common/Tools.php b/src/Common/Tools.php
@@ -25,21 +25,21 @@ public static function ignite()
         $config = new File(APPPATH.'config/config.php', 'wb');
 
         $search = [
-            '$config[\'composer_autoload\'] = FALSE;'
+            '$config[\'composer_autoload\'] = false;'
         ];
 
         $replace = [
             '$config[\'composer_autoload\'] = realpath(\'vendor\') . \'/autoload.php\';'
         ];
 
         // Removes the index.php from $config['index_page'].
-        if (strpos($config->getContents(), '$config[\'index_page\'] = \'index.php\';') !== FALSE) {
+        if (strpos($config->getContents(), '$config[\'index_page\'] = \'index.php\';') !== false) {
             array_push($search, '$config[\'index_page\'] = \'index.php\';');
             array_push($replace, '$config[\'index_page\'] = \'\';');
         }
 
         // Adds an encryption key from the configuration.
-        if (strpos($config->getContents(), '$config[\'encryption_key\'] = \'\';') !== FALSE) {
+        if (strpos($config->getContents(), '$config[\'encryption_key\'] = \'\';') !== false) {
             array_push($search, '$config[\'encryption_key\'] = \'\';');
             array_push($replace, '$config[\'encryption_key\'] = \''.md5('rougin').'\';');
         }
@@ -149,11 +149,7 @@ public static function ignite()
      */
     public static function isCommandEnabled()
     {
-        if ( ! self::isWildfireEnabled() && ! self::isDoctrineEnabled()) {
-            return FALSE;
-        }
-
-        return TRUE;
+        return self::isWildfireEnabled() || self::isDoctrineEnabled();
     }
 
     /**
@@ -163,11 +159,7 @@ public static function isCommandEnabled()
      */
     public static function isDoctrineEnabled()
     {
-        if ( ! file_exists(APPPATH.'libraries/Doctrine.php')) {
-            return FALSE;
-        }
-
-        return TRUE;
+        return file_exists(APPPATH.'libraries/Doctrine.php');
     }
 
     /**
@@ -177,14 +169,8 @@ public static function isDoctrineEnabled()
      */
     public static function hasLayout()
     {
-        if (
-            ! file_exists(APPPATH.'views/layout/header.php') ||
-            ! file_exists(APPPATH.'views/layout/footer.php')
-        ) {
-            return FALSE;
-        }
-
-        return TRUE;
+        return file_exists(APPPATH.'views/layout/header.php')
+            && file_exists(APPPATH.'views/layout/footer.php');
     }
 
     /**
@@ -194,11 +180,7 @@ public static function hasLayout()
      */
     public static function isWildfireEnabled()
     {
-        if ( ! file_exists(APPPATH.'libraries/Wildfire.php')) {
-            return FALSE;
-        }
-
-        return TRUE;
+        return file_exists(APPPATH.'libraries/Wildfire.php');
     }
 
     /**
@@ -209,11 +191,9 @@ public static function isWildfireEnabled()
      */
     public static function stripTableSchema($table)
     {
-        if (strpos($table, '.') !== FALSE) {
-            return substr($table, strpos($table, '.') + 1);
-        }
-
-        return $table;
+        return (strpos($table, '.') !== false)
+            ? substr($table, strpos($table, '.') + 1)
+            : $table;
     }
 
     /**

diff --git a/src/Generator/ControllerGenerator.php b/src/Generator/ControllerGenerator.php
@@ -16,12 +16,19 @@
  */
 class ControllerGenerator implements GeneratorInterface
 {
+    /**
+     * @var \Rougin\Describe\Describe
+     */
     protected $describe;
-    protected $data;
 
     /**
-     * @param Describe $describe
-     * @param array    $data
+     * @var array
+     */
+    protected $data = [];
+
+    /**
+     * @param \Rougin\Describe\Describe $describe
+     * @param array $data
      */
     public function __construct(Describe $describe, array $data)
     {
@@ -100,4 +107,4 @@ public function generate()
 
         return $this->data;
     }
-}
+}
diff --git a/src/Generator/GeneratorInterface.php b/src/Generator/GeneratorInterface.php
@@ -18,4 +18,4 @@ interface GeneratorInterface
      * @return array
      */
     public function generate();
-}
+}
diff --git a/src/Generator/ModelGenerator.php b/src/Generator/ModelGenerator.php
@@ -16,12 +16,19 @@
  */
 class ModelGenerator implements GeneratorInterface
 {
+    /**
+     * @var \Rougin\Describe\Describe
+     */
     protected $describe;
-    protected $data;
 
     /**
-     * @param Describe $describe
-     * @param array    $data
+     * @var array
+     */
+    protected $data = [];
+
+    /**
+     * @param \Rougin\Describe\Describe $describe
+     * @param array $data
      */
     public function __construct(Describe $describe, array $data)
     {
@@ -96,4 +103,4 @@ public function generate()
 
         return $this->data;
     }
-}
+}
diff --git a/src/Generator/ViewGenerator.php b/src/Generator/ViewGenerator.php
@@ -16,12 +16,19 @@
  */
 class ViewGenerator implements GeneratorInterface
 {
+    /**
+     * @var \Rougin\Describe\Describe
+     */
     protected $describe;
-    protected $data;
 
     /**
-     * @param Describe $describe
-     * @param array    $data
+     * @var array
+     */
+    protected $data = [];
+
+    /**
+     * @param \Rougin\Describe\Describe $describe
+     * @param array $data
      */
     public function __construct(Describe $describe, array $data)
     {
@@ -139,4 +146,4 @@ public function generate()
 
         return $this->data;
     }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -18,4 +18,4 @@ interface GeneratorInterface @@
          * @return array
          */
         public function generate();
-    }
+    }