Command::getConfig() - Code Metrics - Inspection of "Version 0.46.0" - php-telegram-bot/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6d1075...fae82d )

by Armando

created 2017-07-15 21:25 UTC

Command::getConfig() A

↳ Parent: Command

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	11
ccs	6
cts	6
cp	1
rs	9.4285
cc	3
eloc	6
nc	3
nop	1
crap	3

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

use Longman\TelegramBot\DB;
use Longman\TelegramBot\Entities\CallbackQuery;
use Longman\TelegramBot\Entities\ChosenInlineResult;
use Longman\TelegramBot\Entities\InlineQuery;
use Longman\TelegramBot\Entities\Message;
use Longman\TelegramBot\Entities\Update;
use Longman\TelegramBot\Request;
use Longman\TelegramBot\Telegram;

/**
 * Class Command
 *
 * Base class for commands. It includes some helper methods that can fetch data directly from the Update object.
 *
 * @method Message             getMessage()            Optional. New incoming message of any kind — text, photo, sticker, etc.
 * @method Message             getEditedMessage()      Optional. New version of a message that is known to the bot and was edited
 * @method Message             getChannelPost()        Optional. New post in the channel, can be any kind — text, photo, sticker, etc.
 * @method Message             getEditedChannelPost()  Optional. New version of a post in the channel that is known to the bot and was edited
 * @method InlineQuery         getInlineQuery()        Optional. New incoming inline query
 * @method ChosenInlineResult  getChosenInlineResult() Optional. The result of an inline query that was chosen by a user and sent to their chat partner.
 * @method CallbackQuery       getCallbackQuery()      Optional. New incoming callback query
 */
abstract class Command
{
    /**
     * Telegram object
     *
     * @var \Longman\TelegramBot\Telegram
     */
    protected $telegram;

    /**
     * Update object
     *
     * @var \Longman\TelegramBot\Entities\Update
     */
    protected $update;

    /**
     * Name
     *
     * @var string
     */
    protected $name = '';

    /**
     * Description
     *
     * @var string
     */
    protected $description = 'Command description';

    /**
     * Usage
     *
     * @var string
     */
    protected $usage = 'Command usage';

    /**
     * Show in Help
     *
     * @var bool
     */
    protected $show_in_help = true;

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

    /**
     * If this command is enabled
     *
     * @var boolean
     */
    protected $enabled = true;

    /**
     * If this command needs mysql
     *
     * @var boolean
     */
    protected $need_mysql = false;

    /**
     * Command config
     *
     * @var array
     */
    protected $config = [];

    /**
     * Constructor
     *
     * @param \Longman\TelegramBot\Telegram        $telegram
     * @param \Longman\TelegramBot\Entities\Update $update
     */
    public function __construct(Telegram $telegram, Update $update = null)
    {
        $this->telegram = $telegram;
        $this->setUpdate($update);
        $this->config = $telegram->getCommandConfig($this->name);
    }

    /**
     * Set update object
     *
     * @param \Longman\TelegramBot\Entities\Update $update
     *
     * @return \Longman\TelegramBot\Commands\Command
     */
    public function setUpdate(Update $update = null)
    {
        if ($update !== null) {
            $this->update = $update;
        }

        return $this;
    }

    /**
     * Pre-execute command
     *
     * @return \Longman\TelegramBot\Entities\ServerResponse
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public function preExecute()
    {
        if ($this->need_mysql && !($this->telegram->isDbEnabled() && DB::isDbConnected())) {
            return $this->executeNoDb();
        }

        return $this->execute();
    }

    /**
     * Execute command
     *
     * @return \Longman\TelegramBot\Entities\ServerResponse
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    abstract public function execute();

    /**
     * Execution if MySQL is required but not available
     *
     * @return \Longman\TelegramBot\Entities\ServerResponse
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public function executeNoDb()
    {
        //Preparing message
        $message = $this->getMessage();
        $chat_id = $message->getChat()->getId();

        $data = [
            'chat_id' => $chat_id,
            'text'    => 'Sorry no database connection, unable to execute "' . $this->name . '" command.',
        ];

        return Request::sendMessage($data);
    }

    /**
     * Get update object
     *
     * @return \Longman\TelegramBot\Entities\Update
     */
    public function getUpdate()
    {
        return $this->update;
    }

    /**
     * Relay any non-existing function calls to Update object.
     *
     * This is purely a helper method to make requests from within execute() method easier.
     *
     * @param string $name
     * @param array  $arguments
     *
     * @return Command
     */
    public function __call($name, array $arguments)
    {
        if ($this->update === null) {
            return null;
        }
        return call_user_func_array([$this->update, $name], $arguments);
    }

