CommandHandler::addCommands() - Code Metrics - Inspection of "Add addCommands" - DanySpin97/PhpBotFramework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eb2792...7a67a4 )

unknown

created 2017-06-07 15:28 UTC

CommandHandler::addCommands() A

↳ Parent: CommandHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	2

Importance

Changes

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

<?php

/*
 * This file is part of the PhpBotFramework.
 *
 * PhpBotFramework is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, version 3.
 *
 * PhpBotFramework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

namespace PhpBotFramework\Commands;

/*
 * \class CommandHandler
 * \brief Handle all bot commands.
 * \details Add commands, check if commands trigger a user update.
 */
trait CommandHandler
{
    /**
     * \addtogroup Commands
     * \brief Bots command and usage.
     * @{
     */

    /** @internal
     * \brief Contains all command used by the bot. */
    private $_commands = [];

    /**
     * @internal
     * \brief Initialize commands to speed up processing.
     * \details Get all command that the bot handle, and put them in priority.
     */
    protected function initCommands()
    {
        $commands_temp = $this->_commands;
        $this->_commands = [];

        // Iterate over each
        foreach ($commands_temp as $command) {
            $this->_commands[$command::$type][] = $command;
        }

        foreach ($this->_commands as $index => $array) {
        // Sort them by priority
            uasort($this->_commands[$index], 'PhpBotFramework\Commands\CommandHandler::sortingPrior');
        }
    }

    /**
     * @internal
     * \brief Process updates prioritizing bot's commands over the general methods (e.g. BaseBot::processMessage())
     * @param array $update Update to process.
     * @return bool True if this update trigger any command.
     */
    protected function processCommands(array $update) : bool
    {
        // For each command active (checked by initCommands())
        foreach ($this->_commands as $entity => $commands) {
            foreach ($commands as $command) {
                // If the update type is right and the update triggered a command
                if (isset($update[$entity]) && $command->checkCommand($update[$entity])) {
                    $entity = new $command::$object_class($update[$entity]);
                    $this->_chat_id = $entity->getChatID();
class MyClass { }

$x = new MyClass();
$x->foo = true;
                    $command->getScript()($this, $entity);
                    // Return the id as we already processed this update
                    return true;
                }
            }
        }

        // Return -1 because this update didn't trigger any command.
        return false;
    }

    /**
     * \brief Add a command to the bot.
     * @param BasicCommand $command Command to add. Must be an object that inherits BasicCommand class.
     */
    public function addCommand(BasicCommand $command)
    {
        $this->_commands[] = $command;
    }

    /**
     * \brief Add various commands at once.
     * @param ...BasicCommand $commands The commands to add.

     */
    public function addCommands(BasicCommand ...$commands)
    {
      foreach ($commands as $command) {
            $this->addCommand($command);
        }
    }

    /**
     * \brief Add a message command to the bot.
     * @param string $command The command that will trigger the function (e.g. start).
     * @param callable $script The function that will be triggered by a command.
     */
    public function addMessageCommand(string $command, callable $script)
    {
      $this->_commands[] = new MessageCommand($command, $script);
    }

    /**
     * \brief Add a callback command to the bot.
     * @param string $data The data that will trigger the function.
     * @param callable $script The function that will be triggered by the data.
     */
    public function addCallbackCommand(string $data, callable $script)
    {
      $this->_commands[] = new CallbackCommand($data, $script);
    }

    /**
     * @internal
     * \brief Sort an array based on <code>prior</code> index value.
     * @param array $a First array.
     * @param array $b Second array.
     * @return int 1 If $a > $b, -1 if $a < $b, 0 otherwise.
     */
    public static function sortingPrior($a, $b)
    {
        $prior_a = $a::$priority;
        $prior_b = $b::$priority;
        if ($prior_a > $prior_b) {
            return 1;
        }

        if ($prior_a < $prior_b) {
            return -1;
        }

        if ($prior_a == $prior_b) {
            return 0;
        }
    }

    /** @} */
}


