Debug - Code Metrics - Inspection of "[~]: move "debug" and "logging"-wrapper into "Debu..." - voku/simple-mysqli - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 911a79...eea790 )

by Lars

created 2016-07-10 01:24 UTC

Debug B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	392
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

83.72%

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
wmc	52
c	1
b	0
f	1
lcom	1
cbo	3
dl	0
loc	392
ccs	108
cts	129
cp	0.8372
rs	7.9487

17 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
C	checkForDev()	30	8
A	clearErrors()	6	1
C	displayError()	44	7
A	getErrors()	4	1
D	getFileAndLineFromSql()	41	10
A	getLoggerClassName()	4	1
A	getLoggerLevel()	4	1
A	isEchoOnError()	4	1
A	isExitOnError()	4	1
B	logQuery()	26	4
C	logger()	27	7
B	mailToAdmin()	31	5
A	setEchoOnError()	4	1
A	setExitOnError()	4	1
A	setLoggerClassName()	4	1
A	setLoggerLevel()	4	1

How to fix Complexity

<?php

namespace voku\db;

use voku\helper\Bootup;
use voku\helper\UTF8;

/**
 * Debug: this handles debug and error-logging.
 *
 * @package   voku\db
 */
class Debug
{
  /**
   * @var array
   */
  private $_errors = array();

  /**
   * @var bool
   */
  private $exit_on_error = true;

  /**
   * @var bool
   */
  private $echo_on_error = true;

  /**
   * @var string
   */
  private $css_mysql_box_border = '3px solid red';

  /**
   * @var string
   */
  private $css_mysql_box_bg = '#FFCCCC';


  /**
   * @var string
   */
  private $logger_class_name;

  /**
   * @var DB
   */
  private $_db;

  /**
   * @var string
   *
   * 'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'
   */
  private $logger_level;

  public function __construct(DB $db)
  {
    $this->_db = $db;
  }

  /**
   * Check is the current user is a developer.
   *
   * INFO:
   * By default we will return "true" if the remote-ip-address is localhost or
   * if the script is called via CLI. But you can also overwrite this method or
   * you can implement a global "checkForDev()"-function.
   *
   * @return bool
   */
  public function checkForDev()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

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

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
  {
    // init
    $return = false;

    if (function_exists('checkForDev')) {
      $return = checkForDev();
    } else {

      // for testing with dev-address
      $noDev = isset($_GET['noDev']) ? (int)$_GET['noDev'] : 0;
      $remoteIpAddress = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : false;

      if (
          $noDev != 1
          &&
          (
              $remoteIpAddress === '127.0.0.1'
              ||
              $remoteIpAddress === '::1'
              ||
              PHP_SAPI === 'cli'
          )
      ) {
        $return = true;
      }
    }

    return $return;
  }

  /**
   * Clear the errors in "$this->_errors".
   *
   * @return bool
   */
  public function clearErrors()
  {
    $this->_errors = array();

    return true;
  }

  /**
   * Display SQL-Errors or throw Exceptions (for dev).
   *
   * @param string       $error
   * @param null|boolean $force_exception_after_error
   *
   * @throws \Exception
   */
  public function displayError($error, $force_exception_after_error = null)
  {
    $fileInfo = $this->getFileAndLineFromSql();

    $this->logger(
        array(
            'error',
            '<strong>' . date(
                'd. m. Y G:i:s'
            ) . ' (' . $fileInfo['file'] . ' line: ' . $fileInfo['line'] . ') (sql-error):</strong> ' . $error . '<br>',
        )
    );

    $this->_errors[] = $error;

    if ($this->checkForDev() === true) {

      if ($this->echo_on_error) {
        $box_border = $this->css_mysql_box_border;
        $box_bg = $this->css_mysql_box_bg;

        echo '
        <div class="OBJ-mysql-box" style="border:' . $box_border . '; background:' . $box_bg . '; padding:10px; margin:10px;">
          <b style="font-size:14px;">MYSQL Error:</b>
          <code style="display:block;">
            file / line: ' . $fileInfo['file'] . ' / ' . $fileInfo['line'] . '
            ' . $error . '
          </code>
        </div>
        ';
      }

      if ($force_exception_after_error === true) {
        throw new \Exception($error);
      } elseif ($force_exception_after_error === false) {

        // nothing
      } elseif ($force_exception_after_error === null) {
        // default
        if ($this->exit_on_error === true) {
          throw new \Exception($error);
        }
      }
    }
  }

