ListWindow::__construct() - Code Metrics - Inspection of "Players improvments" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#194)

by De Cramer

created 2018-01-04 13:09 UTC

ListWindow::__construct() B

↳ Parent: ListWindow

Complexity

Conditions	1
Paths	1

Size

Total Lines	26
Code Lines	22

Duplication

Lines	26
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	26
loc	26
rs	8.8571
c	0
b	0
f	0
ccs	0
cts	10
cp	0
cc	1
eloc	22
nc	1
nop	13
crap	2

How to fix Many Parameters

<?php

namespace eXpansion\Bundle\Players\Plugins\Gui;

use eXpansion\Framework\AdminGroups\Helpers\AdminGroups;
use eXpansion\Framework\Core\Helpers\ChatNotification;
use eXpansion\Framework\Core\Model\Gui\Grid\DataCollectionFactory;
use eXpansion\Framework\Core\Model\Gui\Grid\GridBuilderFactory;
use eXpansion\Framework\Core\Model\Gui\ManialinkInterface;
use eXpansion\Framework\Core\Model\Gui\Window;
use eXpansion\Framework\Core\Model\Gui\WindowFactoryContext;
use eXpansion\Framework\Core\Plugins\Gui\GridWindowFactory;
use eXpansion\Framework\Core\Storage\PlayerStorage;
use eXpansion\Framework\GameManiaplanet\DataProviders\ChatCommandDataProvider;
use eXpansion\Framework\Gui\Components\uiButton;
use Maniaplanet\DedicatedServer\Connection;

class ListWindow extends GridWindowFactory
{
    /**
     * @var PlayerStorage
     */
    private $playerStorage;
    /**
     * @var ChatCommandDataProvider
     */
    private $chatCommandDataProvider;
    /**
     * @var Connection
     */
    private $connection;
    /**
     * @var AdminGroups
     */
    private $adminGroups;

    protected $mode;
    /**
     * @var ChatNotification
     */
    private $chatNotification;

    /**
     * PlayersWindow constructor.
     * @param                         $name
     * @param                         $sizeX
     * @param                         $sizeY
     * @param null                    $posX
     * @param null                    $posY
     * @param WindowFactoryContext    $context
     * @param PlayerStorage           $playerStorage
     * @param DataCollectionFactory   $dataCollectionFactory
     * @param GridBuilderFactory      $gridBuilderFactory
     * @param ChatCommandDataProvider $chatCommandDataProvider
     * @param Connection              $connection
     * @param AdminGroups             $adminGroups
     * @param ChatNotification        $chatNotification
     */
    public function __construct(

        $name,
        $sizeX,
        $sizeY,
        $posX = null,
        $posY = null,
        WindowFactoryContext $context,
        PlayerStorage $playerStorage,
        DataCollectionFactory $dataCollectionFactory,
        GridBuilderFactory $gridBuilderFactory,
        ChatCommandDataProvider $chatCommandDataProvider,
        Connection $connection,
        AdminGroups $adminGroups,
        ChatNotification $chatNotification

    ) {
        parent::__construct($name, $sizeX, $sizeY, $posX, $posY, $context);

        $this->playerStorage = $playerStorage;
        $this->dataCollectionFactory = $dataCollectionFactory;
        $this->gridBuilderFactory = $gridBuilderFactory;
        $this->chatCommandDataProvider = $chatCommandDataProvider;
        $this->connection = $connection;
        $this->adminGroups = $adminGroups;
        $this->chatNotification = $chatNotification;
    }

    /**
     * @param mixed $mode
     */
    public function setMode($mode)
    {
        $this->mode = $mode;
    }

    /**
     * @return mixed
     */
    public function getMode()
    {
        return $this->mode;
    }

    protected function createContent(
        ManialinkInterface $manialink
    ) {
        parent::createContent($manialink);
        $manialink->setData('mode', $this->getMode());
        $this->updateData($manialink);
    }

    protected function updateContent(
        ManialinkInterface $manialink
    ) {
        parent::updateContent($manialink);
    }

    /**
     * @param ManialinkInterface $manialink
     */
    protected function createGrid(
        ManialinkInterface $manialink
    ) {

        $selectButton = $this->uiFactory->createButton('expansion_players.gui.list.window.column.remove',
            uiButton::TYPE_DEFAULT)->setSize(10, 5)->setTranslate(true);

        $gridBuilder = $this->gridBuilderFactory->create();
        $gridBuilder->setManialink($manialink)
            ->setDataCollection($manialink->getData('dataCollection'))
            ->setManialinkFactory($this)
            ->addTextColumn(
                'login',
                'expansion_players.gui.players.window.column.login',
                4,
                true,
                false

            )
            ->addActionColumn('login', 'expansion_players.gui.list.window.column.remove',
                3, [$this, "callbackRemovePlayer"], $selectButton);


        $manialink->setData('grid', $gridBuilder);

        $frame = $manialink->getContentFrame();
        $this->setGridSize($frame->getWidth(), $frame->getHeight() - 10);

        $this->setGridSize(60, 90);
        $this->setGridPosition(0, 0);

    }

