UpdatesForVersion50::updateCustomersTable() - Code Metrics - Inspection of "Updated Customers Table and env example" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5 ( 622739...63b662 )

by Ron

created 2019-12-12 01:20 UTC

UpdatesForVersion50::updateCustomersTable() A

↳ Parent: UpdatesForVersion50

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	8
rs	10
c	0
b	0
f	0

<?php

use App\User;
use App\TechTips;
use App\Customers;
use App\FileLinks;
use Carbon\Carbon;
use App\TechTipFiles;
use App\FileLinkFiles;
use App\TechTipSystems;
use App\PhoneNumberTypes;
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class UpdatesForVersion50 extends Migration
{
    /**
     * Database changes for version 5.0
     *
     * @return void
     */
    public function up()
    {
        //  See the function itself for a description of the database changes
        //  DB Adds
        $this->addSoftDeleteToUsers();
        $this->addSoftDeleteToCustomerSystems();
        $this->addSoftDeleteToTechTips();
        $this->addPasswordExpiresColumn();
        $this->addHiddenColumn();
        $this->addColumnsToFileLinksTable();
        $this->addNotesColumnToFileLinkFiles();

        //  DB Modifications
        $this->updatePhoneIcons();
        $this->modifySystemDataTableNames();
        $this->migrateSystemDocumentation();
        $this->migrateUserRoles();
        $this->updateCustomersTable();

        //  Remove Unneeded Tables
        $this->removeNavBarView();
        $this->removeUserRolesTables();
        $this->removeFileLinkInstructionsTable();
        $this->removeFileLinkNotesTable();
        $this->removeSystemFilesTables();
        $this->removeActiveFromCustomers();

    }

    /**
     * Reverse the migrations.
     *
     * @return void
     */
    public function down()
    {
        return 'Unable to Process.  Please Downgrade app and load backup.';
    }

    /*
    *   Database Modifications
    */
    //  Update the icon class to change from font awesome, to theymify icons
    private function updatePhoneIcons()
    {
        $newIcons = [
            ['description' => 'Home',   'icon_class' => 'ti-home'],
            ['description' => 'Work',   'icon_class' => 'ti-briefcase'],
            ['description' => 'Mobile', 'icon_class' => 'ti-mobile'],
        ];

        foreach($newIcons as $new)
        {
            PhoneNumberTypes::where('description', $new['description'])->update(['icon_class' => $new['icon_class']]);
        }
    }

    /*
    *   New Columns and Tables
    */
    //  Added the ability to set an expiration date for user passwords - will force them to change after this expires
    private function addPasswordExpiresColumn()
    {
        if(!Schema::hasColumn('users', 'password_expires')) {
            Schema::table('users', function(Blueprint $table) {
                $table->timestamp('password_expires')
                    ->nullable()
                    ->after('active');
            });
        }
    }

    //  Add the is installer column to the users table
    private function migrateUserRoles()
    {
        if(Schema::hasTable('user_role'))
        {
            if(!Schema::hasColumn('users', 'role_id'))
            {
                Schema::table('users', function (Blueprint $table) {
                    $table->integer('role_id')->after('user_id')->unsigned()->default(4);
                    $table->foreign('role_id')->references('role_id')->on('user_role_descriptions')->onUpdate('cascade');
                });
            }

            $roleData = DB::select('SELECT * FROM `user_role`');

            foreach($roleData as $data)
            {
                User::where('user_id', $data->user_id)->update([
                    'role_id' => $data->role_id,
                ]);
            }
        }
    }

    //  Added a 'hidden' attribute to system customer data types to allow passwords to not be viewed unless clicked or focus
    private function addHiddenColumn()
    {
        if(!Schema::hasColumn('system_data_field_types', 'hidden')) {
            Schema::table('system_cust_data_types', function(Blueprint $table) {
                $table->boolean('hidden')
                    ->default(0)
                    ->after('name');
            });
        }
    }

    //  Update the File links table - add cust_id and note column
    private function addColumnsToFileLinksTable()
    {
        if(!Schema::hasColumn('file_links', 'cust_id')) {
            Schema::table('file_links', function(Blueprint $table) {
                $table->integer('cust_id')
                    ->unsigned()
                    ->nullable()
                    ->after('user_id');
                $table->foreign('cust_id')->references('cust_id')->on('customers')->onUpdate('cascade')->onDelete('cascade');
            });
        }
        if(!Schema::hasColumn('file_links', 'note')) {
            Schema::table('file_links', function(Blueprint $table) {
                $table->longText('note')
                    ->nullable()
                    ->after('link_name');
            });
            //  Migrate the instructions from the old table to the new column
            $instructions = DB::select('SELECT * FROM `file_link_instructions`');
            foreach($instructions as $ins) {
                FileLinks::find($ins->link_id)->update([
                    'note' => $ins->instruction
                ]);
            }
        }
    }

    //  Add Notes column to the file links files table
    private function addNotesColumnToFileLinkFiles()
    {
        if(!Schema::hasColumn('file_link_files', 'note')) {
            Schema::table('file_link_files', function(Blueprint $table) {
                $table->longText('note')
                    ->nullable()
                    ->after('upload');
            });
            //  Migrate the existing notes to the new table
            $notes = DB::select('SELECT * FROM `file_link_notes`');
            foreach($notes as $note) {
                FileLinkFiles::where('file_id', $note->file_id)->update([
                    'note' => $note->note
                ]);
            }
        }
    }

    //  Add the documentation column to the tech tips table
    private function migrateSystemDocumentation()
    {
        if(!Schema::hasColumn('tech_tips', 'tip_type_id')) {
            Schema::table('tech_tips', function(Blueprint $table) {
                $table->bigInteger('tip_type_id')->unsigned()->after('public')->default(1);
                $table->foreign('tip_type_id')->references('tip_type_id')->on('tech_tip_types')->onUpdate('cascade');
            });

            //  Move all of the system files over to the tech tips table
            $sysFiles = DB::select('SELECT * FROM `system_files`');
            foreach($sysFiles as $sysFile) {
                $newTip = TechTips::create([
                    'user_id'       => $sysFile->user_id,
                    'public'        => 0,
                    'tip_type_id'   => 2,
                    'subject'       => $sysFile->name,
                    'description'   => empty($sysFile->description) ? $sysFile->name : $sysFile->description,
                    'created_at'    => $sysFile->created_at,
                    'updated_at'    => $sysFile->updated_at
                ]);

                $tipId = $newTip->tip_id;
                TechTipFiles::create([
                    'tip_id'  => $tipId,
                    'file_id' => $sysFile->file_id
                ]);
                TechTipSystems::create([
                    'tip_id' => $tipId,
                    'sys_id' => $sysFile->sys_id
                ]);
            }
        }
    }

    /*
    *   Database Cleanup
    */
    //  Remove the NavBar view if it exists - We no longer need it to sort out the system types
    private function removeNavBarView()
    {
        DB::statement('DROP VIEW IF EXISTS `navbar_view`');
    }

    //  Remove the active column from the customers table
    private function removeActiveFromCustomers()
    {
        if(Schema::hasColumn('customers', 'active'))
        {
            //  Migrate the existing disabled customers first
            $deactivatedCustomers = Customers::where('active', 0)->get();
            foreach($deactivatedCustomers as $cust)
            {
                Customers::find($cust->cust_id)->delete();
            }

            Schema::table('customers', function(Blueprint $table) {
                $table->dropColumn('active');
            });
        }
    }

    //  Remove the user roles tables
    private function removeUserRolesTables()
    {
        if(Schema::hasTable('user_role'))
        {
            Schema::table('user_role', function(Blueprint $table) {
                $table->dropForeign(['user_id']);
                $table->dropForeign(['role_id']);
            });
            Schema::dropIfExists('user_role');
            Schema::dropIfExists('roles');
        }
    }

    //  Remove the File Link Instructions Table
    private function removeFileLinkInstructionsTable()
    {
        if(Schema::hasTable('file_link_instructions'))
        {
            //  Remove the foreign key to allow for dropping the table
            Schema::table('file_link_instructions', function(Blueprint $table) {
                $table->dropForeign(['link_id']);
            });
            Schema::dropIfExists('file_link_instructions');
        }
    }

    //  Remove the file link files note table
    private function removeFileLinkNotesTable()
    {
        if(Schema::hasTable('file_link_notes'))
        {
            Schema::table('file_link_notes', function(Blueprint $table) {
                $table->dropForeign(['link_id']);
                $table->dropForeign(['file_id']);
            });
            Schema::dropIfExists('file_link_notes');
        }
    }

    //  Remove the system files and system file types table
    private function removeSystemFilesTables()
    {
        if(Schema::hasTable('system_files')) {
            Schema::table('system_files', function(Blueprint $table) {
                $table->dropForeign(['sys_id']);
                $table->dropForeign(['type_id']);
                $table->dropForeign(['file_id']);
                $table->dropForeign(['user_id']);
            });
            Schema::dropIfExists('system_files');
            Schema::dropIfExists('system_file_types');
        }
    }

    //  Rename the tables that hold customer system information to make more sense
    private function modifySystemDataTableNames()
    {
        if(Schema::hasTable('customer_system_fields'))
        {
            Schema::dropIfExists('customer_system_data');
            Schema::rename('customer_system_fields', 'customer_system_data');
        }
        if(Schema::hasTable('system_cust_data_fields'))
        {
            Schema::dropIfExists('system_data_fields');
            Schema::rename('system_cust_data_fields', 'system_data_fields');
        }
        if(Schema::hasTable('system_cust_data_types'))
        {
            Schema::dropIfExists('system_data_field_types');
            Schema::rename('system_cust_data_types', 'system_data_field_types');
        }
    }

    //  Add soft deletes to customer systems table to prevent accidental deletes
    private function addSoftDeleteToCustomerSystems()
    {
        if(!Schema::hasColumn('customer_systems', 'deleted_at'))
        {
            Schema::table('customer_systems', function(Blueprint $table) {
                $table->softDeletes()->after('sys_id');
            });
        }
    }

    //  Add soft deletes to tech tips table to prevent accidental deletes
    private function addSoftDeleteToTechTips()
    {
        if (!Schema::hasColumn('tech_tips', 'deleted_at')) {
            Schema::table('tech_tips', function (Blueprint $table) {
                $table->softDeletes()->after('description');
            });
        }
    }

    //  Swap out the active column for deleted at column on users table
    public function addSoftDeleteToUsers()
    {
        if(!Schema::hasColumn('users', 'deleted_at'))
        {
            Schema::table('users', function(Blueprint $table)
            {
                $table->softDeletes()->after('password_expires');
            });
            //  Migrate over all deactivated users
            DB::update('UPDATE `users` SET `deleted_at` = "'.Carbon::now().'" WHERE `active` = 0');
            //  Remove the Active column
            Schema::table('users', function (Blueprint $table) {
                $table->dropColumn('active');
            });
        }
    }

    //  Add the Parent id column to the customers table
    public function updateCustomersTable()
    {
        if(!Schema::hasColumn('customers', 'parent_id'))
        {
            Schema::table('customers', function(Blueprint $table)
            {
                $table->integer('parent_id')->after('cust_id')->nullable()->unsigned();
                $table->foreign('parent_id')->references('cust_id')->on('customers')->onUpdate('cascade');
            });
        }
    }
}


