BotState::getStatus() - Code Metrics - Inspection of "Fix namespace issue" - DanySpin97/PhpBotFramework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

unknown

created 2017-01-19 16:23 UTC

BotState::getStatus() A

↳ Parent: BotState

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	9

Duplication

Lines	7
Ratio	33.33 %

Importance

Changes

Metric	Value
dl	7
loc	21
rs	9.3142
c	0
b	0
f	0
cc	3
eloc	9
nc	3
nop	1

<?php

namespace PhpBotFramework\Utilities;

trait BotState {

    /**
     * \addtogroup State
     * \brief Create a state based bot using these methods.
     * \details Bot will answer in different way based on the state.
     * Here is an example where we use save user credential using bot states:
     *
     *     <?php
     *
     *     // Include the framework
     *     require './vendor/autoload.php';
     *
     *     // Define bot state
     *     define("SEND_USERNAME", 1);
     *     define("SEND_PASSWORD", 2);
     *
     *     // Create the class for the bot that will handle login
     *     class LoginBot extends DanySpin97\PhpBotFramework\Bot {
     *
     *         // Add the function for processing messages
     *         protected function processMessage($message) {
     *
     *             switch($this->getStatus()) {
     *
     *                 // If we are expecting a username from the user
     *                 case SEND_USERNAME:
     *
     *                     // Save the username
     *
     *                     // Say the user to insert the password
     *                     $this->sendMessage("Please, send your password.");
     *
     *                     // Update the bot state
     *                     $this->setStatus(SEND_PASSWORD);
     *
     *                     break;
     *
     *                 // Or if we are expecting a password from the user
     *                 case SEND_PASSWORD:
     *
     *                     // Save the password
     *
     *                     // Say the user he completed the process
     *                     $this->sendMessage("The registration is complete");
     *
     *                     break;
     *                 }
     *
     *         }
     *
     *     }
     *
     *     // Create the bot
     *     $bot = new LoginBot("token");
     *
     *     // Create redis object
     *     $bot->redis = new Redis();
     *
     *     // Connect to redis database
     *     $bot->redis->connect('127.0.0.1');
     *
     *     // Create the awnser to the <code>/start</code> command
     *     $start_closure = function($bot, $message) {
     *
     *         // saying the user to enter a username
     *         $bot->sendMessage("Please, send your username.");
     *
     *         // and update the status
     *         $bot->setStatus(SEND_USERNAME);
     *     };
     *
     *     // Add the answer
     *     $bot->addMessageCommand("start", $start_closure);
     *
     *     $bot->getUpdatesLocal();
     * @{
     */

    /** \brief Status of the bot to handle data inserting and menu-like bot. */
    public $status;

    /**
     * \brief Get current user status from redis and set it in status variable.
     * \details Throw exception if redis connection is missing.
     * @param $default_status <i>Optional</i>. The default status to return in case there is no status for the current user.
     * @return The status for the current user, $default_status if missing.
     */
    public function getStatus(int $default_status = -1) : int {

        if (!isset($this->redis)) {

            throw new BotException('Redis connection not set');

        }

        if ($this->redis->exists($this->_chat_id . ':status')) {


            $this->status = $this->redis->get($this->_chat_id . ':status');
class MyClass { }

$x = new MyClass();
$x->foo = true;

            return $this->status;

        }

        $this->redis->set($this->_chat_id . ':status', $default_status);
        $this->status = $default_status;
        return $default_status;

    }

    /** \brief Set the status of the bot in both redis and $status.
     * \details Throw exception if redis connection is missing.
     * @param $status The new status of the bot.
     */
    public function setStatus(int $status) {

        $this->redis->set($this->_chat_id . ':status', $status);

        $this->status = $status;

    }

    /** @} */

}


1		<?php
2
3		namespace PhpBotFramework\Utilities;
4
5		trait BotState {
6
7		/**
8		* \addtogroup State
9		* \brief Create a state based bot using these methods.
10		* \details Bot will answer in different way based on the state.
11		* Here is an example where we use save user credential using bot states:
12		*
13		* <?php
14		*
15		* // Include the framework
16		* require './vendor/autoload.php';
17		*
18		* // Define bot state
19		* define("SEND_USERNAME", 1);
20		* define("SEND_PASSWORD", 2);
21		*
22		* // Create the class for the bot that will handle login
23		* class LoginBot extends DanySpin97\PhpBotFramework\Bot {
24		*
25		* // Add the function for processing messages
26		* protected function processMessage($message) {
27		*
28		* switch($this->getStatus()) {
29		*
30		* // If we are expecting a username from the user
31		* case SEND_USERNAME:
32		*
33		* // Save the username
34		*
35		* // Say the user to insert the password
36		* $this->sendMessage("Please, send your password.");
37		*
38		* // Update the bot state
39		* $this->setStatus(SEND_PASSWORD);
40		*
41		* break;
42		*
43		* // Or if we are expecting a password from the user
44		* case SEND_PASSWORD:
45		*
46		* // Save the password
47		*
48		* // Say the user he completed the process
49		* $this->sendMessage("The registration is complete");
50		*
51		* break;
52		* }
53		*
54		* }
55		*
56		* }
57		*
58		* // Create the bot
59		* $bot = new LoginBot("token");
60		*
61		* // Create redis object
62		* $bot->redis = new Redis();
63		*
64		* // Connect to redis database
65		* $bot->redis->connect('127.0.0.1');
66		*
67		* // Create the awnser to the <code>/start</code> command
68		* $start_closure = function($bot, $message) {
69		*
70		* // saying the user to enter a username
71		* $bot->sendMessage("Please, send your username.");
72		*
73		* // and update the status
74		* $bot->setStatus(SEND_USERNAME);
75		* };
76		*
77		* // Add the answer
78		* $bot->addMessageCommand("start", $start_closure);
79		*
80		* $bot->getUpdatesLocal();
81		* @{
82		*/
83
84		/** \brief Status of the bot to handle data inserting and menu-like bot. */
85		public $status;
86
87		/**
88		* \brief Get current user status from redis and set it in status variable.
89		* \details Throw exception if redis connection is missing.
90		* @param $default_status <i>Optional</i>. The default status to return in case there is no status for the current user.
91		* @return The status for the current user, $default_status if missing.
92		*/
93		public function getStatus(int $default_status = -1) : int {
94
95		if (!isset($this->redis)) {
96
97		throw new BotException('Redis connection not set');
98
99		}
100
101	View Code Duplication	if ($this->redis->exists($this->_chat_id . ':status')) {
		1 ignored issue – show Duplication introduced 2017-01-18 12:15 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...
102
103		$this->status = $this->redis->get($this->_chat_id . ':status');
		0 ignored issues – show Bug introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report The property `redis` 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... Bug introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report The property `_chat_id` 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...
104
105		return $this->status;
106
107		}
108
109		$this->redis->set($this->_chat_id . ':status', $default_status);
110		$this->status = $default_status;
111		return $default_status;
112
113		}
114
115		/** \brief Set the status of the bot in both redis and $status.
116		* \details Throw exception if redis connection is missing.
117		* @param $status The new status of the bot.
118		*/
119		public function setStatus(int $status) {
120
121		$this->redis->set($this->_chat_id . ':status', $status);
122
123		$this->status = $status;
124
125		}
126
127		/** @} */
128
129		}
130

DanySpin97 / PhpBotFramework

Pull Request — master (#20)

BotState::getStatus() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like