PhpBotFramework\Commands\CallbackCommand

Complexity

Total Complexity

5

Size/Duplication

Total Lines	64
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	addCallbackCommand()	0	7	1
A	processCallbackCommand()	0	17	4

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

use PhpBotFramework\Entities\CallbackQuery;

/**
 * \addtogroup Modules
 * @{
 */

/** \class CallbackCommand
 */
trait CallbackCommand
{
    /** @} */

    /** \brief Chat ID of the current user/group/channel. */
    protected $_chat_id;

    /**
     * \addtogroup Bot Bot
     * @{
     */

    /**
     * \addtogroup Commands
     * @{
     */

    /** \brief Store the command triggered on callback query. */
    protected $_callback_commands;

    /**
     * \brief Add a function that will be executed everytime a callback query contains a string as data
     * \details Use this syntax:
     *
     *     addMessageCommand("menu", function($bot, $callback_query) {
     *         $bot->editMessageText($callback_query['message']['message_id'], "This is the menu"); });
     * @param string $data The string that will trigger this function.
     * @param callable $script The function that will be triggered by the callback query if it contains the $data string. Must take an object(the bot) and an array(the callback query received).
     */
    public function addCallbackCommand(string $data, callable $script)
    {
        $this->_callback_commands[] = [
            'data' => $data,
            'script' => $script,
        ];
    }

    /**
     * \brief (<i>Internal</i>) Process the callback query and check if it triggers a command of this type.
     * @param array $callback_query Callback query to process.
     * @return bool True if the callback query triggered a command.
     */
    protected function processCallbackCommand(array $callback_query) : bool
    {
        // Check for callback commands
        if (isset($callback_query['data'])) {
            foreach ($this->_callback_commands as $trigger) {
                // If command is found in callback data
                if (strpos($trigger['data'], $callback_query['data']) !== false) {
                    $this->_chat_id = $callback_query['message']['chat']['id'];
                    $trigger['script']($this, new CallbackQuery($callback_query));

                    return true;
                }
            }
        }

        return false;
    }

    /** @} */

    /** @} */
}