1			<?php
2
3			use App\User;
4			use App\TechTips;
5			use App\Customers;
6			use App\FileLinks;
7			use Carbon\Carbon;
8			use App\TechTipFiles;
9			use App\FileLinkFiles;
10			use App\TechTipSystems;
11			use App\PhoneNumberTypes;
12			use Illuminate\Support\Facades\Schema;
13			use Illuminate\Database\Schema\Blueprint;
14			use Illuminate\Database\Migrations\Migration;
15
16			class UpdatesForVersion50 extends Migration
17			{
18			/**
19			* Database changes for version 5.0
20			*
21			* @return void
22			*/
23			public function up()
24			{
25			// See the function itself for a description of the database changes
26			// DB Adds
27			$this->addSoftDeleteToUsers();
28			$this->addSoftDeleteToCustomerSystems();
29			$this->addSoftDeleteToTechTips();
30			$this->addPasswordExpiresColumn();
31			$this->addHiddenColumn();
32			$this->addColumnsToFileLinksTable();
33			$this->addNotesColumnToFileLinkFiles();
34
35			// DB Modifications
36			$this->updatePhoneIcons();
37			$this->modifySystemDataTableNames();
38			$this->migrateSystemDocumentation();
39			$this->migrateUserRoles();
40			$this->updateCustomersTable();
41
42			// Remove Unneeded Tables
43			$this->removeNavBarView();
44			$this->removeUserRolesTables();
45			$this->removeFileLinkInstructionsTable();
46			$this->removeFileLinkNotesTable();
47			$this->removeSystemFilesTables();
48			$this->removeActiveFromCustomers();
49
50			}
51
52			/**
53			* Reverse the migrations.
54			*
55			* @return void
56			*/
57			public function down()
58			{
59			return 'Unable to Process. Please Downgrade app and load backup.';
60			}
61
62			/*
63			* Database Modifications
64			*/
65			// Update the icon class to change from font awesome, to theymify icons
66			private function updatePhoneIcons()
67			{
68			$newIcons = [
69			['description' => 'Home', 'icon_class' => 'ti-home'],
70			['description' => 'Work', 'icon_class' => 'ti-briefcase'],
71			['description' => 'Mobile', 'icon_class' => 'ti-mobile'],
72			];
73
74			foreach($newIcons as $new)
75			{
76			PhoneNumberTypes::where('description', $new['description'])->update(['icon_class' => $new['icon_class']]);
77			}
78			}
79
80			/*
81			* New Columns and Tables
82			*/
83			// Added the ability to set an expiration date for user passwords - will force them to change after this expires
84			private function addPasswordExpiresColumn()
85			{
86			if(!Schema::hasColumn('users', 'password_expires')) {
87			Schema::table('users', function(Blueprint $table) {
88			$table->timestamp('password_expires')
89			->nullable()
90			->after('active');
91			});
92			}
93			}
94
95			// Add the is installer column to the users table
96			private function migrateUserRoles()
97			{
98			if(Schema::hasTable('user_role'))
99			{
100			if(!Schema::hasColumn('users', 'role_id'))
101			{
102			Schema::table('users', function (Blueprint $table) {
103			$table->integer('role_id')->after('user_id')->unsigned()->default(4);
104			$table->foreign('role_id')->references('role_id')->on('user_role_descriptions')->onUpdate('cascade');
105			});
106			}
107
108			$roleData = DB::select('SELECT * FROM `user_role`');
109
110			foreach($roleData as $data)
111			{
112			User::where('user_id', $data->user_id)->update([
113			'role_id' => $data->role_id,
114			]);
115			}
116			}
117			}
118
119			// Added a 'hidden' attribute to system customer data types to allow passwords to not be viewed unless clicked or focus
120			private function addHiddenColumn()
121			{
122			if(!Schema::hasColumn('system_data_field_types', 'hidden')) {
123			Schema::table('system_cust_data_types', function(Blueprint $table) {
124			$table->boolean('hidden')
125			->default(0)
126			->after('name');
127			});
128			}
129			}
130
131			// Update the File links table - add cust_id and note column
132			private function addColumnsToFileLinksTable()
133			{
134			if(!Schema::hasColumn('file_links', 'cust_id')) {
135			Schema::table('file_links', function(Blueprint $table) {
136			$table->integer('cust_id')
137			->unsigned()
138			->nullable()
139			->after('user_id');
140			$table->foreign('cust_id')->references('cust_id')->on('customers')->onUpdate('cascade')->onDelete('cascade');
141			});
142			}
143			if(!Schema::hasColumn('file_links', 'note')) {
144			Schema::table('file_links', function(Blueprint $table) {
145			$table->longText('note')
146			->nullable()
147			->after('link_name');
148			});
149			// Migrate the instructions from the old table to the new column
150			$instructions = DB::select('SELECT * FROM `file_link_instructions`');
151			foreach($instructions as $ins) {
152			FileLinks::find($ins->link_id)->update([
153			'note' => $ins->instruction
154			]);
155			}
156			}
157			}
158
159			// Add Notes column to the file links files table
160			private function addNotesColumnToFileLinkFiles()
161			{
162			if(!Schema::hasColumn('file_link_files', 'note')) {
163			Schema::table('file_link_files', function(Blueprint $table) {
164			$table->longText('note')
165			->nullable()
166			->after('upload');
167			});
168			// Migrate the existing notes to the new table
169			$notes = DB::select('SELECT * FROM `file_link_notes`');
170			foreach($notes as $note) {
171			FileLinkFiles::where('file_id', $note->file_id)->update([
172			'note' => $note->note
173			]);
174			}
175			}
176			}
177
178			// Add the documentation column to the tech tips table
179			private function migrateSystemDocumentation()
180			{
181			if(!Schema::hasColumn('tech_tips', 'tip_type_id')) {
182			Schema::table('tech_tips', function(Blueprint $table) {
183			$table->bigInteger('tip_type_id')->unsigned()->after('public')->default(1);
184			$table->foreign('tip_type_id')->references('tip_type_id')->on('tech_tip_types')->onUpdate('cascade');
185			});
186
187			// Move all of the system files over to the tech tips table
188			$sysFiles = DB::select('SELECT * FROM `system_files`');
189			foreach($sysFiles as $sysFile) {
190			$newTip = TechTips::create([
191			'user_id' => $sysFile->user_id,
192			'public' => 0,
193			'tip_type_id' => 2,
194			'subject' => $sysFile->name,
195			'description' => empty($sysFile->description) ? $sysFile->name : $sysFile->description,
196			'created_at' => $sysFile->created_at,
197			'updated_at' => $sysFile->updated_at
198			]);
199
200			$tipId = $newTip->tip_id;
201			TechTipFiles::create([
202			'tip_id' => $tipId,
203			'file_id' => $sysFile->file_id
204			]);
205			TechTipSystems::create([
206			'tip_id' => $tipId,
207			'sys_id' => $sysFile->sys_id
208			]);
209			}
210			}
211			}
212
213			/*
214			* Database Cleanup
215			*/
216			// Remove the NavBar view if it exists - We no longer need it to sort out the system types
217			private function removeNavBarView()
218			{
219			DB::statement('DROP VIEW IF EXISTS `navbar_view`');
220			}
221
222			// Remove the active column from the customers table
223			private function removeActiveFromCustomers()
224			{
225			if(Schema::hasColumn('customers', 'active'))
226			{
227			// Migrate the existing disabled customers first
228			$deactivatedCustomers = Customers::where('active', 0)->get();
229			foreach($deactivatedCustomers as $cust)
230			{
231			Customers::find($cust->cust_id)->delete();
232			}
233
234			Schema::table('customers', function(Blueprint $table) {
235			$table->dropColumn('active');
236			});
237			}
238			}
239
240			// Remove the user roles tables
241			private function removeUserRolesTables()
242			{
243			if(Schema::hasTable('user_role'))
244			{
245			Schema::table('user_role', function(Blueprint $table) {
246			$table->dropForeign(['user_id']);
247			$table->dropForeign(['role_id']);
248			});
249			Schema::dropIfExists('user_role');
250			Schema::dropIfExists('roles');
251			}
252			}
253
254			// Remove the File Link Instructions Table
255			private function removeFileLinkInstructionsTable()
256			{
257			if(Schema::hasTable('file_link_instructions'))
258			{
259			// Remove the foreign key to allow for dropping the table
260			Schema::table('file_link_instructions', function(Blueprint $table) {
261			$table->dropForeign(['link_id']);
262			});
263			Schema::dropIfExists('file_link_instructions');
264			}
265			}
266
267			// Remove the file link files note table
268			private function removeFileLinkNotesTable()
269			{
270			if(Schema::hasTable('file_link_notes'))
271			{
272			Schema::table('file_link_notes', function(Blueprint $table) {
273			$table->dropForeign(['link_id']);
274			$table->dropForeign(['file_id']);
275			});
276			Schema::dropIfExists('file_link_notes');
277			}
278			}
279
280			// Remove the system files and system file types table
281			private function removeSystemFilesTables()
282			{
283			if(Schema::hasTable('system_files')) {
284			Schema::table('system_files', function(Blueprint $table) {
285			$table->dropForeign(['sys_id']);
286			$table->dropForeign(['type_id']);
287			$table->dropForeign(['file_id']);
288			$table->dropForeign(['user_id']);
289			});
290			Schema::dropIfExists('system_files');
291			Schema::dropIfExists('system_file_types');
292			}
293			}
294
295			// Rename the tables that hold customer system information to make more sense
296			private function modifySystemDataTableNames()
297			{
298			if(Schema::hasTable('customer_system_fields'))
299			{
300			Schema::dropIfExists('customer_system_data');
301			Schema::rename('customer_system_fields', 'customer_system_data');
302			}
303			if(Schema::hasTable('system_cust_data_fields'))
304			{
305			Schema::dropIfExists('system_data_fields');
306			Schema::rename('system_cust_data_fields', 'system_data_fields');
307			}
308			if(Schema::hasTable('system_cust_data_types'))
309			{
310			Schema::dropIfExists('system_data_field_types');
311			Schema::rename('system_cust_data_types', 'system_data_field_types');
312			}
313			}
314
315			// Add soft deletes to customer systems table to prevent accidental deletes
316			private function addSoftDeleteToCustomerSystems()
317			{
318			if(!Schema::hasColumn('customer_systems', 'deleted_at'))
319			{
320			Schema::table('customer_systems', function(Blueprint $table) {
321			$table->softDeletes()->after('sys_id');
322			});
323			}
324			}
325
326			// Add soft deletes to tech tips table to prevent accidental deletes
327			private function addSoftDeleteToTechTips()
328			{
329			if (!Schema::hasColumn('tech_tips', 'deleted_at')) {
330			Schema::table('tech_tips', function (Blueprint $table) {
331			$table->softDeletes()->after('description');
332			});
333			}
334			}
335
336			// Swap out the active column for deleted at column on users table
337			public function addSoftDeleteToUsers()
338			{
339			if(!Schema::hasColumn('users', 'deleted_at'))
340			{
341			Schema::table('users', function(Blueprint $table)
342			{
343			$table->softDeletes()->after('password_expires');
344			});
345			// Migrate over all deactivated users
346			DB::update('UPDATE `users` SET `deleted_at` = "'.Carbon::now().'" WHERE `active` = 0');
347			// Remove the Active column
348			Schema::table('users', function (Blueprint $table) {
349			$table->dropColumn('active');
350			});
351			}
352			}
353
354			// Add the Parent id column to the customers table
355			public function updateCustomersTable()
356			{
357			if(!Schema::hasColumn('customers', 'parent_id'))
358			{
359			Schema::table('customers', function(Blueprint $table)
360			{
361			$table->integer('parent_id')->after('cust_id')->nullable()->unsigned();
362			$table->foreign('parent_id')->references('cust_id')->on('customers')->onUpdate('cascade');
363			});
364			}
365			}
366			}
367

butcherman / Tech_Bench

Push — dev5 ( 622739...63b662 )

UpdatesForVersion50::updateCustomersTable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like