Keyboard::createFromParams() - Code Metrics - Inspection of "Refactor entities" - akalongman/php-telegram-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#291)

by Armando

created 2016-10-10 21:52 UTC

Keyboard::createFromParams() C

↳ Parent: Keyboard

Complexity

Conditions	8
Paths	54

Size

Total Lines	37
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	19
CRAP Score	8

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	37
ccs	19
cts	19
cp	1
rs	5.3846
cc	8
eloc	19
nc	54
nop	0
crap	8

<?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.
 *
 * Written by Marco Boretto <[email protected]>
 */

namespace Longman\TelegramBot\Entities;

use Longman\TelegramBot\Exception\TelegramException;

/**
 * Class Keyboard
 *
 * @link https://core.telegram.org/bots/api#replykeyboardmarkup
 *
 * @method bool getResizeKeyboard()  Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
 * @method bool getOneTimeKeyboard() Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
 * @method bool getSelective()       Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
 *
 * @method $this setResizeKeyboard(bool $resize_keyboard)    Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
 * @method $this setOneTimeKeyboard(bool $one_time_keyboard) Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
 * @method $this setSelective(bool $selective)               Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
 */
class Keyboard extends Entity
{
    /**
     * {@inheritdoc}
     */
    public function __construct($data = [])
    {
        $data = call_user_func_array([$this, 'createFromParams'], func_get_args());
        parent::__construct($data);

        // Remove any empty buttons.
        $this->{$this->getKeyboardType()} = array_filter($this->{$this->getKeyboardType()});
    }

    /**
     * If this keyboard is an inline keyboard.
     *
     * @return bool
     */
    public function isInlineKeyboard()
    {
        return $this instanceof InlineKeyboard;
    }

    /**
     * Get the proper keyboard button class for this keyboard.
     *
     * @return KeyboardButton|InlineKeyboardButton
     */
    public function getKeyboardButtonClass()
    {
        return $this->isInlineKeyboard() ? InlineKeyboardButton::class : KeyboardButton::class;
    }

    /**
     * Get the type of keyboard, either "inline_keyboard" or "keyboard".
     *
     * @return string
     */
    public function getKeyboardType()
    {
        return $this->isInlineKeyboard() ? 'inline_keyboard' : 'keyboard';
    }

    /**
     * If no explicit keyboard is passed, try to create one from the parameters.
     *
     * @return array
     */
    protected function createFromParams()
    {
        $keyboard_type = $this->getKeyboardType();

        $args = func_get_args();

        // Force button parameters into individual rows.
        foreach ($args as &$arg) {
            !is_array($arg) && $arg = [$arg];
        }
        unset($arg);

        $data = reset($args);

        if ($from_data = array_key_exists($keyboard_type, (array)$data)) {
            $args = $data[$keyboard_type];

            // Make sure we're working with a proper row.
            if (!is_array($args)) {
                $args = [];
            }
        }

        $new_keyboard = [];
        foreach ($args as $row) {
            $new_keyboard[] = $this->parseRow($row);
        }

        if (!empty($new_keyboard)) {
            if (!$from_data) {
                $data = [];
            }
            $data[$keyboard_type] = $new_keyboard;
        }

        return $data;
    }

    /**
     * Create a new row in keyboard and add buttons.
     *
     * @return $this
     */
    public function addRow()
    {
        if (($new_row = $this->parseRow(func_get_args())) !== null) {
            $this->{$this->getKeyboardType()}[] = $new_row;
        }

        return $this;
    }

    /**
     * Parse a given row to the correct array format.
     *
     * @param array $row
     *
     * @return array
     */
    protected function parseRow($row)
    {
        if (!is_array($row)) {
            return null;
        }

        $new_row = [];
        foreach ($row as $button) {
            if (($new_button = $this->parseButton($button)) !== null) {
                $new_row[] = $new_button;
            }
        }

        return $new_row;
    }