    /**
     * Get command config
     *
     * Look for config $name if found return it, if not return null.
     * If $name is not set return all set config.
     *
     * @param string|null $name
     *
     * @return array|mixed|null
     */
    public function getConfig($name = null)
    {
        if ($name === null) {
            return $this->config;
        }
        if (isset($this->config[$name])) {
            return $this->config[$name];
        }

        return null;
    }

    /**
     * Get telegram object
     *
     * @return \Longman\TelegramBot\Telegram
     */
    public function getTelegram()
    {
        return $this->telegram;
    }

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

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

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

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

    /**
     * Get Show in Help
     *
     * @return bool
     */
    public function showInHelp()
    {
        return $this->show_in_help;
    }

    /**
     * Check if command is enabled
     *
     * @return bool
     */
    public function isEnabled()
    {
        return $this->enabled;
    }

    /**
     * If this is a SystemCommand
     *
     * @return bool
     */
    public function isSystemCommand()
    {
        return ($this instanceof SystemCommand);
    }

    /**
     * If this is an AdminCommand
     *
     * @return bool
     */
    public function isAdminCommand()
    {
        return ($this instanceof AdminCommand);
    }

    /**
     * If this is a UserCommand
     *
     * @return bool
     */
    public function isUserCommand()
    {
        return ($this instanceof UserCommand);
    }
}


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;
12
13		use Longman\TelegramBot\DB;
14		use Longman\TelegramBot\Entities\CallbackQuery;
15		use Longman\TelegramBot\Entities\ChosenInlineResult;
16		use Longman\TelegramBot\Entities\InlineQuery;
17		use Longman\TelegramBot\Entities\Message;
18		use Longman\TelegramBot\Entities\Update;
19		use Longman\TelegramBot\Request;
20		use Longman\TelegramBot\Telegram;
21
22		/**
23		* Class Command
24		*
25		* Base class for commands. It includes some helper methods that can fetch data directly from the Update object.
26		*
27		* @method Message getMessage() Optional. New incoming message of any kind — text, photo, sticker, etc.
28		* @method Message getEditedMessage() Optional. New version of a message that is known to the bot and was edited
29		* @method Message getChannelPost() Optional. New post in the channel, can be any kind — text, photo, sticker, etc.
30		* @method Message getEditedChannelPost() Optional. New version of a post in the channel that is known to the bot and was edited
31		* @method InlineQuery getInlineQuery() Optional. New incoming inline query
32		* @method ChosenInlineResult getChosenInlineResult() Optional. The result of an inline query that was chosen by a user and sent to their chat partner.
33		* @method CallbackQuery getCallbackQuery() Optional. New incoming callback query
34		*/
35		abstract class Command
36		{
37		/**
38		* Telegram object
39		*
40		* @var \Longman\TelegramBot\Telegram
41		*/
42		protected $telegram;
43
44		/**
45		* Update object
46		*
47		* @var \Longman\TelegramBot\Entities\Update
48		*/
49		protected $update;
50
51		/**
52		* Name
53		*
54		* @var string
55		*/
56		protected $name = '';
57
58		/**
59		* Description
60		*
61		* @var string
62		*/
63		protected $description = 'Command description';
64
65		/**
66		* Usage
67		*
68		* @var string
69		*/
70		protected $usage = 'Command usage';
71
72		/**
73		* Show in Help
74		*
75		* @var bool
76		*/
77		protected $show_in_help = true;
78
79		/**
80		* Version
81		*
82		* @var string
83		*/
84		protected $version = '1.0.0';
85
86		/**
87		* If this command is enabled
88		*
89		* @var boolean
90		*/
91		protected $enabled = true;
92
93		/**
94		* If this command needs mysql
95		*
96		* @var boolean
97		*/
98		protected $need_mysql = false;
99
100		/**
101		* Command config
102		*
103		* @var array
104		*/
105		protected $config = [];
106
107		/**
108		* Constructor
109		*
110		* @param \Longman\TelegramBot\Telegram $telegram
111		* @param \Longman\TelegramBot\Entities\Update $update
112		*/
113	15	public function __construct(Telegram $telegram, Update $update = null)
114		{
115	15	$this->telegram = $telegram;
116	15	$this->setUpdate($update);
117	15	$this->config = $telegram->getCommandConfig($this->name);
118	15	}
119
120		/**
121		* Set update object
122		*
123		* @param \Longman\TelegramBot\Entities\Update $update
124		*
125		* @return \Longman\TelegramBot\Commands\Command
126		*/
127	15	public function setUpdate(Update $update = null)
128		{
129	15	if ($update !== null) {
130	1	$this->update = $update;
131		}
132
133	15	return $this;
134		}
135
136		/**
137		* Pre-execute command
138		*
139		* @return \Longman\TelegramBot\Entities\ServerResponse
140		* @throws \Longman\TelegramBot\Exception\TelegramException
141		*/
142		public function preExecute()
143		{
144		if ($this->need_mysql && !($this->telegram->isDbEnabled() && DB::isDbConnected())) {
145		return $this->executeNoDb();
146		}
147
148		return $this->execute();
149		}
150
151		/**
152		* Execute command
153		*
154		* @return \Longman\TelegramBot\Entities\ServerResponse
155		* @throws \Longman\TelegramBot\Exception\TelegramException
156		*/
157		abstract public function execute();
158
159		/**
160		* Execution if MySQL is required but not available
161		*
162		* @return \Longman\TelegramBot\Entities\ServerResponse
163		* @throws \Longman\TelegramBot\Exception\TelegramException
164		*/
165		public function executeNoDb()
166		{
167		//Preparing message
168		$message = $this->getMessage();
169		$chat_id = $message->getChat()->getId();
170
171		$data = [
172		'chat_id' => $chat_id,
173		'text' => 'Sorry no database connection, unable to execute "' . $this->name . '" command.',
174		];
175
176		return Request::sendMessage($data);
177		}
178
179		/**
180		* Get update object
181		*
182		* @return \Longman\TelegramBot\Entities\Update
183		*/
184	1	public function getUpdate()
185		{
186	1	return $this->update;
187		}
188
189		/**
190		* Relay any non-existing function calls to Update object.
191		*
192		* This is purely a helper method to make requests from within execute() method easier.
193		*
194		* @param string $name
195		* @param array $arguments
196		*
197		* @return Command
198		*/
199	1	public function __call($name, array $arguments)
200		{
201	1	if ($this->update === null) {
202	1	return null;
203		}
204	1	return call_user_func_array([$this->update, $name], $arguments);
205		}
206
207		/**
208		* Get command config
209		*
210		* Look for config $name if found return it, if not return null.
211		* If $name is not set return all set config.
212		*
213		* @param string\|null $name
214		*
215		* @return array\|mixed\|null
216		*/
217	1	public function getConfig($name = null)
218		{
219	1	if ($name === null) {
220	1	return $this->config;
221		}
222	1	if (isset($this->config[$name])) {
223	1	return $this->config[$name];
224		}
225
226	1	return null;
227		}
228
229		/**
230		* Get telegram object
231		*
232		* @return \Longman\TelegramBot\Telegram
233		*/
234	1	public function getTelegram()
235		{
236	1	return $this->telegram;
237		}
238
239		/**
240		* Get usage
241		*
242		* @return string
243		*/
244	1	public function getUsage()
245		{
246	1	return $this->usage;
247		}
248
249		/**
250		* Get version
251		*
252		* @return string
253		*/
254	1	public function getVersion()
255		{
256	1	return $this->version;
257		}
258
259		/**
260		* Get description
261		*
262		* @return string
263		*/
264	1	public function getDescription()
265		{
266	1	return $this->description;
267		}
268
269		/**
270		* Get name
271		*
272		* @return string
273		*/
274	1	public function getName()
275		{
276	1	return $this->name;
277		}
278
279		/**
280		* Get Show in Help
281		*
282		* @return bool
283		*/
284	1	public function showInHelp()
285		{
286	1	return $this->show_in_help;
287		}
288
289		/**
290		* Check if command is enabled
291		*
292		* @return bool
293		*/
294	1	public function isEnabled()
295		{
296	1	return $this->enabled;
297		}
298
299		/**
300		* If this is a SystemCommand
301		*
302		* @return bool
303		*/
304		public function isSystemCommand()
305		{
306		return ($this instanceof SystemCommand);
307		}
308
309		/**
310		* If this is an AdminCommand
311		*
312		* @return bool
313		*/
314		public function isAdminCommand()
315		{
316		return ($this instanceof AdminCommand);
317		}
318
319		/**
320		* If this is a UserCommand
321		*
322		* @return bool
323		*/
324		public function isUserCommand()
325		{
326		return ($this instanceof UserCommand);
327		}
328		}
329

php-telegram-bot / core

Push — master ( 6d1075...fae82d )

Command::getConfig() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like