1		<?php
2
3		/*
4		* This file is part of the PhpBotFramework.
5		*
6		* PhpBotFramework is free software: you can redistribute it and/or modify
7		* it under the terms of the GNU Lesser General Public License as
8		* published by the Free Software Foundation, version 3.
9		*
10		* PhpBotFramework is distributed in the hope that it will be useful, but
11		* WITHOUT ANY WARRANTY; without even the implied warranty of
12		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13		* Lesser General Public License for more details.
14		*
15		* You should have received a copy of the GNU Lesser General Public License
16		* along with this program. If not, see <http://www.gnu.org/licenses/>.
17		*/
18
19		namespace PhpBotFramework\Commands;
20
21		/*
22		* \class CommandHandler
23		* \brief Handle all bot commands.
24		* \details Add commands, check if commands trigger a user update.
25		*/
26		trait CommandHandler
27		{
28		/**
29		* \addtogroup Commands
30		* \brief Bots command and usage.
31		* @{
32		*/
33
34		/** @internal
35		* \brief Contains all command used by the bot. */
36		private $_commands = [];
37
38		/**
39		* @internal
40		* \brief Initialize commands to speed up processing.
41		* \details Get all command that the bot handle, and put them in priority.
42		*/
43	3	protected function initCommands()
44		{
45	3	$commands_temp = $this->_commands;
46	3	$this->_commands = [];
47
48		// Iterate over each
49	3	foreach ($commands_temp as $command) {
50	1	$this->_commands[$command::$type][] = $command;
51		}
52
53	3	foreach ($this->_commands as $index => $array) {
54		// Sort them by priority
55	1	uasort($this->_commands[$index], 'PhpBotFramework\Commands\CommandHandler::sortingPrior');
56		}
57	3	}
58
59		/**
60		* @internal
61		* \brief Process updates prioritizing bot's commands over the general methods (e.g. BaseBot::processMessage())
62		* @param array $update Update to process.
63		* @return bool True if this update trigger any command.
64		*/
65	5	protected function processCommands(array $update) : bool
66		{
67		// For each command active (checked by initCommands())
68	5	foreach ($this->_commands as $entity => $commands) {
69	3	foreach ($commands as $command) {
70		// If the update type is right and the update triggered a command
71	3	if (isset($update[$entity]) && $command->checkCommand($update[$entity])) {
72	3	$entity = new $command::$object_class($update[$entity]);
73	3	$this->_chat_id = $entity->getChatID();
		0 ignored issues – show Bug introduced 2017-03-02 18:47 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...
74	3	$command->getScript()($this, $entity);
75		// Return the id as we already processed this update
76	3	return true;
77		}
78		}
79		}
80
81		// Return -1 because this update didn't trigger any command.
82	2	return false;
83		}
84
85		/**
86		* \brief Add a command to the bot.
87		* @param BasicCommand $command Command to add. Must be an object that inherits BasicCommand class.
88		*/
89	2	public function addCommand(BasicCommand $command)
90		{
91	2	$this->_commands[] = $command;
92	2	}
93
94		/**
95		* \brief Add various commands at once.
96		* @param ...BasicCommand $commands The commands to add.
		0 ignored issues – show Documentation introduced 2017-06-07 15:33 UTC by Report Bug Copy Issue Report The doc-type `...BasicCommand` could not be parsed: Unknown type name "...BasicCommand" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
97		*/
98	1	public function addCommands(BasicCommand ...$commands)
99		{
100	1	foreach ($commands as $command) {
101	1	$this->addCommand($command);
102		}
103	1	}
104
105		/**
106		* \brief Add a message command to the bot.
107		* @param string $command The command that will trigger the function (e.g. start).
108		* @param callable $script The function that will be triggered by a command.
109		*/
110	1	public function addMessageCommand(string $command, callable $script)
111		{
112	1	$this->_commands[] = new MessageCommand($command, $script);
113	1	}
114
115		/**
116		* \brief Add a callback command to the bot.
117		* @param string $data The data that will trigger the function.
118		* @param callable $script The function that will be triggered by the data.
119		*/
120		public function addCallbackCommand(string $data, callable $script)
121		{
122		$this->_commands[] = new CallbackCommand($data, $script);
123		}
124
125		/**
126		* @internal
127		* \brief Sort an array based on <code>prior</code> index value.
128		* @param array $a First array.
129		* @param array $b Second array.
130		* @return int 1 If $a > $b, -1 if $a < $b, 0 otherwise.
131		*/
132		public static function sortingPrior($a, $b)
133		{
134		$prior_a = $a::$priority;
135		$prior_b = $b::$priority;
136		if ($prior_a > $prior_b) {
137		return 1;
138		}
139
140		if ($prior_a < $prior_b) {
141		return -1;
142		}
143
144		if ($prior_a == $prior_b) {
145		return 0;
146		}
147		}
148
149		/** @} */
150		}
151

DanySpin97 / PhpBotFramework

Push — master ( eb2792...7a67a4 )

CommandHandler::addCommands() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like