    /**
     * @param Window|ManialinkInterface $manialink
     * @throws \Maniaplanet\DedicatedServer\InvalidArgumentException
     */
    public function updateData(
        $manialink
    ) {
        $dataset = [];
        switch ($manialink->getData("mode")) {
            case "ignorelist":
                $dataset = $this->connection->getIgnoreList();
                break;
            case "guestlist":
                $dataset = $this->connection->getGuestList();
                break;
            case "banlist":
                $dataset = $this->connection->getBanList();
                break;
            case "blacklist":
                $dataset = $this->connection->getBlackList();
                break;
        }

        $listData = [];
        foreach ($dataset as $player) {
            $listData[] = ["login" => $player->login];
        }

        $this->setData($manialink, $listData);
    }


    /**
     * @param ManialinkInterface $manialink
     * @param $login
     * @param $entries
     * @param $args
     */
    public function callbackRemovePlayer(
        $manialink,
        $login,
        $entries,
        $args
    ) {
        try {
            switch ($manialink->getData("mode")) {
                case "ignorelist":
                    $this->connection->unIgnore($args['login']);
                    break;
                case "guestlist":
                    $this->connection->removeGuest($args['login']);
                    break;
                case "banlist":
                    $this->connection->unBan($args['login']);
                    break;
                case "blacklist":
                    $this->connection->unBlackList($args['login']);
                    break;
            }

            $this->updateData($manialink);
        } catch (\Exception $e) {
            $this->chatNotification->sendMessage('expansion_players.chat.exception',
                $login, ["%message%" => $e->getMessage()]);
        }
        $this->update($manialink->getUserGroup());
    }

    /**
     * @param $login
     * @param $command
     */
    public function callChatCommand($login, $command)
    {
        $this->chatCommandDataProvider->onPlayerChat($login, $login, $command, true);
    }

}



