UpdatesForVersion50::addNotesColumnToFileLinkFiles() - Code Metrics - Inspection of "Updated Customer Systems" - butcherman/Tech_Bench - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — dev5 ( e66ef8...5a922b )

by Ron

created 2019-11-20 03:35 UTC

addNotesColumnToFileLinkFiles() A

↳ Parent: UpdatesForVersion50

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	9
nc	3
nop	0
dl	0
loc	13
c	0
b	0
f	0
cc	3
rs	9.9666

<?php

use App\User;
use App\TechTips;
use App\Customers;
use App\FileLinks;
use App\TechTipFiles;
use App\FileLinkFiles;
use App\TechTipSystems;
use App\UserPermissions;
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 Modifications
        $this->updatePhoneIcons();
        $this->modifySystemDataTableNames();
        $this->addSoftDeleteToCustomerSystems();

        //  DB Adds
        $this->addPasswordExpiresColumn();
        $this->addIsInstallerToUsers();
        $this->addHiddenColumn();
        $this->addColumnsToFileLinksTable();
        $this->addNotesColumnToFileLinkFiles();
        $this->addDocumentationColumnToTechTips();

        //  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()
    {
        PhoneNumberTypes::find(1)->update(
            [
                'icon_class' => 'ti-home'
            ]
        );
        PhoneNumberTypes::find(2)->update(
            [
                'icon_class' => 'ti-briefcase'
            ]
        );
        PhoneNumberTypes::find(3)->update(
            [
                'icon_class' => 'ti-mobile'
            ]
        );
    }

    /*
    *   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 addIsInstallerToUsers()
    {
        if (!Schema::hasColumn('users', 'is_installer')) {
            Schema::table('users', function (Blueprint $table) {
                $table->boolean('is_installer')->default(0)->after('active');
            });

            //  TODO - Clean this up, it does not work
            //  Migrate user roles from the 'user roles' table to the new 'user permissions' table
            if (Schema::hasTable('user_permissions') && (UserPermissions::all()->isEmpty())) {
                $userRoles = DB::select('SELECT * FROM `user_role` LEFT JOIN `roles` ON `user_role`.`role_id` = `roles`.`role_id`');

                foreach ($userRoles as $user) {
                    if ($user->name === 'Installer') {
                        User::find($user->user_id)->update(
                            [
                                'is_installer' => 1
                            ]
                        );
                        UserPermissions::create(
                            [
                                'user_id'             => $user->user_id,
                                'manage_users'        => 1,
                                'run_reports'         => 1,
                                'add_customer'        => 1,
                                'deactivate_customer' => 1,
                                'use_file_links'      => 1,
                                'create_tech_tip'     => 1,
                                'edit_tech_tip'       => 1,
                                'delete_tech_tip'     => 1,
                                'create_category'     => 1,
                                'modify_category'     => 1
                            ]
                        );
                    } else if ($user->name === 'Admin') {
                        UserPermissions::create(
                            [
                                'user_id'             => $user->user_id,
                                'manage_users'        => 1,
                                'run_reports'         => 1,
                                'add_customer'        => 1,
                                'deactivate_customer' => 1,
                                'use_file_links'      => 1,
                                'create_tech_tip'     => 1,
                                'edit_tech_tip'       => 1,
                                'delete_tech_tip'     => 1,
                                'create_category'     => 1,
                                'modify_category'     => 1
                            ]
                        );
                    } else if ($user->name === 'Report') {
                        UserPermissions::create(
                            [
                                'user_id'             => $user->user_id,
                                'manage_users'        => 0,
                                'run_reports'         => 1,
                                'add_customer'        => 1,
                                'deactivate_customer' => 0,
                                'use_file_links'      => 1,
                                'create_tech_tip'     => 1,
                                'edit_tech_tip'       => 0,
                                'delete_tech_tip'     => 0,
                                'create_category'     => 0,
                                'modify_category'     => 0
                            ]
                        );
                    } else {
                        UserPermissions::create(
                            [
                                'user_id'             => $user->user_id,
                                'manage_users'        => 0,
                                'run_reports'         => 0,
                                'add_customer'        => 1,
                                'deactivate_customer' => 0,
                                'use_file_links'      => 1,
                                'create_tech_tip'     => 1,
                                'edit_tech_tip'       => 0,
                                'delete_tech_tip'     => 0,
                                'create_category'     => 0,
                                'modify_category'     => 0
                            ]
                        );
                    }
                }
            }
        }
    }

    //  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 addDocumentationColumnToTechTips()
    {
        if (!Schema::hasColumn('tech_tips', 'documentation')) {
            Schema::table('tech_tips', function (Blueprint $table) {
                $table->boolean('documentation')->default(0)->nullable()->after('public');
            });

            //  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,
                    'documentation' => 1,
                    '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
            $deactiveatedCustomers = Customers::where('active', 0);
            foreach($deactiveatedCustomers as $cust)
            {
                //  TODO:  why is this not firing????
                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');
            });
        }
    }
}


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

butcherman / Tech_Bench

Push — dev5 ( e66ef8...5a922b )

addNotesColumnToFileLinkFiles() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like