  /**
   * Get errors from "$this->_errors".
   *
   * @return array
   */
  public function getErrors()
  {
    return $this->_errors;
  }

  /**
   * Try to get the file & line from the current sql-query.
   *
   * @return array will return array['file'] and array['line']
   */
  private function getFileAndLineFromSql()
  {
    // init
    $return = array();
    $file = '';
    $line = '';

    if (Bootup::is_php('5.4') === true) {
      $referrer = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 10);
    } else {
      $referrer = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
    }

    foreach ($referrer as $key => $ref) {

      if (
          $ref['function'] === 'execSQL'
          ||
          $ref['function'] === 'query'
          ||
          $ref['function'] === 'qry'
          ||
          $ref['function'] === 'insert'
          ||
          $ref['function'] === 'update'
          ||
          $ref['function'] === 'replace'
          ||
          $ref['function'] === 'delete'
      ) {
        $file = $referrer[$key]['file'];
        $line = $referrer[$key]['line'];
      }

    }

    $return['file'] = $file;
    $return['line'] = $line;

    return $return;
  }

  /**
   * @return string
   */
  public function getLoggerClassName()
  {
    return $this->logger_class_name;
  }

  /**
   * @return string
   */
  public function getLoggerLevel()
  {
    return $this->logger_level;
  }

  /**
   * @return boolean
   */
  public function isEchoOnError()
  {
    return $this->echo_on_error;
  }

  /**
   * @return boolean
   */
  public function isExitOnError()
  {
    return $this->exit_on_error;
  }

  /**
   * Log the current query via "$this->logger".
   *
   * @param string $sql     sql-query
   * @param int    $duration
   * @param int    $results result counter
   *
   * @return bool
   */
  public function logQuery($sql, $duration, $results)
  {
    $logLevelUse = strtolower($this->logger_level);

    if ($logLevelUse !== 'trace' && $logLevelUse !== 'debug') {
      return false;
    }

    $infoExtra = mysqli_info($this->_db->getLink());
    if ($infoExtra) {
      $infoExtra = ' | info => ' . $infoExtra;
    }

    $info = 'time => ' . round($duration, 5) . ' | results => ' . (int)$results . $infoExtra . ' | SQL => ' . UTF8::htmlentities($sql);
    $fileInfo = $this->getFileAndLineFromSql();

    $this->logger(
        array(
            'debug',
            '<strong>' . date('d. m. Y G:i:s') . ' (' . $fileInfo['file'] . ' line: ' . $fileInfo['line'] . '):</strong> ' . $info . '<br>',
            'sql',
        )
    );

    return true;
  }

  /**
   * Wrapper-Function for a "Logger"-Class.
   *
   * INFO:
   * The "Logger"-ClassName is set by "$this->logger_class_name",<br />
   * the "Logger"-Method is the [0] element from the "$log"-parameter,<br />
   * the text you want to log is the [1] element and<br />
   * the type you want to log is the next [2] element.
   *
   * @param string[] $log [method, text, type]<br />e.g.: array('error', 'this is a error', 'sql')
   */
  public function logger(array $log)
  {
    $logMethod = '';
    $logText = '';
    $logType = '';
    $logClass = $this->logger_class_name;

    if (isset($log[0])) {
      $logMethod = $log[0];
    }
    if (isset($log[1])) {
      $logText = $log[1];
    }
    if (isset($log[2])) {
      $logType = $log[2];
    }

    if (
        $logClass
        &&
        class_exists($logClass)
        &&
        method_exists($logClass, $logMethod)
    ) {
      $logClass::$logMethod($logText, $logType);
    }
  }

  /**
   * Send a error mail to the admin / dev.
   *
   * @param string $subject
   * @param string $htmlBody
   * @param int    $priority
   */
  public function mailToAdmin($subject, $htmlBody, $priority = 3)
  {
    if (function_exists('mailToAdmin')) {
      mailToAdmin($subject, $htmlBody, $priority);
    } else {

      if ($priority === 3) {
        $this->logger(
            array(
                'debug',
                $subject . ' | ' . $htmlBody,
            )
        );
      } elseif ($priority > 3) {
        $this->logger(
            array(
                'error',
                $subject . ' | ' . $htmlBody,
            )
        );
      } elseif ($priority < 3) {
        $this->logger(
            array(
                'info',
                $subject . ' | ' . $htmlBody,
            )
        );
      }

    }
  }

  /**
   * @param boolean $echo_on_error
   */
  public function setEchoOnError($echo_on_error)
  {
    $this->echo_on_error = (boolean)$echo_on_error;
  }

  /**
   * @param boolean $exit_on_error
   */
  public function setExitOnError($exit_on_error)
  {
    $this->exit_on_error = (boolean)$exit_on_error;
  }

  /**
   * @param string $logger_class_name
   */
  public function setLoggerClassName($logger_class_name)
  {
    $this->logger_class_name = (string)$logger_class_name;
  }

  /**
   * @param string $logger_level
   */
  public function setLoggerLevel($logger_level)
  {
    $this->logger_level = (string)$logger_level;
  }

}


