feature ( table-prefix) : add a config parameter for table prefix to avoid table name collisions

Author: qschmick

README.md

@@ -50,6 +50,10 @@ php artisan migrate
 php artisan totem:assets
 ```
 
+##### Table Prefix
+
+Totems' tables use generic names which may conflict with existing tables in a project. To alleviate this the `.env` param `TOTEM_TABLE_PREFIX` can be set which will apply a prefix to all of Totems tables and their models.
+
 #### Updating
 
 Please republish totem assets after updating totem to a new version

config/totem.php

@@ -222,6 +222,7 @@
     'api' => [
         'middleware' => env('TOTEM_API_MIDDLEWARE', 'api'),
     ],
+    'table_prefix' => env('TOTEM_TABLE_PREFIX', ''),
     'artisan' => [
         'command_filter' => [],
     ],

database/migrations/2017_08_05_194349_create_tasks_table.php

@@ -13,7 +13,7 @@ class CreateTasksTable extends Migration
      */
     public function up()
     {
-        Schema::create('tasks', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->increments('id');
             $table->string('description');
             $table->string('command');
@@ -35,6 +35,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('tasks');
+        Schema::dropIfExists(config('totem.table_prefix').'tasks');
     }
 }

database/migrations/2017_08_05_195539_create_task_frequencies_table.php

@@ -13,7 +13,7 @@ class CreateTaskFrequenciesTable extends Migration
      */
     public function up()
     {
-        Schema::create('task_frequencies', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'task_frequencies', function (Blueprint $table) {
             $table->increments('id');
             $table->unsignedInteger('task_id');
             $table->string('label');
@@ -29,6 +29,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('task_frequencies');
+        Schema::dropIfExists(config('totem.table_prefix').'task_frequencies');
     }
 }

database/migrations/2017_08_05_201914_create_task_results_table.php

@@ -13,7 +13,7 @@ class CreateTaskResultsTable extends Migration
      */
     public function up()
     {
-        Schema::create('task_results', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'task_results', function (Blueprint $table) {
             $table->increments('id');
             $table->unsignedInteger('task_id');
             $table->timestamp('ran_at')->useCurrent();
@@ -30,6 +30,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('task_results');
+        Schema::dropIfExists(config('totem.table_prefix').'task_results');
     }
 }

database/migrations/2017_08_24_085132_create_frequency_parameters_table.php

@@ -13,7 +13,7 @@ class CreateFrequencyParametersTable extends Migration
      */
     public function up()
     {
-        Schema::create('frequency_parameters', function (Blueprint $table) {
+        Schema::create(config('totem.table_prefix').'frequency_parameters', function (Blueprint $table) {
             $table->increments('id');
             $table->unsignedInteger('frequency_id');
             $table->string('name');
@@ -29,6 +29,6 @@ public function up()
      */
     public function down()
     {
-        Schema::dropIfExists('frequency_parameters');
+        Schema::dropIfExists(config('totem.table_prefix').'frequency_parameters');
     }
 }

database/migrations/2017_08_26_083622_alter_tasks_table_add_notifications_fields.php

@@ -13,7 +13,7 @@ class AlterTasksTableAddNotificationsFields extends Migration
      */
     public function up()
     {
-        Schema::table('tasks', function (Blueprint $table) {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->string('notification_phone_number')->nullable()->after('notification_email_address');
             $table->string('notification_slack_webhook')->nullable()->after('notification_phone_number');
         });
@@ -26,11 +26,11 @@ public function up()
      */
     public function down()
     {
-        Schema::table('tasks', function (Blueprint $table) {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->dropColumn('notification_phone_number');
         });
 
-        Schema::table('tasks', function (Blueprint $table) {
+        Schema::table(config('totem.table_prefix').'tasks', function (Blueprint $table) {
             $table->dropColumn('notification_slack_webhook');
         });
     }

src/Frequency.php

@@ -3,9 +3,8 @@
 namespace Studio\Totem;
 
 use Studio\Totem\Traits\HasParameters;
-use Illuminate\Database\Eloquent\Model;
 
-class Frequency extends Model
+class Frequency extends TotemModel
 {
     use HasParameters;
 

src/Parameter.php

@@ -2,9 +2,7 @@
 
 namespace Studio\Totem;
 
-use Illuminate\Database\Eloquent\Model;
-
-class Parameter extends Model
+class Parameter extends TotemModel
 {
     protected $table = 'frequency_parameters';
 

src/Result.php

@@ -2,9 +2,7 @@
 
 namespace Studio\Totem;
 
-use Illuminate\Database\Eloquent\Model;
-
-class Result extends Model
+class Result extends TotemModel
 {
     protected $table = 'task_results';
 

src/Task.php

@@ -3,11 +3,10 @@
 namespace Studio\Totem;
 
 use Cron\CronExpression;
-use Illuminate\Database\Eloquent\Model;
 use Studio\Totem\Traits\HasFrequencies;
 use Illuminate\Notifications\Notifiable;
 
-class Task extends Model
+class Task extends TotemModel
 {
     use Notifiable, HasFrequencies;
 

src/TotemModel.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Studio\Totem;
+
+use Illuminate\Database\Eloquent\Model;
+
+class TotemModel extends Model
+{
+    /**
+     * @return mixed
+     */
+    public function getTable()
+    {
+        return config('totem.table_prefix').parent::getTable();
+    }
+}