Base - Code Metrics - Inspection of "Merge pull request #2590 from RaJiska/master" - MPOS/php-mpos - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — development ( 86ad30...7b6aa4 )

by Sebastian

created 2017-08-29 19:18 UTC

Base C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	289
Duplicated Lines	3.46 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

Metric	Value
wmc	70
lcom	2
cbo	0
dl	10
loc	289
rs	5.6163
c	0
b	0
f	0

41 Methods

Rating	Name	Duplication	Size	Complexity
A	getTableName()	0	3	1
A	setDebug()	0	3	1
A	setCoin()	0	3	1
A	setCoinAddress()	0	3	1
A	setLog()	0	3	1
A	setMysql()	0	3	1
A	setMail()	0	3	1
A	setSalt()	0	3	1
A	setSalty()	0	3	1
A	setSmarty()	0	3	1
A	setUser()	0	3	1
A	setSessionManager()	0	3	1
A	setConfig()	0	3	1
A	setErrorCodes()	0	3	1
A	setToken()	0	3	1
A	setBlock()	0	3	1
A	setPayout()	0	3	1
A	setNotification()	0	3	1
A	setTransaction()	0	3	1
A	setMemcache()	0	3	1
A	setStatistics()	0	3	1
A	setSetting()	0	3	1
A	setTools()	0	3	1
A	setBitcoin()	0	3	1
A	setTokenType()	0	3	1
A	setCSRFToken()	0	3	1
A	setShare()	0	3	1
A	setErrorMessage()	0	5	1
A	setCronMessage()	0	4	1
A	getError()	0	3	1
A	getCronError()	0	3	1
B	getErrorMsg()	0	16	5
A	getCount()	0	7	4
B	getCountFiltered()	0	7	5
A	getAllAssoc()	7	7	4
B	getSingleAssoc()	0	7	5
A	getSingle()	0	16	3
A	checkStmt()	0	6	2
A	sqlError()	0	12	2
B	updateSingle()	0	9	5
A	addParam()	0	4	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Base often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Base, and based on these observations, apply Extract Interface, too.

<?php

$defflip = (!cfip()) ? exit(header('HTTP/1.1 401 Unauthorized')) : 1;

/**
 * Our base class that we extend our other classes from
 *
 * It supplies some basic features as cross-linking with other classes
 * after loading a newly created class.
 **/
class Base {
namespace YourVendor;

class YourClass { }
  private $sError = '';
  private $sCronError = '';
  protected $table = '';
  private $values = array(), $types = ''; 


  public function getTableName() {
    return $this->table;
  }
  
