AbstractEntityEvent::getChatId() - Code Metrics - Inspection of "Removed unused USE statement" - rudestan/Teebot - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 64a210...2d6991 )

by Stan

created 2016-04-05 08:01 UTC

AbstractEntityEvent::getChatId() A

↳ Parent: AbstractEntityEvent

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	14
rs	9.4285
cc	3
eloc	7
nc	3
nop	0

<?php

/**
 * Abstract entity event class is base class for creating the events for received in response entities. It
 * includes methods to be able to quickly get a chat id and reply on message, get parent entity which
 * triggered this entity event.
 *
 * @package Teebot (Telegram bot framework)
 *
 * @author  Stanislav Drozdov <[email protected]>
 */

namespace Teebot\Command;

use Teebot\Method\SendMessage;
use Teebot\Entity\Message;
use Teebot\Entity\AbstractEntity;

abstract class AbstractEntityEvent
{
    /** @var AbstractEntity $entity */
    protected $entity = null;

    /**
     * Abstract method of each entity event which will be called if certain entity presents in response
     * and it's class exists or mapped in the config. 
     * 
     * @return null|bool
     */
    abstract public function run();

    /**
     * Returns chat id if the type of calling entity or it's parent is Message
     *
     * @return null|int
     */
    public function getChatId()
    {
        if ($this->entity instanceof Message) {
            return $this->entity->getChatId();
        }

        $parent = $this->entity->getParent();

        if ($parent instanceof Message) {
            return $parent->getChatId();
        }

        return null;
    }

    /**
     * Sets entity
     *
     * @param AbstractEntity $entity Entity object
     */
    public function setEntity(AbstractEntity $entity)
    {
        $this->entity = $entity;
    }

    /**
     * Sends text message to current chat
     *
     * @param string $text Message text
     *
     * @return bool|\Teebot\Response
     */
    protected function sendMessage($text)

    {
        $chatId = $this->getChatId();

        if (!$chatId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return false;
        }

        return (new SendMessage())
            ->setParent($this->entity)
            ->setChatId($chatId)
            ->setText($text)
            ->trigger();
    }

    /**
     * Replies on the message
     *
     * @param SendMessage $sendMessage Object of the SendMessage method
     *
     * @return bool|\Teebot\Response
     */
    protected function reply(SendMessage $sendMessage) {

        $chatId = $this->getChatId();

        if (!$chatId) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return false;
        }

        return $sendMessage
            ->setParent($this->entity)
            ->setChatId($chatId)
            ->trigger();
    }
}


1		<?php
2
3		/**
4		* Abstract entity event class is base class for creating the events for received in response entities. It
5		* includes methods to be able to quickly get a chat id and reply on message, get parent entity which
6		* triggered this entity event.
7		*
8		* @package Teebot (Telegram bot framework)
9		*
10		* @author Stanislav Drozdov <[email protected]>
11		*/
12
13		namespace Teebot\Command;
14
15		use Teebot\Method\SendMessage;
16		use Teebot\Entity\Message;
17		use Teebot\Entity\AbstractEntity;
18
19		abstract class AbstractEntityEvent
20		{
21		/** @var AbstractEntity $entity */
22		protected $entity = null;
23
24		/**
25		* Abstract method of each entity event which will be called if certain entity presents in response
26		* and it's class exists or mapped in the config.
27		*
28		* @return null\|bool
29		*/
30		abstract public function run();
31
32		/**
33		* Returns chat id if the type of calling entity or it's parent is Message
34		*
35		* @return null\|int
36		*/
37		public function getChatId()
38		{
39		if ($this->entity instanceof Message) {
40		return $this->entity->getChatId();
41		}
42
43		$parent = $this->entity->getParent();
44
45		if ($parent instanceof Message) {
46		return $parent->getChatId();
47		}
48
49		return null;
50		}
51
52		/**
53		* Sets entity
54		*
55		* @param AbstractEntity $entity Entity object
56		*/
57		public function setEntity(AbstractEntity $entity)
58		{
59		$this->entity = $entity;
60		}
61
62		/**
63		* Sends text message to current chat
64		*
65		* @param string $text Message text
66		*
67		* @return bool\|\Teebot\Response
68		*/
69	View Code Duplication	protected function sendMessage($text)
		0 ignored issues – show Duplication introduced 2016-04-05 08:04 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...
70		{
71		$chatId = $this->getChatId();
72
73		if (!$chatId) {
		0 ignored issues – show Bug Best Practice introduced 2016-04-05 08:04 UTC by Report Bug Copy Issue Report The expression `$chatId` of type `null\|integer` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
74		return false;
75		}
76
77		return (new SendMessage())
78		->setParent($this->entity)
79		->setChatId($chatId)
80		->setText($text)
81		->trigger();
82		}
83
84		/**
85		* Replies on the message
86		*
87		* @param SendMessage $sendMessage Object of the SendMessage method
88		*
89		* @return bool\|\Teebot\Response
90		*/
91	View Code Duplication	protected function reply(SendMessage $sendMessage) {
		0 ignored issues – show Duplication introduced 2016-04-05 08:04 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...
92		$chatId = $this->getChatId();
93
94		if (!$chatId) {
		0 ignored issues – show Bug Best Practice introduced 2016-04-05 08:04 UTC by Report Bug Copy Issue Report The expression `$chatId` of type `null\|integer` is loosely compared to `false`; this is ambiguous if the integer can be zero. You might want to explicitly use `=== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
95		return false;
96		}
97
98		return $sendMessage
99		->setParent($this->entity)
100		->setChatId($chatId)
101		->trigger();
102		}
103		}
104

rudestan / Teebot

GitHub Access Token became invalid

Push — master ( 64a210...2d6991 )

AbstractEntityEvent::getChatId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like