ServerResponse::printError() - Code Metrics - Inspection of "Improved code and doc-blocks in system commands" - akalongman/php-telegram-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/improve-code ( e986a1...36787d )

by Avtandil

created 2016-08-24 13:06 UTC

ServerResponse::printError() A

↳ Parent: ServerResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	4
rs	10
c	1
b	0
f	0
ccs	0
cts	0
cp	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?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\Entities;

class ServerResponse extends Entity
{
    /**
     * @var bool
     */
    protected $ok;

    /**
     * @var null
     */
    protected $result;

    /**
     * @var null
     */
    protected $error_code;

    /**
     * @var null
     */
    protected $description;

    /**
     * ServerResponse constructor.
     *
     * @param array $data
     * @param       $bot_name
     */
    public function __construct(array $data, $bot_name)
    {
        if (isset($data['ok']) && isset($data['result'])) {
            if (is_array($data['result'])) {
                if ($data['ok'] && !$this->isAssoc($data['result']) && !isset($data['result'][0]['user'])) {
                    //Get Update
                    foreach ($data['result'] as $update) {
                        $this->result[] = new Update($update, $bot_name);
                    }
                } elseif ($data['ok'] && !$this->isAssoc($data['result']) && isset($data['result'][0]['user'])) {
                    //Response from getChatAdministrators
                    $this->result = [];

                    foreach ($data['result'] as $user) {
                        array_push($this->result, new ChatMember($user));
                    }
                } elseif ($data['ok'] && $this->isAssoc($data['result'])) {
                    if (isset($data['result']['total_count'])) {
                        //Response from getUserProfilePhotos
                        $this->result = new UserProfilePhotos($data['result']);

                    } elseif (isset($data['result']['file_id'])) {
                        //Response from getFile
                        $this->result = new File($data['result']);

                    } elseif (isset($data['result']['username'])) {
                        //Response from getMe
                        $this->result = new User($data['result']);

                    } elseif (isset($data['result']['id'])) {
                        //Response from getChat
                        $this->result = new Chat($data['result']);

                    } elseif (isset($data['result']['user'])) {
                        //Response from getChatMember
                        $this->result = new ChatMember($data['result']);

                    } else {
                        //Response from sendMessage
                        $this->result = new Message($data['result'], $bot_name);

                    }
                }

                $this->ok          = $data['ok'];
                $this->error_code  = null;
                $this->description = null;
            } else {
                if ($data['ok'] && $data['result'] === true) {
                    //Response from setWebhook set
                    $this->ok         = $data['ok'];
                    $this->result     = true;

                    $this->error_code = null;

                    if (isset($data['description'])) {

                        $this->description = $data['description'];
                    } else {
                        $this->description = '';

                    }
                } elseif (is_numeric($data['result'])) {
                    //Response from getChatMembersCount
                    $this->result = $data['result'];

                } else {
                    $this->ok          = false;
                    $this->result      = null;
                    $this->error_code  = $data['error_code'];
                    $this->description = $data['description'];
                }
            }
        } else {
            //webHook not set
            $this->ok = false;

            if (isset($data['result'])) {
                $this->result = $data['result'];
            } else {
                $this->result = null;
            }

            if (isset($data['error_code'])) {
                $this->error_code = $data['error_code'];
            } else {
                $this->error_code = null;
            }

            if (isset($data['description'])) {

                $this->description = $data['description'];
            } else {
                $this->description = null;
            }

            //throw new TelegramException('ok(variable) is not set!');

        }
    }

    /**
     * Check if array is associative
     *
     * @param array $array
     * @return bool
     */
    protected function isAssoc(array $array)
    {
        return (bool) count(array_filter(array_keys($array), 'is_string'));
    }

    /**
     * If response is ok
     *
     * @return bool
     */
    public function isOk()
    {
        return $this->ok;
    }

    /**
     * Get result
     *
     * @return string
     */
    public function getResult()
    {
        return $this->result;
    }

    /**
     * Get error code
     *
     * @return string
     */
    public function getErrorCode()
    {
        return $this->error_code;
    }

    /**
     * Get description
     *
     * @return null
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * Print error
     *
     * @return string
     */
    public function printError()
    {
        return 'Error N: ' . $this->getErrorCode() . ' Description: ' . $this->getDescription();
    }
}


