Completed
Push — master ( a28ed9...a15f20 )
by Angus
09:34
created

MY_Migration::_insert_batch()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 3
nc 1
nop 3
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php declare(strict_types=1);  defined('BASEPATH') OR exit('No direct script access allowed');
2
3
class MY_Migration extends CI_Migration {
4
	public function __construct() {
5
		parent::__construct();
0 ignored issues
show
Bug introduced by
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: MY_Migration, Migration_Auth_add_apikey, Migration_Favourites_Rework, Migration_Favourites_Rework_Revert, Migration_Install_ion_auth, Migration_Setup_Favourites, Migration_Setup_Notices, 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_Custom, 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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. 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
	}
7
8
	/**
9
	 * Insert batch statement
10
	 *
11
	 * Generates a platform-specific insert string from the supplied data.
12
	 *
13
	 * @param	string	$table	Table name
14
	 * @param	array	$keys	INSERT keys
15
	 * @param	array	$values	INSERT values
16
	 * @return	string
17
	 */
18
	protected function _insert_batch($table, $keys, $values) {
19
		$value_string = str_replace("'DEFAULT'", 'DEFAULT', implode(', ', $values));
20
		return 'INSERT INTO '.$table.' ('.implode(', ', $keys).') VALUES '.$value_string;
21
	}
22
}
23