ChatNotification::__construct() - Code Metrics - Inspection of "WIP: Color configs" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#278)

by De Cramer

created 2018-02-24 13:24 UTC

ChatNotification::__construct() A

↳ Parent: ChatNotification

Complexity

Conditions	1
Paths	1

Size

Total Lines	13
Code Lines	11

Duplication

Lines	13
Ratio	100 %

Code Coverage

Tests	7
CRAP Score	1

Importance

Changes

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

<?php

namespace eXpansion\Framework\Core\Helpers;

use eXpansion\Framework\Core\Model\Helpers\ChatNotificationInterface;
use eXpansion\Framework\Core\Model\UserGroups\Group;
use eXpansion\Framework\Core\Services\Console;
use eXpansion\Framework\Core\Storage\PlayerStorage;
use Maniaplanet\DedicatedServer\Connection;
use Maniaplanet\DedicatedServer\InvalidArgumentException;
use Maniaplanet\DedicatedServer\Xmlrpc\UnknownPlayerException;
use Psr\Log\LoggerInterface;

/**
 * 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;
    /**
     * @var LoggerInterface
     */
    private $logger;

    /**
     * ChatNotification constructor.
     *
     * @param Connection      $connection
     * @param Translations    $translations
     * @param PlayerStorage   $playerStorage
     * @param Console         $console
     * @param LoggerInterface $logger
     */
    public function __construct(

        Connection $connection,
        Translations $translations,
        PlayerStorage $playerStorage,
        Console $console,
        LoggerInterface $logger
    ) {
        $this->connection = $connection;
        $this->translations = $translations;
        $this->playerStorage = $playerStorage;
        $this->console = $console;
        $this->logger = $logger;
    }

    /**
     * Send message.
     *
     * @param string                     $messageId
     * @param string|string[]|Group|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 instanceof Group) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $to = implode(",", $to->getLogins());
            $message = $this->translations->getTranslations($messageId, $parameters);
        }

        if ($to === null || $to instanceof Group) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $message = $this->translations->getTranslations($messageId, $parameters);
            $this->console->writeln(end($message)['Text']);
        }

        try {
            $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.
}
        } catch (UnknownPlayerException $e) {
            $this->logger->info("can't send chat message: $message", ["to" => $to, "exception" => $e]);
            // Nothing to do, it happens.
        } catch (InvalidArgumentException $ex) {
            // Nothing to do
        }
    }

    /**
     * Return messageId with arguments as a string
     * Usage: used for retrieving partials for chat messages
     *  * defaults to English locale, without parameters
     *
     * @param string $messageId
     * @param array  $parameters
     * @param string $locale
     * @return string
     */
    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\Model\UserGroups\Group;
7			use eXpansion\Framework\Core\Services\Console;
8			use eXpansion\Framework\Core\Storage\PlayerStorage;
9			use Maniaplanet\DedicatedServer\Connection;
10			use Maniaplanet\DedicatedServer\InvalidArgumentException;
11			use Maniaplanet\DedicatedServer\Xmlrpc\UnknownPlayerException;
12			use Psr\Log\LoggerInterface;
13
14			/**
15			* Class ChatNotification
16			*
17			* @package eXpansion\Framework\Core\Helpers;
18			* @author oliver de Cramer <[email protected]>
19			*/
20			class ChatNotification implements ChatNotificationInterface
21			{
22			/** @var Connection */
23			protected $connection;
24
25			/** @var Translations */
26			protected $translations;
27
28			/** @var PlayerStorage */
29			protected $playerStorage;
30
31			/** @var Console */
32			protected $console;
33			/**
34			* @var LoggerInterface
35			*/
36			private $logger;
37
38			/**
39			* ChatNotification constructor.
40			*
41			* @param Connection $connection
42			* @param Translations $translations
43			* @param PlayerStorage $playerStorage
44			* @param Console $console
45			* @param LoggerInterface $logger
46			*/
47	6	View Code Duplication	public function __construct(
			0 ignored issues – show Duplication introduced 2017-12-11 11:40 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...
48			Connection $connection,
49			Translations $translations,
50			PlayerStorage $playerStorage,
51			Console $console,
52			LoggerInterface $logger
53			) {
54	6		$this->connection = $connection;
55	6		$this->translations = $translations;
56	6		$this->playerStorage = $playerStorage;
57	6		$this->console = $console;
58	6		$this->logger = $logger;
59	6		}
60
61			/**
62			* Send message.
63			*
64			* @param string $messageId
65			* @param string\|string[]\|Group\|null $to
66			* @param string[] $parameters
67			*/
68	3		public function sendMessage($messageId, $to = null, $parameters = [])
69			{
70	3		$message = $messageId;
71
72	3		if (is_string($to)) {
73	1		$player = $this->playerStorage->getPlayerInfo($to);
74	1		$message = $this->translations->getTranslation($messageId, $parameters, strtolower($player->getLanguage()));
75			}
76
77	3		if (is_array($to)) {
78	1		$to = implode(",", $to);
79	1		$message = $this->translations->getTranslations($messageId, $parameters);
80			}
81
82	3		if ($to instanceof Group) {
			0 ignored issues – show Bug introduced 2017-11-25 14:38 UTC by Report Bug Copy Issue Report The class `eXpansion\Framework\Core\Model\UserGroups\Group` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
83			$to = implode(",", $to->getLogins());
84			$message = $this->translations->getTranslations($messageId, $parameters);
85			}
86
87	3		if ($to === null \|\| $to instanceof Group) {
			0 ignored issues – show Bug introduced 2017-11-25 14:38 UTC by Report Bug Copy Issue Report The class `eXpansion\Framework\Core\Model\UserGroups\Group` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
88	1		$message = $this->translations->getTranslations($messageId, $parameters);
89	1		$this->console->writeln(end($message)['Text']);
90			}
91
92			try {
93	3		$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...
94			} catch (UnknownPlayerException $e) {
95			$this->logger->info("can't send chat message: $message", ["to" => $to, "exception" => $e]);
96			// Nothing to do, it happens.
97			} catch (InvalidArgumentException $ex) {
98			// Nothing to do
99			}
100	3		}
101
102			/**
103			* Return messageId with arguments as a string
104			* Usage: used for retrieving partials for chat messages
105			* * defaults to English locale, without parameters
106			*
107			* @param string $messageId
108			* @param array $parameters
109			* @param string $locale
110			* @return string
111			*/
112			public function getMessage($messageId, $parameters = [], $locale = "en")
113			{
114			return $this->translations->getTranslation($messageId, $parameters, $locale);
115			}
116
117
118			}
119

eXpansionPluginPack / eXpansion2

Pull Request — master (#278)

ChatNotification::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like