1			<?php
2			/**
3			* This file is part of the TelegramBot package.
4			* (c) Avtandil Kikabidze aka LONGMAN <[email protected]>
5			* For the full copyright and license information, please view the LICENSE
6			* file that was distributed with this source code.
7			*/
8
9			namespace Longman\TelegramBot\Entities;
10
11			class ServerResponse extends Entity
12			{
13			/**
14			* @var bool
15			*/
16			protected $ok;
17
18			/**
19			* @var null
20			*/
21			protected $result;
22
23			/**
24			* @var null
25			*/
26			protected $error_code;
27
28			/**
29			* @var null
30			*/
31			protected $description;
32
33			/**
34			* ServerResponse constructor.
35			*
36			* @param array $data
37			* @param $bot_name
38			*/
39	14		public function __construct(array $data, $bot_name)
40			{
41	14		if (isset($data['ok']) && isset($data['result'])) {
42	12		if (is_array($data['result'])) {
43	11		if ($data['ok'] && !$this->isAssoc($data['result']) && !isset($data['result'][0]['user'])) {
44			//Get Update
45	2		foreach ($data['result'] as $update) {
46	2		$this->result[] = new Update($update, $bot_name);
47			}
48	9		} elseif ($data['ok'] && !$this->isAssoc($data['result']) && isset($data['result'][0]['user'])) {
49			//Response from getChatAdministrators
50			$this->result = [];
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `array()` of type `array` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
51			foreach ($data['result'] as $user) {
52			array_push($this->result, new ChatMember($user));
53			}
54	9		} elseif ($data['ok'] && $this->isAssoc($data['result'])) {
55	9		if (isset($data['result']['total_count'])) {
56			//Response from getUserProfilePhotos
57	1		$this->result = new UserProfilePhotos($data['result']);
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `new \Longman\TelegramBot...Photos($data['result'])` of type `object<Longman\TelegramB...ties\UserProfilePhotos>` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
58	8		} elseif (isset($data['result']['file_id'])) {
59			//Response from getFile
60	1		$this->result = new File($data['result']);
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `new \Longman\TelegramBot...s\File($data['result'])` of type `object<Longman\TelegramBot\Entities\File>` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
61	7		} elseif (isset($data['result']['username'])) {
62			//Response from getMe
63			$this->result = new User($data['result']);
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `new \Longman\TelegramBot...s\User($data['result'])` of type `object<Longman\TelegramBot\Entities\User>` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
64	7		} elseif (isset($data['result']['id'])) {
65			//Response from getChat
66			$this->result = new Chat($data['result']);
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `new \Longman\TelegramBot...s\Chat($data['result'])` of type `object<Longman\TelegramBot\Entities\Chat>` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
67	7		} elseif (isset($data['result']['user'])) {
68			//Response from getChatMember
69			$this->result = new ChatMember($data['result']);
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `new \Longman\TelegramBot...Member($data['result'])` of type `object<Longman\TelegramBot\Entities\ChatMember>` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
70			} else {
71			//Response from sendMessage
72	7		$this->result = new Message($data['result'], $bot_name);
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `new \Longman\TelegramBot...a['result'], $bot_name)` of type `object<Longman\TelegramBot\Entities\Message>` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
73			}
74			}
75
76	11		$this->ok = $data['ok'];
77	11		$this->error_code = null;
78	11		$this->description = null;
79			} else {
80	2		if ($data['ok'] && $data['result'] === true) {
81			//Response from setWebhook set
82	2		$this->ok = $data['ok'];
83	2		$this->result = true;
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `true` of type `boolean` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
84	2		$this->error_code = null;
85
86	2	View Code Duplication	if (isset($data['description'])) {
			0 ignored issues – show Duplication introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
87	1		$this->description = $data['description'];
88			} else {
89	2		$this->description = '';
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `''` of type `string` is incompatible with the declared type `null` of property `$description`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
90			}
91			} elseif (is_numeric($data['result'])) {
92			//Response from getChatMembersCount
93			$this->result = $data['result'];
			0 ignored issues – show Documentation Bug introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report It seems like `$data['result']` of type `integer` or `double` or `string` is incompatible with the declared type `null` of property `$result`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
94			} else {
95			$this->ok = false;
96			$this->result = null;
97			$this->error_code = $data['error_code'];
98	12		$this->description = $data['description'];
99			}
100			}
101			} else {
102			//webHook not set
103	2		$this->ok = false;
104
105	2		if (isset($data['result'])) {
106			$this->result = $data['result'];
107			} else {
108	2		$this->result = null;
109			}
110
111	2		if (isset($data['error_code'])) {
112	2		$this->error_code = $data['error_code'];
113			} else {
114			$this->error_code = null;
115			}
116
117	2	View Code Duplication	if (isset($data['description'])) {
			0 ignored issues – show Duplication introduced 2016-08-24 11:11 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
118	2		$this->description = $data['description'];
119			} else {
120			$this->description = null;
121			}
122
123			//throw new TelegramException('ok(variable) is not set!');
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-23 14:21 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
124			}
125	14		}
126
127			/**
128			* Check if array is associative
129			*
130			* @param array $array
131			* @return bool
132			*/
133	11		protected function isAssoc(array $array)
134			{
135	11		return (bool) count(array_filter(array_keys($array), 'is_string'));
136			}
137
138			/**
139			* If response is ok
140			*
141			* @return bool
142			*/
143	5		public function isOk()
144			{
145	5		return $this->ok;
146			}
147
148			/**
149			* Get result
150			*
151			* @return string
152			*/
153	14		public function getResult()
154			{
155	14		return $this->result;
156			}
157
158			/**
159			* Get error code
160			*
161			* @return string
162			*/
163	5		public function getErrorCode()
164			{
165	5		return $this->error_code;
166			}
167
168			/**
169			* Get description
170			*
171			* @return null
172			*/
173	5		public function getDescription()
174			{
175	5		return $this->description;
176			}
177
178			/**
179			* Print error
180			*
181			* @return string
182			*/
183			public function printError()
184			{
185			return 'Error N: ' . $this->getErrorCode() . ' Description: ' . $this->getDescription();
186			}
187			}
188

akalongman / php-telegram-bot

Push — feature/improve-code ( e986a1...36787d )

ServerResponse::printError() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like