Migration_Favourites_Rework_Revert::__construct() - Code Metrics - Inspection of "reverted favourites rework & made it so favourited..." - DakuTree/manga-tracker - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6524bd...3580eb )

by Angus

created 2017-02-23 10:37 UTC

Migration_Favourites_Rework_Revert::__construct() A

↳ Parent: Migration_Favourites_Rework_Revert

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php defined('BASEPATH') OR exit('No direct script access allowed');

class Migration_Favourites_Rework_Revert extends CI_Migration {
	public function __construct() {
		parent::__construct();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		$this->load->dbforge();
	}

	public function up() {
		$this->dbforge->add_field(array(
			'id' => array(
				'type'           => 'MEDIUMINT',
				'constraint'     => '8',
				'unsigned'       => TRUE,
				'auto_increment' => TRUE
			),
			'chapter_id' => array(
				'type'           => 'MEDIUMINT',
				'constraint'     => '8',
				'unsigned'       => TRUE
				//FOREIGN KEY
			),

			'chapter' => array(
				'type'       => 'VARCHAR',
				'constraint' => '255',
				'null'       => FALSE
			),

			'updated_at' => array(
				//Despite not actually creating the field here (it's instead done below), we still need this here so a key can be created properly.
			//	'type'    => 'TIMESTAMP',
			//	'null'    => FALSE,
			//	'on_update' => FALSE
			)
		));
		$this->dbforge->add_field('updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP'); //CI is annoying and auto-appends ON UPDATE which we don't want.
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		$this->dbforge->add_key('id', TRUE);
		$this->dbforge->add_key('chapter_id');
		$this->dbforge->add_key('updated_at');
		$this->dbforge->create_table('tracker_favourites_new');

		//We need to add data from the old favourites table
		$query = $this->db->select('
		tf.id AS id,
		tc.id AS chapter_id,
		tf.chapter AS chapter,
		tf.updated_at AS updated_at')
		                  ->from('tracker_favourites AS tf')
		                  //NOTE: This may break, but we'll be only running this once on a live site so it can sort itself out.
		                  ->join('tracker_chapters AS tc', 'tf.user_id = tc.user_id AND tf.title_id = tc.title_id', 'left')
		                  ->order_by('tf.id ASC')
		                  ->get();
		if($data = $query->result_array()) {
			$this->db->insert_batch('tracker_favourites_new', $data);
		}

		//Rename the old DB
		$this->dbforge->rename_table('tracker_favourites', 'tracker_favourites_old');

		//Rename the new one to old name
		$this->dbforge->rename_table('tracker_favourites_new', 'tracker_favourites');


		/*** Unique/Foreign Keys ***/
		//For whatever reason, dbforge lacks a unique/foreign key function.
		$this->db->query('ALTER TABLE `tracker_favourites` ADD UNIQUE(`chapter_id`, `chapter`);');

		$this->db->query('
			ALTER TABLE `tracker_favourites`
				ADD CONSTRAINT `FK_tracker_favourites_tracker_chapters` FOREIGN KEY (`chapter_id`) REFERENCES `tracker_chapters` (`id`) ON UPDATE NO ACTION ON DELETE NO ACTION;'
		);

		//Remove old DB
		$this->dbforge->drop_table('tracker_favourites_old');
	}

	public function down() {
		//There's no going back.
	}
}


1			<?php defined('BASEPATH') OR exit('No direct script access allowed');
2
3			class Migration_Favourites_Rework_Revert extends CI_Migration {
4			public function __construct() {
5			parent::__construct();
			0 ignored issues – show Bug introduced 2017-02-23 10:50 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `CI_Migration` as the method `__construct()` does only exist in the following sub-classes of `CI_Migration`: `Migration_Auth_add_apikey`, `Migration_Favourites_Rework`, `Migration_Favourites_Rework_Revert`, `Migration_Install_ion_auth`, `Migration_Setup_Favourites`, `Migration_Setup_Rate_Limit`, `Migration_Setup_Sessions`, `Migration_Setup_Signup_Verification`, `Migration_Setup_Title_History`, `Migration_Setup_Tracker`, `Migration_Setup_User_History`, `Migration_Setup_User_Options`, `Migration_Tracker_Add_Active`, `Migration_Tracker_Add_Site_Status`, `Migration_Tracker_Add_Title_Status`, `Migration_Tracker_add_category`, `Migration_Tracker_add_complete`, `Migration_Tracker_add_last_checked`, `Migration_Tracker_add_tags`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
6			$this->load->dbforge();
7			}
8
9			public function up() {
10			$this->dbforge->add_field(array(
11			'id' => array(
12			'type' => 'MEDIUMINT',
13			'constraint' => '8',
14			'unsigned' => TRUE,
15			'auto_increment' => TRUE
16			),
17			'chapter_id' => array(
18			'type' => 'MEDIUMINT',
19			'constraint' => '8',
20			'unsigned' => TRUE
21			//FOREIGN KEY
22			),
23
24			'chapter' => array(
25			'type' => 'VARCHAR',
26			'constraint' => '255',
27			'null' => FALSE
28			),
29
30			'updated_at' => array(
31			//Despite not actually creating the field here (it's instead done below), we still need this here so a key can be created properly.
32			// 'type' => 'TIMESTAMP',
33			// 'null' => FALSE,
34			// 'on_update' => FALSE
35			)
36			));
37			$this->dbforge->add_field('updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP'); //CI is annoying and auto-appends ON UPDATE which we don't want.
			0 ignored issues – show Documentation introduced 2017-02-23 10:50 UTC by Report Bug Copy Issue Report `'updated_at TIMESTAMP NO...AULT CURRENT_TIMESTAMP'` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
38			$this->dbforge->add_key('id', TRUE);
39			$this->dbforge->add_key('chapter_id');
40			$this->dbforge->add_key('updated_at');
41			$this->dbforge->create_table('tracker_favourites_new');
42
43			//We need to add data from the old favourites table
44			$query = $this->db->select('
45			tf.id AS id,
46			tc.id AS chapter_id,
47			tf.chapter AS chapter,
48			tf.updated_at AS updated_at')
49			->from('tracker_favourites AS tf')
50			//NOTE: This may break, but we'll be only running this once on a live site so it can sort itself out.
51			->join('tracker_chapters AS tc', 'tf.user_id = tc.user_id AND tf.title_id = tc.title_id', 'left')
52			->order_by('tf.id ASC')
53			->get();
54			if($data = $query->result_array()) {
55			$this->db->insert_batch('tracker_favourites_new', $data);
56			}
57
58			//Rename the old DB
59			$this->dbforge->rename_table('tracker_favourites', 'tracker_favourites_old');
60
61			//Rename the new one to old name
62			$this->dbforge->rename_table('tracker_favourites_new', 'tracker_favourites');
63
64
65			/* Unique/Foreign Keys */
66			//For whatever reason, dbforge lacks a unique/foreign key function.
67			$this->db->query('ALTER TABLE `tracker_favourites` ADD UNIQUE(`chapter_id`, `chapter`);');
68
69			$this->db->query('
70			ALTER TABLE `tracker_favourites`
71			ADD CONSTRAINT `FK_tracker_favourites_tracker_chapters` FOREIGN KEY (`chapter_id`) REFERENCES `tracker_chapters` (`id`) ON UPDATE NO ACTION ON DELETE NO ACTION;'
72			);
73
74			//Remove old DB
75			$this->dbforge->drop_table('tracker_favourites_old');
76			}
77
78			public function down() {
79			//There's no going back.
80			}
81			}
82

DakuTree / manga-tracker

Push — master ( 6524bd...3580eb )

Migration_Favourites_Rework_Revert::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like