    /**
     * Parse a given button to the correct KeyboardButton object type.
     *
     * @param array|string|\Longman\TelegramBot\Entities\KeyboardButton $button
     *
     * @return \Longman\TelegramBot\Entities\KeyboardButton|null
     */
    protected function parseButton($button)
    {
        $button_class = $this->getKeyboardButtonClass();

        if ($button instanceof $button_class) {
            return $button;
        }

        if (!$this->isInlineKeyboard() || $button_class::couldBe($button)) {
            return new $button_class($button);
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    protected function validate()

    {
        $keyboard = $this->getProperty('keyboard');

        if ($keyboard !== null) {
            if (!is_array($keyboard)) {
                throw new TelegramException('Keyboard field is not an array!');
            }

            foreach ($keyboard as $item) {
                if (!is_array($item)) {
                    throw new TelegramException('Keyboard subfield is not an array!');
                }
            }
        }
    }

    /**
     * Hide the current custom keyboard and display the default letter-keyboard.
     *
     * @link https://core.telegram.org/bots/api#replykeyboardhide
     *
     * @param array $data
     *
     * @return \Longman\TelegramBot\Entities\Keyboard
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public static function hide(array $data = [])
    {
        return new static(array_merge(['keyboard' => [], 'hide_keyboard' => true, 'selective' => false], $data));
    }

    /**
     * Display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply').
     *
     * @link https://core.telegram.org/bots/api#forcereply
     *
     * @param array $data
     *
     * @return \Longman\TelegramBot\Entities\Keyboard
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public static function forceReply(array $data = [])
    {
        return new static(array_merge(['keyboard' => [], 'force_reply' => true, 'selective' => false], $data));
    }
}


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			* Written by Marco Boretto <[email protected]>
11			*/
12
13			namespace Longman\TelegramBot\Entities;
14
15			use Longman\TelegramBot\Exception\TelegramException;
16
17			/**
18			* Class Keyboard
19			*
20			* @link https://core.telegram.org/bots/api#replykeyboardmarkup
21			*
22			* @method bool getResizeKeyboard() Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
23			* @method bool getOneTimeKeyboard() Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
24			* @method bool getSelective() Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
25			*
26			* @method $this setResizeKeyboard(bool $resize_keyboard) Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
27			* @method $this setOneTimeKeyboard(bool $one_time_keyboard) Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat – the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
28			* @method $this setSelective(bool $selective) Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
29			*/
30			class Keyboard extends Entity
31			{
32			/**
33			* {@inheritdoc}
34			*/
35	18		public function __construct($data = [])
36			{
37	18		$data = call_user_func_array([$this, 'createFromParams'], func_get_args());
38	18		parent::__construct($data);
39
40			// Remove any empty buttons.
41	14		$this->{$this->getKeyboardType()} = array_filter($this->{$this->getKeyboardType()});
42	14		}
43
44			/**
45			* If this keyboard is an inline keyboard.
46			*
47			* @return bool
48			*/
49	18		public function isInlineKeyboard()
50			{
51	18		return $this instanceof InlineKeyboard;
52			}
53
54			/**
55			* Get the proper keyboard button class for this keyboard.
56			*
57			* @return KeyboardButton\|InlineKeyboardButton
58			*/
59	12		public function getKeyboardButtonClass()
60			{
61	12		return $this->isInlineKeyboard() ? InlineKeyboardButton::class : KeyboardButton::class;
62			}
63
64			/**
65			* Get the type of keyboard, either "inline_keyboard" or "keyboard".
66			*
67			* @return string
68			*/
69	18		public function getKeyboardType()
70			{
71	18		return $this->isInlineKeyboard() ? 'inline_keyboard' : 'keyboard';
72			}
73
74			/**
75			* If no explicit keyboard is passed, try to create one from the parameters.
76			*
77			* @return array
78			*/
79	18		protected function createFromParams()
80			{
81	18		$keyboard_type = $this->getKeyboardType();
82
83	18		$args = func_get_args();
84
85			// Force button parameters into individual rows.
86	18		foreach ($args as &$arg) {
87	18		!is_array($arg) && $arg = [$arg];
88			}
89	18		unset($arg);
90
91	18		$data = reset($args);
92
93	18		if ($from_data = array_key_exists($keyboard_type, (array)$data)) {
94	11		$args = $data[$keyboard_type];
95
96			// Make sure we're working with a proper row.
97	11		if (!is_array($args)) {
98	2		$args = [];
99			}
100			}
101
102	18		$new_keyboard = [];
103	18		foreach ($args as $row) {
104	15		$new_keyboard[] = $this->parseRow($row);
105			}
106
107	18		if (!empty($new_keyboard)) {
108	15		if (!$from_data) {
109	12		$data = [];
110			}
111	15		$data[$keyboard_type] = $new_keyboard;
112			}
113
114	18		return $data;
115			}
116
117			/**
118			* Create a new row in keyboard and add buttons.
119			*
120			* @return $this
121			*/
122	2		public function addRow()
123			{
124	2		if (($new_row = $this->parseRow(func_get_args())) !== null) {
125	2		$this->{$this->getKeyboardType()}[] = $new_row;
126			}
127
128	2		return $this;
129			}
130
131			/**
132			* Parse a given row to the correct array format.
133			*
134			* @param array $row
135			*
136			* @return array
137			*/
138	15		protected function parseRow($row)
139			{
140	15		if (!is_array($row)) {
141	2		return null;
142			}
143
144	13		$new_row = [];
145	13		foreach ($row as $button) {
146	12		if (($new_button = $this->parseButton($button)) !== null) {
147	12		$new_row[] = $new_button;
148			}
149			}
150
151	13		return $new_row;
152			}
153
154			/**
155			* Parse a given button to the correct KeyboardButton object type.
156			*
157			* @param array\|string\|\Longman\TelegramBot\Entities\KeyboardButton $button
158			*
159			* @return \Longman\TelegramBot\Entities\KeyboardButton\|null
160			*/
161	12		protected function parseButton($button)
162			{
163	12		$button_class = $this->getKeyboardButtonClass();
164
165	12		if ($button instanceof $button_class) {
166	6		return $button;
167			}
168
169	6		if (!$this->isInlineKeyboard() \|\| $button_class::couldBe($button)) {
170	6		return new $button_class($button);
171			}
172
173			return null;
174			}
175
176			/**
177			* {@inheritdoc}
178			*/
179	11	View Code Duplication	protected function validate()
			0 ignored issues – show Duplication introduced 2016-09-23 14:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
180			{
181	11		$keyboard = $this->getProperty('keyboard');
182
183	11		if ($keyboard !== null) {
184	11		if (!is_array($keyboard)) {
185	1		throw new TelegramException('Keyboard field is not an array!');
186			}
187
188	10		foreach ($keyboard as $item) {
189	9		if (!is_array($item)) {
190	9		throw new TelegramException('Keyboard subfield is not an array!');
191			}
192			}
193			}
194	9		}
195
196			/**
197			* Hide the current custom keyboard and display the default letter-keyboard.
198			*
199			* @link https://core.telegram.org/bots/api#replykeyboardhide
200			*
201			* @param array $data
202			*
203			* @return \Longman\TelegramBot\Entities\Keyboard
204			* @throws \Longman\TelegramBot\Exception\TelegramException
205			*/
206	1		public static function hide(array $data = [])
207			{
208	1		return new static(array_merge(['keyboard' => [], 'hide_keyboard' => true, 'selective' => false], $data));
209			}
210
211			/**
212			* Display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply').
213			*
214			* @link https://core.telegram.org/bots/api#forcereply
215			*
216			* @param array $data
217			*
218			* @return \Longman\TelegramBot\Entities\Keyboard
219			* @throws \Longman\TelegramBot\Exception\TelegramException
220			*/
221	1		public static function forceReply(array $data = [])
222			{
223	1		return new static(array_merge(['keyboard' => [], 'force_reply' => true, 'selective' => false], $data));
224			}
225			}
226

akalongman / php-telegram-bot

Pull Request — develop (#291)

Keyboard::createFromParams() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like