ChatNotification::getMessage() - Code Metrics - Inspection of "#35 - add more admin commands, also controller sen..." - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev ( ade326...e1b211 )

unknown

created 2017-07-19 15:39 UTC

ChatNotification::getMessage() A

↳ Parent: ChatNotification

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace eXpansion\Framework\Core\Helpers;

use eXpansion\Framework\Core\Model\Helpers\ChatNotificationInterface;
use eXpansion\Framework\Core\Services\Console;
use eXpansion\Framework\Core\Storage\PlayerStorage;
use Maniaplanet\DedicatedServer\Connection;

/**
 * Class ChatNotification
 *
 * @package eXpansion\Framework\Core\Helpers;
 * @author oliver de Cramer <[email protected]>
 */
class ChatNotification implements ChatNotificationInterface
{
    /** @var  Connection */
    protected $connection;

    /** @var Translations */
    protected $translations;

    /** @var PlayerStorage */
    protected $playerStorage;

    /** @var Console */
    protected $console;

    /**
     * ChatNotification constructor.
     *
     * @param Connection $connection
     * @param Translations $translations
     * @param PlayerStorage $playerStorage
     */
    public function __construct(
        Connection $connection,
        Translations $translations,
        PlayerStorage $playerStorage,
        Console $console
    ) {
        $this->connection = $connection;
        $this->translations = $translations;
        $this->playerStorage = $playerStorage;
        $this->console = $console;
    }

    /**
     * Send message.
     *
     * @param string $messageId
     * @param string|string[]|null $to
     * @param string[] $parameters
     */
    public function sendMessage($messageId, $to = null, $parameters = [])
    {
        $message = $messageId;

        if (is_string($to)) {
            $player = $this->playerStorage->getPlayerInfo($to);
            $message = $this->translations->getTranslation($messageId, $parameters, strtolower($player->getLanguage()));
        }

        if (is_array($to)) {

            $to = implode(",", $to);
            $message = $this->translations->getTranslations($messageId, $parameters);
        }

        if ($to === null) {

            $message = $this->translations->getTranslations($messageId, $parameters);
            $this->console->writeln(end($message)['Text']);
        }

        $this->connection->chatSendServerMessage($message, $to);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

    }

    /**
     * Return messageId with arguments as a string
     * Usage: used for retrieving partials for chat messages
     *  * defaults to English locale, without parameters
     *
     * @param $messageId
     * @param array $parameters
     * @param string $locale
     * @return mixed
     */
    public function getMessage($messageId, $parameters = [], $locale = "en")
    {
        return $this->translations->getTranslation($messageId, $parameters, $locale);
    }


}


1			<?php
2
3			namespace eXpansion\Framework\Core\Helpers;
4
5			use eXpansion\Framework\Core\Model\Helpers\ChatNotificationInterface;
6			use eXpansion\Framework\Core\Services\Console;
7			use eXpansion\Framework\Core\Storage\PlayerStorage;
8			use Maniaplanet\DedicatedServer\Connection;
9
10			/**
11			* Class ChatNotification
12			*
13			* @package eXpansion\Framework\Core\Helpers;
14			* @author oliver de Cramer <[email protected]>
15			*/
16			class ChatNotification implements ChatNotificationInterface
17			{
18			/** @var Connection */
19			protected $connection;
20
21			/** @var Translations */
22			protected $translations;
23
24			/** @var PlayerStorage */
25			protected $playerStorage;
26
27			/** @var Console */
28			protected $console;
29
30			/**
31			* ChatNotification constructor.
32			*
33			* @param Connection $connection
34			* @param Translations $translations
35			* @param PlayerStorage $playerStorage
36			*/
37	6		public function __construct(
38			Connection $connection,
39			Translations $translations,
40			PlayerStorage $playerStorage,
41			Console $console
42			) {
43	6		$this->connection = $connection;
44	6		$this->translations = $translations;
45	6		$this->playerStorage = $playerStorage;
46	6		$this->console = $console;
47	6		}
48
49			/**
50			* Send message.
51			*
52			* @param string $messageId
53			* @param string\|string[]\|null $to
54			* @param string[] $parameters
55			*/
56	2		public function sendMessage($messageId, $to = null, $parameters = [])
57			{
58	2		$message = $messageId;
59
60	2		if (is_string($to)) {
61	1		$player = $this->playerStorage->getPlayerInfo($to);
62	1		$message = $this->translations->getTranslation($messageId, $parameters, strtolower($player->getLanguage()));
63			}
64
65	2	View Code Duplication	if (is_array($to)) {
			0 ignored issues – show Duplication introduced 2017-07-19 15:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
66			$to = implode(",", $to);
67			$message = $this->translations->getTranslations($messageId, $parameters);
68			}
69
70	2	View Code Duplication	if ($to === null) {
			0 ignored issues – show Duplication introduced 2017-07-19 15:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
71	1		$message = $this->translations->getTranslations($messageId, $parameters);
72	1		$this->console->writeln(end($message)['Text']);
73			}
74
75	2		$this->connection->chatSendServerMessage($message, $to);
			0 ignored issues – show Bug introduced 2017-07-19 15:42 UTC by Report Bug Copy Issue Report It seems like `$message` can also be of type `array`; however, `Maniaplanet\DedicatedSer...chatSendServerMessage()` does only seem to accept `string\|array<integer,array<integer,string>>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
76
77	2		}
78
79			/**
80			* Return messageId with arguments as a string
81			* Usage: used for retrieving partials for chat messages
82			* * defaults to English locale, without parameters
83			*
84			* @param $messageId
85			* @param array $parameters
86			* @param string $locale
87			* @return mixed
88			*/
89			public function getMessage($messageId, $parameters = [], $locale = "en")
90			{
91			return $this->translations->getTranslation($messageId, $parameters, $locale);
92			}
93
94
95			}
96

eXpansionPluginPack / eXpansion2

Push — dev ( ade326...e1b211 )

ChatNotification::getMessage() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like