Commented the code and remove useless directory

Author: Nicolas Boisvert

src/Import.php

@@ -2,6 +2,14 @@
 
 namespace Nicklayb\LaravelDbImport;
 
+/**
+ * Class for Import process
+ *
+ * @author Nicolas Boisvert ([email protected])
+ *
+ * Extends this class to match your needs. Don't forget to add it in your
+ * dbimport.php config file so you will be able to call it
+ */
 abstract class Import
 {
     /**
@@ -52,25 +60,37 @@ abstract class Import
      */
     protected $refresh = false;
 
+    /**
+     * Specify table by table the select statement of which column to load
+     *
+     * @var array
+     */
     protected $selects = [];
 
+    /**
+     * Show table command, it may change depending on your database server
+     *
+     * @var string
+     */
     protected $showTablesCommand = 'SHOW TABLES';
 
-    public function getShowTablesCommand()
-    {
-        return $this->showTablesCommand;
-    }
-
-    public function getSourceConnection()
-    {
-        return $this->sourceConnection;
-    }
-
+    /**
+     * Checks if provided table has specific selected columns
+     *
+     * @param string $table
+     * @return bool
+     */
     public function hasSelects($table)
     {
         return isset($this->selects[$table]);
     }
 
+    /**
+     * Gets specific selects for defined table
+     *
+     * @param string $table
+     * @return array
+     */
     public function getSelects($table)
     {
         if ($this->hasSelects($table)) {
@@ -79,46 +99,62 @@ public function getSelects($table)
         return ['*'];
     }
 
-    public function getDestinationConnection()
-    {
-        return $this->destinationConnection;
-    }
-
+    /**
+     * Return the qualified column name for table select
+     *
+     * @return string
+     */
     public function getQualifiedTableColumnName()
     {
         return 'Tables_in_'.$this->sourceConnection;
     }
 
+    /**
+     * Return the database name from the configuration for the source
+     *
+     * @return string
+     */
     public function getSourceDatabaseName()
     {
         return config('database.connections.'.$this->sourceConnection.'.database');
     }
 
+    /**
+     * Load all tables from the source connection
+     *
+     * @return array
+     */
     public function loadSourceTables()
     {
         return DB::connection($this->sourceConnection)->select($this->showTablesCommand);
     }
 
+    /**
+     * Get a collection of only the table names from the the source connection
+     *
+     * @return Collection
+     */
     public function getSourceTables()
     {
-        return collect($this->getTableSelect())->pluck($this->getQualifiedTableColumnName())
-    }
-
-    public function getIgnoreTables()
-    {
-        return $this->ignoreTables;
-    }
-
-    public function getLastTables()
-    {
-        return $this->lastTables;
+        return collect($this->loadSourceTables())->pluck($this->getQualifiedTableColumnName())
     }
 
+    /**
+     * Return the count of the pre/post tasks of the import
+     *
+     * @return int
+     */
     public function countImportTasks()
     {
         return count($this->preImport()) + count($this->postImport());
     }
 
+    /**
+     * Return all rows from specified table in the source connection with
+     * the selected columns
+     *
+     * @return Collection
+     */
     public function getSourceRows($table)
     {
         return DB::connection($this->sourceConnection)
@@ -127,20 +163,35 @@ public function getSourceRows($table)
             ->get();
     }
 
+    /**
+     * Delete the content of the destination connection table
+     *
+     * @return int
+     */
     public function clearDestinationTable($table)
     {
         return DB::connection($this->destinationConnection)
             ->table($table)
             ->delete();
     }
 
+    /**
+     * Insert specific data into the destination connection
+     *
+     * @return int
+     */
     public function insertInDestination($table, $row)
     {
         return DB::connection($this->destinationConnection)
             ->table($table)
             ->insert((array) $this->executeManipulation($table, $row));
     }
 
+    /**
+     * Sort the sources tables by ordering last tables and removing the ingored
+     *
+     * @return Collection
+     */
     public function getSortedSourceTables()
     {
         $tables = $this->getSourceTables();
@@ -149,31 +200,31 @@ public function getSortedSourceTables()
         foreach ($tables as $table) {
             if ($this->hasLastTable($table)) {
                 $hold->push($table);
-            } else {
+            } elseif (!$this->hasIgnoreTable($table)) {
                 $filteredTables->push($table);
             }
         }
         return $filteredTables->merge($holds);
     }
 
+    /**
+     * Check if a specified table should be ignored
+     *
+     * @return bool
+     */
     public function hasIgnoreTable($table)
     {
         return in_array($table, $this->ignoreTables);
     }
 
-    public function hasLastTable($table)
-    {
-        return in_array($table, $this->lastTables);
-    }
-
     /**
-     * Check if any ignore table is registered in the property
+     * Check if a specified table should be last
      *
      * @return bool
      */
-    public function hasIgnoreTables()
+    public function hasLastTable($table)
     {
-        return count($this->ignoreTables) > 0;
+        return in_array($table, $this->lastTables);
     }
 
     /**

src/ImportCommand.php

@@ -29,24 +29,49 @@ class ImportCommand extends Command
      */
     protected $import = null;
 
+    /**
+     * Name of the import
+     *
+     * @var string
+     */
     protected $importName;
 
+    /**
+     * All the source tables to import
+     *
+     * @var array
+     */
     protected $sourceTables = [];
 
+    /**
+     * Count of all the tasks required to complete de command
+     *
+     * @var int
+     */
     protected $tasksCount = 0;
 
+    /**
+     * List of errors that happens during import
+     *
+     * @var array
+     */
     protected $errors = [];
 
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
+    /**
+     * Checks if the provided import is in the config file
+     *
+     * @return bool
+     */
     private function importIsRegistered()
     {
         return in_array($this->importName, config('dbimport.imports'));
     }
 
+    /**
+     * Create the actual import instance
+     *
+     * @return bool
+     */
     private function createImport()
     {
         if ($this->importIsRegistered()) {
@@ -61,12 +86,22 @@ private function createImport()
         return false;
     }
 
+    /**
+     * Setup the tasks count for the progress bar
+     *
+     * @return void
+     */
     public function setTasksCount()
     {
         $this->tasksCount = $this->sourceTables->count() + $this->import->countImportTasks();
         $this->bar = $this->output->createProgressBar($this->tasksCount);
     }
 
+    /**
+     * Handle the command process. This is overriden from Laravel's command
+     *
+     * @return void
+     */
     public function handle()
     {
         if ($this->boot()) {
@@ -76,6 +111,11 @@ public function handle()
         }
     }
 
+    /**
+     * Handle the tables imports process
+     *
+     * @return void
+     */
     private function handleImport()
     {
         foreach ($this->sourceTables as $table) {
@@ -92,6 +132,11 @@ private function handleImport()
         }
     }
 
+    /**
+     * Handle specific table import
+     *
+     * @return void
+     */
     public function handleTableImport($table)
     {
         $count = 0;
@@ -108,6 +153,11 @@ public function handleTableImport($table)
         return $count;
     }
 
+    /**
+     * Executes array of tasks
+     *
+     * @return void
+     */
     private function executeTasks($tasks)
     {
         foreach ($tasks as $key => $task) {
@@ -117,6 +167,11 @@ private function executeTasks($tasks)
         }
     }
 
+    /**
+     * Bootup the command process and return if the command can proceed or not
+     *
+     * @return true
+     */
     private function boot()
     {
         $this->importName = $this->argument('database');

src/ServiceProvider.php

@@ -7,6 +7,11 @@
 
 class ServiceProvider extends BaseProvider
 {
+    /**
+     * Config file name
+     *
+     * @var string
+     */
     const CONFIG_FILE = 'dbimport.php';
 
     /**
@@ -42,6 +47,9 @@ public function register()
      */
     public function provides()
     {
-        return ['Nicklayb\LaravelDbImport\DbImport'];
+        return [
+            'Nicklayb\LaravelDbImport\ImportCommand',
+            'Nicklayb\LaravelDbImport\Import'
+        ];
     }
 }