1		<?php
2
3		namespace eXpansion\Bundle\Players\Plugins\Gui;
4
5		use eXpansion\Framework\AdminGroups\Helpers\AdminGroups;
6		use eXpansion\Framework\Core\Helpers\ChatNotification;
7		use eXpansion\Framework\Core\Model\Gui\Grid\DataCollectionFactory;
8		use eXpansion\Framework\Core\Model\Gui\Grid\GridBuilderFactory;
9		use eXpansion\Framework\Core\Model\Gui\ManialinkInterface;
10		use eXpansion\Framework\Core\Model\Gui\Window;
11		use eXpansion\Framework\Core\Model\Gui\WindowFactoryContext;
12		use eXpansion\Framework\Core\Plugins\Gui\GridWindowFactory;
13		use eXpansion\Framework\Core\Storage\PlayerStorage;
14		use eXpansion\Framework\GameManiaplanet\DataProviders\ChatCommandDataProvider;
15		use eXpansion\Framework\Gui\Components\uiButton;
16		use Maniaplanet\DedicatedServer\Connection;
17
18		class ListWindow extends GridWindowFactory
19		{
20		/**
21		* @var PlayerStorage
22		*/
23		private $playerStorage;
24		/**
25		* @var ChatCommandDataProvider
26		*/
27		private $chatCommandDataProvider;
28		/**
29		* @var Connection
30		*/
31		private $connection;
32		/**
33		* @var AdminGroups
34		*/
35		private $adminGroups;
36
37		protected $mode;
38		/**
39		* @var ChatNotification
40		*/
41		private $chatNotification;
42
43		/**
44		* PlayersWindow constructor.
45		* @param $name
46		* @param $sizeX
47		* @param $sizeY
48		* @param null $posX
49		* @param null $posY
50		* @param WindowFactoryContext $context
51		* @param PlayerStorage $playerStorage
52		* @param DataCollectionFactory $dataCollectionFactory
53		* @param GridBuilderFactory $gridBuilderFactory
54		* @param ChatCommandDataProvider $chatCommandDataProvider
55		* @param Connection $connection
56		* @param AdminGroups $adminGroups
57		* @param ChatNotification $chatNotification
58		*/
59	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2017-11-11 10:29 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...
60		$name,
61		$sizeX,
62		$sizeY,
63		$posX = null,
64		$posY = null,
65		WindowFactoryContext $context,
66		PlayerStorage $playerStorage,
67		DataCollectionFactory $dataCollectionFactory,
68		GridBuilderFactory $gridBuilderFactory,
69		ChatCommandDataProvider $chatCommandDataProvider,
70		Connection $connection,
71		AdminGroups $adminGroups,
72		ChatNotification $chatNotification
73
74		) {
75		parent::__construct($name, $sizeX, $sizeY, $posX, $posY, $context);
76
77		$this->playerStorage = $playerStorage;
78		$this->dataCollectionFactory = $dataCollectionFactory;
79		$this->gridBuilderFactory = $gridBuilderFactory;
80		$this->chatCommandDataProvider = $chatCommandDataProvider;
81		$this->connection = $connection;
82		$this->adminGroups = $adminGroups;
83		$this->chatNotification = $chatNotification;
84		}
85
86		/**
87		* @param mixed $mode
88		*/
89		public function setMode($mode)
90		{
91		$this->mode = $mode;
92		}
93
94		/**
95		* @return mixed
96		*/
97		public function getMode()
98		{
99		return $this->mode;
100		}
101
102		protected function createContent(
103		ManialinkInterface $manialink
104		) {
105		parent::createContent($manialink);
106		$manialink->setData('mode', $this->getMode());
107		$this->updateData($manialink);
108		}
109
110		protected function updateContent(
111		ManialinkInterface $manialink
112		) {
113		parent::updateContent($manialink);
114		}
115
116		/**
117		* @param ManialinkInterface $manialink
118		*/
119		protected function createGrid(
120		ManialinkInterface $manialink
121		) {
122
123		$selectButton = $this->uiFactory->createButton('expansion_players.gui.list.window.column.remove',
124		uiButton::TYPE_DEFAULT)->setSize(10, 5)->setTranslate(true);
125
126		$gridBuilder = $this->gridBuilderFactory->create();
127		$gridBuilder->setManialink($manialink)
128		->setDataCollection($manialink->getData('dataCollection'))
129		->setManialinkFactory($this)
130		->addTextColumn(
131		'login',
132		'expansion_players.gui.players.window.column.login',
133		4,
134		true,
135		false
136
137		)
138		->addActionColumn('login', 'expansion_players.gui.list.window.column.remove',
139		3, [$this, "callbackRemovePlayer"], $selectButton);
140
141
142		$manialink->setData('grid', $gridBuilder);
143
144		$frame = $manialink->getContentFrame();
145		$this->setGridSize($frame->getWidth(), $frame->getHeight() - 10);
146
147		$this->setGridSize(60, 90);
148		$this->setGridPosition(0, 0);
149
150		}
151
152		/**
153		* @param Window\|ManialinkInterface $manialink
154		* @throws \Maniaplanet\DedicatedServer\InvalidArgumentException
155		*/
156		public function updateData(
157		$manialink
158		) {
159		$dataset = [];
160		switch ($manialink->getData("mode")) {
161		case "ignorelist":
162		$dataset = $this->connection->getIgnoreList();
163		break;
164		case "guestlist":
165		$dataset = $this->connection->getGuestList();
166		break;
167		case "banlist":
168		$dataset = $this->connection->getBanList();
169		break;
170		case "blacklist":
171		$dataset = $this->connection->getBlackList();
172		break;
173		}
174
175		$listData = [];
176		foreach ($dataset as $player) {
177		$listData[] = ["login" => $player->login];
178		}
179
180		$this->setData($manialink, $listData);
181		}
182
183
184		/**
185		* @param ManialinkInterface $manialink
186		* @param $login
187		* @param $entries
188		* @param $args
189		*/
190		public function callbackRemovePlayer(
191		$manialink,
192		$login,
193		$entries,
194		$args
195		) {
196		try {
197		switch ($manialink->getData("mode")) {
198		case "ignorelist":
199		$this->connection->unIgnore($args['login']);
200		break;
201		case "guestlist":
202		$this->connection->removeGuest($args['login']);
203		break;
204		case "banlist":
205		$this->connection->unBan($args['login']);
206		break;
207		case "blacklist":
208		$this->connection->unBlackList($args['login']);
209		break;
210		}
211
212		$this->updateData($manialink);
213		} catch (\Exception $e) {
214		$this->chatNotification->sendMessage('expansion_players.chat.exception',
215		$login, ["%message%" => $e->getMessage()]);
216		}
217		$this->update($manialink->getUserGroup());
218		}
219
220		/**
221		* @param $login
222		* @param $command
223		*/
224		public function callChatCommand($login, $command)
225		{
226		$this->chatCommandDataProvider->onPlayerChat($login, $login, $command, true);
227		}
228
229		}
230
231

eXpansionPluginPack / eXpansion2

Pull Request — master (#194)

ListWindow::__construct() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Many Parameters

Many Parameters

Duplication Side-by-Side

Filter issues like