DebugCommand - Code Metrics - Inspection of "Debug command" - akalongman/php-telegram-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#387)

by Armando

created 2017-01-08 17:55 UTC

DebugCommand A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	74
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	8
c	1
b	0
f	0
lcom	1
cbo	6
dl	0
loc	74
ccs	0
cts	36
cp	0
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
C	execute()	0	45	8

<?php
/**
 * This file is part of the TelegramBot package.
 *
 * (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Longman\TelegramBot\Commands\AdminCommands;

use Longman\TelegramBot\Commands\AdminCommand;
use Longman\TelegramBot\DB;
use Longman\TelegramBot\Request;

/**
 * Admin "/debug" command
 */
class DebugCommand extends AdminCommand
{
    /**
     * @var string
     */
    protected $name = 'debug';

    /**
     * @var string
     */
    protected $description = 'Debug command to help find issues';

    /**
     * @var string
     */
    protected $usage = '/debug';

    /**
     * @var string
     */
    protected $version = '1.0.0';

    /**
     * Command execute method
     *
     * @return mixed
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public function execute()
// 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);
    }
}
    {
        $pdo = DB::getPdo();
        $message = $this->getMessage();
        $chat_id = $message->getChat()->getId();

        $debug_info = [];

        $debug_info[] = sprintf('_TelegramBot version_: `%s`', $this->telegram->getVersion());

        $php_bit = '';
        PHP_INT_SIZE === 4 && $php_bit = ' (32bit)';
        PHP_INT_SIZE === 8 && $php_bit = ' (64bit)';
        $debug_info[] = sprintf('_PHP version_: `%1$s%2$s; %3$s; %4$s`', PHP_VERSION, $php_bit, PHP_SAPI, PHP_OS);
        $debug_info[] = sprintf('_Maximum PHP script execution time_: `%d seconds`', ini_get('max_execution_time'));

        $mysql_version = $pdo ? $pdo->query('SELECT VERSION() AS version')->fetchColumn() : null;
        $debug_info[] = sprintf('_MySQL version_: `%s`', $mysql_version ?: 'disabled');

        $debug_info[] = sprintf('_Operating System_: `%s`', php_uname());

        if (isset($_SERVER['SERVER_SOFTWARE'])) {
            $debug_info[] = sprintf('_Web Server_: `%s`', $_SERVER['SERVER_SOFTWARE']);
        }
        if (function_exists('curl_init')) {
            $curlversion = curl_version();
            $debug_info[] = sprintf('_curl version_: `%1$s; %2$s`', $curlversion['version'], $curlversion['ssl_version']);
        }

        $debug_info[] = '_Webhook Info_:';
        try {
            $webhook_info = json_encode(json_decode(Request::getWebhookInfo(), true)['result'], JSON_PRETTY_PRINT);
        } catch (\Exception $e) {
            $webhook_info = sprintf('Failed to get webhook info! (%s)', $e->getMessage());
        }
        $debug_info[] = sprintf("```\n%s\n```", $webhook_info);

        $data = [
            'chat_id'    => $chat_id,
            'parse_mode' => 'Markdown',
            'text'       => implode(PHP_EOL, $debug_info),
        ];

        return Request::sendMessage($data);
    }
}


1			<?php
2			/**
3			* This file is part of the TelegramBot package.
4			*
5			* (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace Longman\TelegramBot\Commands\AdminCommands;
12
13			use Longman\TelegramBot\Commands\AdminCommand;
14			use Longman\TelegramBot\DB;
15			use Longman\TelegramBot\Request;
16
17			/**
18			* Admin "/debug" command
19			*/
20			class DebugCommand extends AdminCommand
21			{
22			/**
23			* @var string
24			*/
25			protected $name = 'debug';
26
27			/**
28			* @var string
29			*/
30			protected $description = 'Debug command to help find issues';
31
32			/**
33			* @var string
34			*/
35			protected $usage = '/debug';
36
37			/**
38			* @var string
39			*/
40			protected $version = '1.0.0';
41
42			/**
43			* Command execute method
44			*
45			* @return mixed
46			* @throws \Longman\TelegramBot\Exception\TelegramException
47			*/
48			public function execute()
			0 ignored issues – show Coding Style introduced 2017-01-08 17:58 UTC by Report Bug Copy Issue Report `execute` 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...
49			{
50			$pdo = DB::getPdo();
51			$message = $this->getMessage();
52			$chat_id = $message->getChat()->getId();
53
54			$debug_info = [];
55
56			$debug_info[] = sprintf('_TelegramBot version_: `%s`', $this->telegram->getVersion());
57
58			$php_bit = '';
59			PHP_INT_SIZE === 4 && $php_bit = ' (32bit)';
60			PHP_INT_SIZE === 8 && $php_bit = ' (64bit)';
61			$debug_info[] = sprintf('_PHP version_: `%1$s%2$s; %3$s; %4$s`', PHP_VERSION, $php_bit, PHP_SAPI, PHP_OS);
62			$debug_info[] = sprintf('_Maximum PHP script execution time_: `%d seconds`', ini_get('max_execution_time'));
63
64			$mysql_version = $pdo ? $pdo->query('SELECT VERSION() AS version')->fetchColumn() : null;
65			$debug_info[] = sprintf('_MySQL version_: `%s`', $mysql_version ?: 'disabled');
66
67			$debug_info[] = sprintf('_Operating System_: `%s`', php_uname());
68
69			if (isset($_SERVER['SERVER_SOFTWARE'])) {
70			$debug_info[] = sprintf('_Web Server_: `%s`', $_SERVER['SERVER_SOFTWARE']);
71			}
72			if (function_exists('curl_init')) {
73			$curlversion = curl_version();
74			$debug_info[] = sprintf('_curl version_: `%1$s; %2$s`', $curlversion['version'], $curlversion['ssl_version']);
75			}
76
77			$debug_info[] = '_Webhook Info_:';
78			try {
79			$webhook_info = json_encode(json_decode(Request::getWebhookInfo(), true)['result'], JSON_PRETTY_PRINT);
80			} catch (\Exception $e) {
81			$webhook_info = sprintf('Failed to get webhook info! (%s)', $e->getMessage());
82			}
83			$debug_info[] = sprintf("```\n%s\n```", $webhook_info);
84
85			$data = [
86			'chat_id' => $chat_id,
87			'parse_mode' => 'Markdown',
88			'text' => implode(PHP_EOL, $debug_info),
89			];
90
91			return Request::sendMessage($data);
92			}
93			}
94

akalongman / php-telegram-bot

Pull Request — develop (#387)

DebugCommand A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

1 Method

Duplication Side-by-Side

Filter issues like