Entity::getBotName() - Code Metrics - Inspection of "Misc additions/changes" - akalongman/php-telegram-bot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#457)

unknown

created 2017-04-08 11:23 UTC

Entity::getBotName() A

↳ Parent: Entity

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

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

use Exception;
use Longman\TelegramBot\Entities\InlineQuery\InlineEntity;
use Longman\TelegramBot\TelegramLog;
use ReflectionObject;

/**
 * Class Entity
 *
 * This is the base class for all entities.
 *
 * @link https://core.telegram.org/bots/api#available-types
 *
 * @method array  getRawData()     Get the raw data passed to this entity
 * @method string getBotUsername() Return the bot name passed to this entity
 */
abstract class Entity
{
    /**
     * Entity constructor.
     *
     * @todo Get rid of the $bot_username, it shouldn't be here!
     *
     * @param array  $data
     * @param string $bot_username
     *
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    public function __construct($data, $bot_username = '')
    {
        //Make sure we're not raw_data inception-ing
        if (array_key_exists('raw_data', $data)) {
            if ($data['raw_data'] === null) {
                unset($data['raw_data']);
            }
        } else {
            $data['raw_data'] = $data;
        }

        $data['bot_username'] = $bot_username;
        $this->assignMemberVariables($data);
        $this->validate();
    }

    /**
     * Perform to json
     *
     * @return string
     */
    public function toJson()
    {
        return json_encode($this->getRawData());
    }

    /**
     * Perform to string
     *
     * @return string
     */
    public function __toString()
    {
        return $this->toJson();
    }

    /**
     * Helper to set member variables
     *
     * @param array $data
     */
    protected function assignMemberVariables(array $data)
    {
        foreach ($data as $key => $value) {
            $this->$key = $value;
        }
    }

    /**
     * Get the list of the properties that are themselves Entities
     *
     * @return array
     */
    protected function subEntities()
    {
        return [];
    }

    /**
     * Perform any special entity validation
     *
     * @throws \Longman\TelegramBot\Exception\TelegramException
     */
    protected function validate()
    {
    }

    /**
     * Get a property from the current Entity
     *
     * @param mixed $property
     * @param mixed $default
     *
     * @return mixed
     */
    public function getProperty($property, $default = null)
    {
        if (isset($this->$property)) {
            return $this->$property;
        }

        return $default;
    }

    /**
     * Return the variable for the called getter or magically set properties dynamically.
     *
     * @param $method
     * @param $args
     *
     * @return mixed|null
     */
    public function __call($method, $args)
    {
        //Convert method to snake_case (which is the name of the property)
        $property_name = ltrim(strtolower(preg_replace('/[A-Z]/', '_$0', substr($method, 3))), '_');

        $action = substr($method, 0, 3);
        if ($action === 'get') {
            $property = $this->getProperty($property_name);

            if ($property !== null) {
                //Get all sub-Entities of the current Entity
                $sub_entities = $this->subEntities();

                if (isset($sub_entities[$property_name])) {
                    return new $sub_entities[$property_name]($property, $this->getProperty('bot_username'));
                }

                return $property;
            }
        } elseif ($action === 'set') {
            // Limit setters to specific classes.
            if ($this instanceof InlineEntity || $this instanceof Keyboard || $this instanceof KeyboardButton) {
                $this->$property_name = $args[0];

                return $this;
            }
        }

        return null;
    }

    /**
     * Return an array of nice objects from an array of object arrays
     *
     * This method is used to generate pretty object arrays
     * mainly for PhotoSize and Entities object arrays.
     *
     * @param string $class
     * @param string $property
     *
     * @return array
     */
    protected function makePrettyObjectArray($class, $property)
    {
        $new_objects = [];

        try {
            if ($objects = $this->getProperty($property)) {
                foreach ($objects as $object) {
                    if (!empty($object)) {
                        $new_objects[] = new $class($object);
                    }
                }
            }
        } catch (Exception $e) {
            $new_objects = [];
        }

        return $new_objects;
    }