  protected $debug;
  public function setDebug($debug) {
    $this->debug = $debug;
  }
  public function setCoin($coin) {
    $this->coin = $coin;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setCoinAddress($coin_address) {
    $this->coin_address = $coin_address;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  
  public $log;
  public function setLog($log) {
    $this->log = $log;
  }
  
  protected $mysqli;
  public function setMysql($mysqli) {
    $this->mysqli = $mysqli;
  }
  public function setMail($mail) {
    $this->mail = $mail;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setSalt($salt) {
    $this->salt = $salt;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setSalty($salt) {
    $this->salty = $salt;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  /**
   * @var Smarty
   */
  var $smarty;
class A {
    var $property;
}
  public function setSmarty($smarty) {
    $this->smarty = $smarty;
  }
  public function setUser($user) {
    $this->user = $user;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setSessionManager($session) {
    $this->session = $session;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setConfig($config) {
    $this->config = $config;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  
  protected $aErrorCodes;
  public function setErrorCodes(&$aErrorCodes) {
    $this->aErrorCodes =& $aErrorCodes;
  }
  public function setToken($token) {
    $this->token = $token;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setBlock($block) {
    $this->block = $block;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setPayout($payout) {
    $this->payout = $payout;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setNotification($notification) {
    $this->notification = $notification;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setTransaction($transaction) {
    $this->transaction = $transaction;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setMemcache($memcache) {
    $this->memcache = $memcache;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setStatistics($statistics) {
    $this->statistics = $statistics;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setSetting($setting) {
    $this->setting = $setting;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setTools($tools) {
    $this->tools = $tools;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setBitcoin($bitcoin) {
    $this->bitcoin = $bitcoin;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setTokenType($tokentype) {
    $this->tokentype = $tokentype;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setCSRFToken($token) {
    $this->CSRFToken = $token;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setShare($share) {
    $this->share = $share;
class MyClass { }

$x = new MyClass();
$x->foo = true;
  }
  public function setErrorMessage($msg) {
    $this->sError = $msg;
    // Default to same error for crons
    $this->sCronError = $msg;
  }
  public function setCronMessage($msg) {
    // Used to overwrite any errors with a custom cron one
    $this->sCronError = $msg;
  }
  public function getError() {
    return $this->sError;
  }
  /**
   * Additional information in error string for cronjobs logging
   **/
  public function getCronError() {
    return $this->sCronError;
  }

  /**
   * Get error message from error code array
   * @param errCode string Error code string
   * @param optional string Optional addtitional error strings to append
   * @retrun string Error Message
   **/
  public function getErrorMsg($errCode='') {
    if (!is_array($this->aErrorCodes)) return 'Error codes not loaded';
    if (!array_key_exists($errCode, $this->aErrorCodes)) return 'Unknown Error Code: ' . $errCode;
    if (func_num_args() > 1) {
      $args = func_get_args();
      array_shift($args);
      $param_count = substr_count($this->aErrorCodes[$errCode], '%s');
      if ($param_count == count($args)) {
        return vsprintf($this->aErrorCodes[$errCode], $args);
      } else {
        return $this->aErrorCodes[$errCode] . ' (missing information to complete string)';
      }
    } else {
      return $this->aErrorCodes[$errCode];
    }
  }

  /**
   * Fetch count of all entries in table
   * @param none
   * @param data mixed Count or false
   **/
  public function getCount() {
    $this->debug->append("STA " . __METHOD__, 4);
    $stmt = $this->mysqli->prepare("SELECT COUNT(id) AS count FROM $this->table");
    if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
      return $result->fetch_object()->count;
    return $this->sqlError();
  }

  /**
   * Fetch count of all entries in table filtered by a column/value
   * @param none
   * @param data mixed Count or false
   **/
  public function getCountFiltered($column='id', $value=NULL, $type='i', $operator = '=') {
    $this->debug->append("STA " . __METHOD__, 4);
    $stmt = $this->mysqli->prepare("SELECT COUNT(id) AS count FROM $this->table WHERE $column $operator ?");
    if ($this->checkStmt($stmt) && $stmt->bind_param($type, $value) && $stmt->execute() && $result = $stmt->get_result())
      return $result->fetch_object()->count;
    return $this->sqlError();
  }

  /**
   * Fetch all entries as an assoc array from a table
   * This should, in general, not be used but sometimes it's just easier
   * @param none
   * @return array Assoc array of all rows found in table
   **/
  public function getAllAssoc() {

    $this->debug->append("STA " . __METHOD__, 4);
    $stmt = $this->mysqli->prepare("SELECT * FROM $this->table");
    if ($this->checkStmt($stmt) && $stmt->execute() && $result = $stmt->get_result())
      return $result->fetch_all(MYSQLI_ASSOC);
    return $this->sqlError();
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
  }

  /**
   * Get a single row as an assoc array
   * @param value string Value to search for
   * @param field string Column to search for
   * @param type string Type of value
   * @return array Resulting row
   **/
  protected function getSingleAssoc($value, $field='id', $type='i') {
    $this->debug->append("STA " . __METHOD__, 4);
    $stmt = $this->mysqli->prepare("SELECT * FROM $this->table WHERE $field = ? LIMIT 1");
    if ($this->checkStmt($stmt) && $stmt->bind_param($type, $value) && $stmt->execute() && $result = $stmt->get_result())
      return $result->fetch_assoc();
    return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
  }

  /**
   * Get a single value from a row matching the query specified
   * @param value string Value to search for
   * @param search Return column to search for
   * @param field string Search column
   * @param type string Type of value
   * @param lower bool try with LOWER comparision
   * @return array Return result
   **/
  protected function getSingle($value, $search='id', $field='id', $type="i", $lower=false) {
    $this->debug->append("STA " . __METHOD__, 4); 
    $sql = "SELECT $search FROM $this->table WHERE";
    $lower ? $sql .= " LOWER($field) = LOWER(?)" : $sql .= " $field = ?";
    $sql .= " LIMIT 1";
    $stmt = $this->mysqli->prepare($sql);
    if ($this->checkStmt($stmt)) {
      $stmt->bind_param($type, $value);
      $stmt->execute();
      $stmt->bind_result($retval);

      $stmt->fetch();
      $stmt->close();
      return $retval;
    }
    return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
  }

  /**
   * Check if the prepared statement is valid
   * @param $bState Statement return value
   * @return bool true or false
   **/
  function checkStmt($bState) {

    $this->debug->append("STA " . __METHOD__, 4);
    if ($bState ===! true)
      return $this->sqlError();
    return true;
  }

  /**
   * Catch SQL errors with this method
   * @param error_code string Error code to read
   **/
  protected function sqlError($error_code='E0020') {
    // More human-readable error for UI
    if (func_num_args() == 0) {
      $this->setErrorMessage($this->getErrorMsg($error_code));
    } else {
      $this->setErrorMessage(call_user_func_array(array($this, 'getErrorMsg'), func_get_args()));
    }
    // Default to SQL error for debug and cron errors
    $this->debug->append($this->getErrorMsg('E0019', $this->mysqli->error));
    $this->setCronMessage($this->getErrorMsg('E0019', $this->mysqli->error));
    return false;
  }

  /**
   * @param userID int Account ID
   * Update a single row in a table
   * @param field string Field to update
   * @return bool
   **/
  protected function updateSingle($id, $field, $table='') {
    if (empty($table)) $table = $this->table;
    $this->debug->append("STA " . __METHOD__, 4);
    $stmt = $this->mysqli->prepare("UPDATE $table SET " . $field['name'] . " = ? WHERE id = ? LIMIT 1");
    if ($this->checkStmt($stmt) && $stmt->bind_param($field['type'].'i', $field['value'], $id) && $stmt->execute())
      return true;
    $this->debug->append("Unable to update " . $field['name'] . " with " . $field['value'] . " for ID $id");
    return $this->sqlError();
  }

  /**
   * We may need to generate our bind_param list
   **/
  public function addParam($type, &$value) {
    $this->values[] = $value;
    $this->types .= $type;
  }
  public function getParam() {
    $array = array_merge(array($this->types), $this->values);
    // Clear the data
    $this->values = NULL;

    $this->types = NULL;
    // See here why we need this: http://stackoverflow.com/questions/16120822/mysqli-bind-param-expected-to-be-a-reference-value-given
    if (strnatcmp(phpversion(),'5.3') >= 0) {
      $refs = array();
      foreach($array as $key => $value)
        $refs[$key] = &$array[$key];
      return $refs;
    }
    return $array;
  }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-22 07:52 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 10 and the first side effect is on line 2. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			$defflip = (!cfip()) ? exit(header('HTTP/1.1 401 Unauthorized')) : 1;
3
4			/**
5			* Our base class that we extend our other classes from
6			*
7			* It supplies some basic features as cross-linking with other classes
8			* after loading a newly created class.
9			**/
10			class Base {
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
11			private $sError = '';
12			private $sCronError = '';
13			protected $table = '';
14			private $values = array(), $types = '';
			0 ignored issues – show Coding Style introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
15
16			public function getTableName() {
17			return $this->table;
18			}
19
20			protected $debug;
21			public function setDebug($debug) {
22			$this->debug = $debug;
23			}
24			public function setCoin($coin) {
25			$this->coin = $coin;
			0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report The property `coin` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
26			}
27			public function setCoinAddress($coin_address) {
28			$this->coin_address = $coin_address;
			0 ignored issues – show Bug introduced 2015-12-09 12:23 UTC by Report Bug Copy Issue Report The property `coin_address` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
29			}
30
31			public $log;
32			public function setLog($log) {
33			$this->log = $log;
34			}
35

MPOS / php-mpos