1		<?php
2
3		namespace voku\db;
4
5		use voku\helper\Bootup;
6		use voku\helper\UTF8;
7
8		/**
9		* Debug: this handles debug and error-logging.
10		*
11		* @package voku\db
12		*/
13		class Debug
14		{
15		/**
16		* @var array
17		*/
18		private $_errors = array();
19
20		/**
21		* @var bool
22		*/
23		private $exit_on_error = true;
24
25		/**
26		* @var bool
27		*/
28		private $echo_on_error = true;
29
30		/**
31		* @var string
32		*/
33		private $css_mysql_box_border = '3px solid red';
34
35		/**
36		* @var string
37		*/
38		private $css_mysql_box_bg = '#FFCCCC';
39
40
41		/**
42		* @var string
43		*/
44		private $logger_class_name;
45
46		/**
47		* @var DB
48		*/
49		private $_db;
50
51		/**
52		* @var string
53		*
54		* 'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL'
55		*/
56		private $logger_level;
57
58	10	public function __construct(DB $db)
59		{
60	10	$this->_db = $db;
61	10	}
62
63		/**
64		* Check is the current user is a developer.
65		*
66		* INFO:
67		* By default we will return "true" if the remote-ip-address is localhost or
68		* if the script is called via CLI. But you can also overwrite this method or
69		* you can implement a global "checkForDev()"-function.
70		*
71		* @return bool
72		*/
73	20	public function checkForDev()
		0 ignored issues – show Coding Style introduced 2016-07-10 01:27 UTC by Report Bug Copy Issue Report `checkForDev` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2016-07-10 01:27 UTC by Report Bug Copy Issue Report `checkForDev` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
74		{
75		// init
76	20	$return = false;
77
78	20	if (function_exists('checkForDev')) {
79		$return = checkForDev();
80		} else {
81
82		// for testing with dev-address
83	20	$noDev = isset($_GET['noDev']) ? (int)$_GET['noDev'] : 0;
84	20	$remoteIpAddress = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : false;
85
86		if (
87	20	$noDev != 1
88		&&
89		(
90	20	$remoteIpAddress === '127.0.0.1'
91		\|\|
92	20	$remoteIpAddress === '::1'
93		\|\|
94	20	PHP_SAPI === 'cli'
95		)
96		) {
97	20	$return = true;
98		}
99		}
100
101	20	return $return;
102		}
103
104		/**
105		* Clear the errors in "$this->_errors".
106		*
107		* @return bool
108		*/
109	4	public function clearErrors()
110		{
111	4	$this->_errors = array();
112
113	4	return true;
114		}
115
116		/**
117		* Display SQL-Errors or throw Exceptions (for dev).
118		*
119		* @param string $error
120		* @param null\|boolean $force_exception_after_error
121		*
122		* @throws \Exception
123		*/
124	20	public function displayError($error, $force_exception_after_error = null)
125		{
126	20	$fileInfo = $this->getFileAndLineFromSql();
127
128	20	$this->logger(
129		array(
130	20	'error',
131	20	'<strong>' . date(
132	20	'd. m. Y G:i:s'
133	20	) . ' (' . $fileInfo['file'] . ' line: ' . $fileInfo['line'] . ') (sql-error):</strong> ' . $error . '<br>',
134		)
135		);
136
137	20	$this->_errors[] = $error;
138
139	20	if ($this->checkForDev() === true) {
140
141	20	if ($this->echo_on_error) {
142	4	$box_border = $this->css_mysql_box_border;
143	4	$box_bg = $this->css_mysql_box_bg;
144
145		echo '
146	4	<div class="OBJ-mysql-box" style="border:' . $box_border . '; background:' . $box_bg . '; padding:10px; margin:10px;">
147		<b style="font-size:14px;">MYSQL Error:</b>
148		<code style="display:block;">
149	4	file / line: ' . $fileInfo['file'] . ' / ' . $fileInfo['line'] . '
150	4	' . $error . '
151		</code>
152		</div>
153	4	';
154		}
155
156	20	if ($force_exception_after_error === true) {
157	4	throw new \Exception($error);
158	16	} elseif ($force_exception_after_error === false) {
		0 ignored issues – show Unused Code introduced 2016-07-10 01:27 UTC by Report Bug Copy Issue Report This `elseif` statement is empty, and could be removed. This check looks for the bodies of `elseif` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `elseif` bodies can be removed. If you have an empty elseif but statements in the `else` branch, consider inverting the condition. Loading history...
159		// nothing
160	13	} elseif ($force_exception_after_error === null) {
161		// default
162	13	if ($this->exit_on_error === true) {
163	2	throw new \Exception($error);
164		}
165		}
166		}
167	14	}
168
169		/**
170		* Get errors from "$this->_errors".
171		*
172		* @return array
173		*/
174	3	public function getErrors()
175		{
176	3	return $this->_errors;
177		}
178
179		/**
180		* Try to get the file & line from the current sql-query.
181		*
182		* @return array will return array['file'] and array['line']
183		*/
184	20	private function getFileAndLineFromSql()
185		{
186		// init
187	20	$return = array();
188	20	$file = '';
189	20	$line = '';
190
191	20	if (Bootup::is_php('5.4') === true) {
192	20	$referrer = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 10);
193		} else {
194		$referrer = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
195		}
196
197	20	foreach ($referrer as $key => $ref) {
198
199		if (
200	20	$ref['function'] === 'execSQL'
201		\|\|
202	20	$ref['function'] === 'query'
203		\|\|
204	20	$ref['function'] === 'qry'
205		\|\|
206	20	$ref['function'] === 'insert'
207		\|\|
208	20	$ref['function'] === 'update'
209		\|\|
210	20	$ref['function'] === 'replace'
211		\|\|
212	20	$ref['function'] === 'delete'
213		) {
214	14	$file = $referrer[$key]['file'];
215	20	$line = $referrer[$key]['line'];
216		}
217
218		}
219
220	20	$return['file'] = $file;
221	20	$return['line'] = $line;
222
223	20	return $return;
224		}
225
226		/**
227		* @return string
228		*/
229		public function getLoggerClassName()
230		{
231		return $this->logger_class_name;
232		}
233
234		/**
235		* @return string
236		*/
237		public function getLoggerLevel()
238		{
239		return $this->logger_level;
240		}
241
242		/**
243		* @return boolean
244		*/
245		public function isEchoOnError()
246		{
247		return $this->echo_on_error;
248		}
249
250		/**
251		* @return boolean
252		*/
253		public function isExitOnError()
254		{
255		return $this->exit_on_error;
256		}
257
258		/**
259		* Log the current query via "$this->logger".
260		*
261		* @param string $sql sql-query
262		* @param int $duration
263		* @param int $results result counter
264		*
265		* @return bool
266		*/
267	25	public function logQuery($sql, $duration, $results)
268		{
269	25	$logLevelUse = strtolower($this->logger_level);
270
271	25	if ($logLevelUse !== 'trace' && $logLevelUse !== 'debug') {
272	25	return false;
273		}
274
275	1	$infoExtra = mysqli_info($this->_db->getLink());
276	1	if ($infoExtra) {
277		$infoExtra = ' \| info => ' . $infoExtra;
278		}
279
280	1	$info = 'time => ' . round($duration, 5) . ' \| results => ' . (int)$results . $infoExtra . ' \| SQL => ' . UTF8::htmlentities($sql);
281	1	$fileInfo = $this->getFileAndLineFromSql();
282
283	1	$this->logger(
284		array(
285	1	'debug',
286	1	'<strong>' . date('d. m. Y G:i:s') . ' (' . $fileInfo['file'] . ' line: ' . $fileInfo['line'] . '):</strong> ' . $info . '<br>',
287	1	'sql',
288		)
289		);
290
291	1	return true;
292		}
293
294		/**
295		* Wrapper-Function for a "Logger"-Class.
296		*
297		* INFO:
298		* The "Logger"-ClassName is set by "$this->logger_class_name",<br />
299		* the "Logger"-Method is the [0] element from the "$log"-parameter,<br />
300		* the text you want to log is the [1] element and<br />
301		* the type you want to log is the next [2] element.
302		*
303		* @param string[] $log [method, text, type]<br />e.g.: array('error', 'this is a error', 'sql')
304		*/
305	21	public function logger(array $log)
306		{
307	21	$logMethod = '';
308	21	$logText = '';
309	21	$logType = '';
310	21	$logClass = $this->logger_class_name;
311
312	21	if (isset($log[0])) {
313	21	$logMethod = $log[0];
314		}
315	21	if (isset($log[1])) {
316	21	$logText = $log[1];
317		}
318	21	if (isset($log[2])) {
319	1	$logType = $log[2];
320		}
321
322		if (
323	21	$logClass
324		&&
325	21	class_exists($logClass)
326		&&
327	21	method_exists($logClass, $logMethod)
328		) {
329		$logClass::$logMethod($logText, $logType);
330		}
331	21	}
332
333		/**
334		* Send a error mail to the admin / dev.
335		*
336		* @param string $subject
337		* @param string $htmlBody
338		* @param int $priority
339		*/
340	10	public function mailToAdmin($subject, $htmlBody, $priority = 3)
341		{
342	10	if (function_exists('mailToAdmin')) {
343		mailToAdmin($subject, $htmlBody, $priority);
344		} else {
345
346	10	if ($priority === 3) {
347	10	$this->logger(
348		array(
349	10	'debug',
350	10	$subject . ' \| ' . $htmlBody,
351		)
352		);
353		} elseif ($priority > 3) {
354		$this->logger(
355		array(
356		'error',
357		$subject . ' \| ' . $htmlBody,
358		)
359		);
360		} elseif ($priority < 3) {
361		$this->logger(
362		array(
363		'info',
364		$subject . ' \| ' . $htmlBody,
365		)
366		);
367		}
368
369		}
370	10	}
371
372		/**
373		* @param boolean $echo_on_error
374		*/
375	10	public function setEchoOnError($echo_on_error)
376		{
377	10	$this->echo_on_error = (boolean)$echo_on_error;
378	10	}
379
380		/**
381		* @param boolean $exit_on_error
382		*/
383	10	public function setExitOnError($exit_on_error)
384		{
385	10	$this->exit_on_error = (boolean)$exit_on_error;
386	10	}
387
388		/**
389		* @param string $logger_class_name
390		*/
391	10	public function setLoggerClassName($logger_class_name)
392		{
393	10	$this->logger_class_name = (string)$logger_class_name;
394	10	}
395
396		/**
397		* @param string $logger_level
398		*/
399	10	public function setLoggerLevel($logger_level)
400		{
401	10	$this->logger_level = (string)$logger_level;
402	10	}
403
404		}
405

voku / simple-mysqli

Push — master ( 911a79...eea790 )

Debug B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

17 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like