    /**
     * Escape markdown special characters
     *
     * @param string $string
     *
     * @return string
     */
    public function escapeMarkdown($string)
    {
        return str_replace(
            ['[', '`', '*', '_',],
            ['\[', '\`', '\*', '\_',],
            $string
        );
    }

    /**
     * Try to mention the user
     *
     * Mention the user with the username otherwise print first and last name
     * if the $escape_markdown argument is true special characters are escaped from the output
     *
     * @param bool $escape_markdown
     *
     * @return string|null
     */
    public function tryMention($escape_markdown = false)
    {
        //TryMention only makes sense for the User and Chat entity.
        if (!($this instanceof User || $this instanceof Chat)) {
            return null;
        }

        //Try with the username first...
        $name = $this->getProperty('username');
        $is_username = $name !== null;

        if ($name === null) {
            //...otherwise try with the names.
            $name      = $this->getProperty('first_name');
            $last_name = $this->getProperty('last_name');
            if ($last_name !== null) {
                $name .= ' ' . $last_name;
            }
        }

        if ($escape_markdown) {
            $name = $this->escapeMarkdown($name);
        }

        return ($is_username ? '@' : '') . $name;
    }

    /**
     * Get Bot name
     *
     * @todo: Left for backwards compatibility, remove in the future
     *
     * @return string
     */
    public function getBotName()
    {
        TelegramLog::debug('Usage of deprecated method getBotName() detected, please use getBotUsername() instead!');
        return $this->getBotUsername();
    }
}


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\Entities;
12
13		use Exception;
14		use Longman\TelegramBot\Entities\InlineQuery\InlineEntity;
15		use Longman\TelegramBot\TelegramLog;
16		use ReflectionObject;
17
18		/**
19		* Class Entity
20		*
21		* This is the base class for all entities.
22		*
23		* @link https://core.telegram.org/bots/api#available-types
24		*
25		* @method array getRawData() Get the raw data passed to this entity
26		* @method string getBotUsername() Return the bot name passed to this entity
27		*/
28		abstract class Entity
29		{
30		/**
31		* Entity constructor.
32		*
33		* @todo Get rid of the $bot_username, it shouldn't be here!
34		*
35		* @param array $data
36		* @param string $bot_username
37		*
38		* @throws \Longman\TelegramBot\Exception\TelegramException
39		*/
40	81	public function __construct($data, $bot_username = '')
41		{
42		//Make sure we're not raw_data inception-ing
43	81	if (array_key_exists('raw_data', $data)) {
44	15	if ($data['raw_data'] === null) {
45	15	unset($data['raw_data']);
46		}
47		} else {
48	75	$data['raw_data'] = $data;
49		}
50
51	81	$data['bot_username'] = $bot_username;
52	81	$this->assignMemberVariables($data);
53	81	$this->validate();
54	72	}
55
56		/**
57		* Perform to json
58		*
59		* @return string
60		*/
61	1	public function toJson()
62		{
63	1	return json_encode($this->getRawData());
64		}
65
66		/**
67		* Perform to string
68		*
69		* @return string
70		*/
71		public function __toString()
72		{
73		return $this->toJson();
74		}
75
76		/**
77		* Helper to set member variables
78		*
79		* @param array $data
80		*/
81	81	protected function assignMemberVariables(array $data)
82		{
83	81	foreach ($data as $key => $value) {
84	81	$this->$key = $value;
85		}
86	81	}
87
88		/**
89		* Get the list of the properties that are themselves Entities
90		*
91		* @return array
92		*/
93	56	protected function subEntities()
94		{
95	56	return [];
96		}
97
98		/**
99		* Perform any special entity validation
100		*
101		* @throws \Longman\TelegramBot\Exception\TelegramException
102		*/
103	54	protected function validate()
104		{
105	54	}
106
107		/**
108		* Get a property from the current Entity
109		*
110		* @param mixed $property
111		* @param mixed $default
112		*
113		* @return mixed
114		*/
115	76	public function getProperty($property, $default = null)
116		{
117	76	if (isset($this->$property)) {
118	71	return $this->$property;
119		}
120
121	43	return $default;
122		}
123
124		/**
125		* Return the variable for the called getter or magically set properties dynamically.
126		*
127		* @param $method
128		* @param $args
129		*
130		* @return mixed\|null
131		*/
132	63	public function __call($method, $args)
133		{
134		//Convert method to snake_case (which is the name of the property)
135	63	$property_name = ltrim(strtolower(preg_replace('/[A-Z]/', '_$0', substr($method, 3))), '_');
136
137	63	$action = substr($method, 0, 3);
138	63	if ($action === 'get') {
139	63	$property = $this->getProperty($property_name);
140
141	63	if ($property !== null) {
142		//Get all sub-Entities of the current Entity
143	60	$sub_entities = $this->subEntities();
144
145	60	if (isset($sub_entities[$property_name])) {
146	16	return new $sub_entities[$property_name]($property, $this->getProperty('bot_username'));
147		}
148
149	62	return $property;
150		}
151	3	} elseif ($action === 'set') {
152		// Limit setters to specific classes.
153	3	if ($this instanceof InlineEntity \|\| $this instanceof Keyboard \|\| $this instanceof KeyboardButton) {
154	3	$this->$property_name = $args[0];
155
156	3	return $this;
157		}
158		}
159
160	29	return null;
161		}
162
163		/**
164		* Return an array of nice objects from an array of object arrays
165		*
166		* This method is used to generate pretty object arrays
167		* mainly for PhotoSize and Entities object arrays.
168		*
169		* @param string $class
170		* @param string $property
171		*
172		* @return array
173		*/
174	6	protected function makePrettyObjectArray($class, $property)
175		{
176	6	$new_objects = [];
177
178		try {
179	6	if ($objects = $this->getProperty($property)) {
180		foreach ($objects as $object) {
181		if (!empty($object)) {
182	6	$new_objects[] = new $class($object);
183		}
184		}
185		}
186		} catch (Exception $e) {
187		$new_objects = [];
188		}
189
190	6	return $new_objects;
191		}
192
193		/**
194		* Escape markdown special characters
195		*
196		* @param string $string
197		*
198		* @return string
199		*/
200	1	public function escapeMarkdown($string)
201		{
202	1	return str_replace(
203	1	['[', '`', '*', '_',],
204	1	['\[', '\`', '\*', '\_',],
205		$string
206		);
207		}
208
209		/**
210		* Try to mention the user
211		*
212		* Mention the user with the username otherwise print first and last name
213		* if the $escape_markdown argument is true special characters are escaped from the output
214		*
215		* @param bool $escape_markdown
216		*
217		* @return string\|null
218		*/
219	3	public function tryMention($escape_markdown = false)
220		{
221		//TryMention only makes sense for the User and Chat entity.
222	3	if (!($this instanceof User \|\| $this instanceof Chat)) {
223		return null;
224		}
225
226		//Try with the username first...
227	3	$name = $this->getProperty('username');
228	3	$is_username = $name !== null;
229
230	3	if ($name === null) {
231		//...otherwise try with the names.
232	3	$name = $this->getProperty('first_name');
233	3	$last_name = $this->getProperty('last_name');
234	3	if ($last_name !== null) {
235	3	$name .= ' ' . $last_name;
236		}
237		}
238
239	3	if ($escape_markdown) {
240	1	$name = $this->escapeMarkdown($name);
241		}
242
243	3	return ($is_username ? '@' : '') . $name;
244		}
245
246		/**
247		* Get Bot name
248		*
249		* @todo: Left for backwards compatibility, remove in the future
250		*
251		* @return string
252		*/
253	1	public function getBotName()
254		{
255	1	TelegramLog::debug('Usage of deprecated method getBotName() detected, please use getBotUsername() instead!');
256	1	return $this->getBotUsername();
257		}
258		}
259

akalongman / php-telegram-bot

Pull Request — develop (#457)

Entity::getBotName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like