ManialinkFactory::setLocalRecord() - Code Metrics - Inspection of "Race widgets" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#254)

unknown

created 2018-02-15 00:17 UTC

ManialinkFactory::setLocalRecord() A

↳ Parent: ManialinkFactory::update()

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace eXpansion\Framework\Core\Plugins\Gui;

use eXpansion\Framework\Core\Model\Gui\Manialink;
use eXpansion\Framework\Core\Model\Gui\ManialinkFactoryContext;
use eXpansion\Framework\Core\Model\Gui\ManialinkFactoryInterface;
use eXpansion\Framework\Core\Model\Gui\ManialinkInterface;
use eXpansion\Framework\Core\Model\Gui\Window;
use eXpansion\Framework\Core\Model\UserGroups\Group;
use eXpansion\Framework\Core\Plugins\GuiHandler;
use eXpansion\Framework\Core\Plugins\UserGroups\Factory;

/**
 * Class ManialiveFactory allow the creation of manialinks.
 *
 * @package eXpansion\Framework\Core\Plugins\Gui
 * @author Oliver de Cramer
 */
class ManialinkFactory implements ManialinkFactoryInterface
{
    /** @var  GuiHandler */
    protected $guiHandler;

    /** @var Factory */
    protected $groupFactory;

    /** @var ActionFactory */
    protected $actionFactory;

    /** @var  string */
    protected $name;

    /** @var  string */
    protected $className;

    /** @var Group[] */
    protected $groups = [];

    /** @var float|int */
    protected $sizeX;

    /** @var float|int */
    protected $sizeY;

    /** @var float|int */
    protected $posX;

    /** @var float|int */
    protected $posY;

    /**
     * ManialinkFactory constructor.
     *
     * @param                         $name
     * @param                         $sizeX
     * @param                         $sizeY
     * @param null                    $posX
     * @param null                    $posY
     * @param ManialinkFactoryContext $context
     */
    public function __construct(
        $name,
        $sizeX,
        $sizeY,
        $posX = null,
        $posY = null,
        ManialinkFactoryContext $context
    ) {
        if (is_null($posX)) {
            $posX = $sizeX / -2;
        }

        if (is_null($posY)) {
            $posY = $sizeY / 2;
        }

        $this->guiHandler = $context->getGuiHandler();
        $this->groupFactory = $context->getGroupFactory();
        $this->actionFactory = $context->getActionFactory();
        $this->className = $context->getClassName();
        $this->name = $name;
        $this->sizeX = $sizeX;
        $this->sizeY = $sizeY;
        $this->posX = $posX;
        $this->posY = $posY;
    }

    /**
     * @return string
     */
    public function getId()
    {
        return spl_object_hash($this);
    }

    /**
     * Creates a new manialink.
     *
     * @param string|array|Group $group
     * @return array|Group|string
     */
    public function create($group)
    {
        if (is_string($group)) {

            $group = $this->groupFactory->createForPlayer($group);
        } else {
            if (is_array($group)) {
                $group = $this->groupFactory->createForPlayers($group);
            }
        }

        if (!is_null($this->guiHandler->getManialink($group, $this))) {
            $this->update($group);

            return $group;
        }


        $ml = $this->createManialink($group);
        $this->guiHandler->addToDisplay($ml, $this);


        $this->createContent($ml);
        $this->updateContent($ml);

        return $group;
    }

    /**
     * Request an update for manialink.
     *
     * @param string|array|Group $group
     */
    public function update($group)
    {
        if (is_string($group)) {

            $group = $this->groupFactory->createForPlayer($group);
        } else {
            if (is_array($group)) {
                $group = $this->groupFactory->createForPlayers($group);
            }
        }

        $ml = $this->guiHandler->getManialink($group, $this);
        if ($ml) {
            $this->actionFactory->destroyNotPermanentActions($ml);
            if ($ml instanceof Window) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                $ml->busyCounter += 1;

                if ($ml->isBusy && $ml->busyCounter > 1) {
                    $ml->setBusy(false);
                }
            }
            $this->updateContent($ml);
            $this->guiHandler->addToDisplay($ml, $this);


        }
    }

    /**
     * Create content in the manialink.
     *
     * @param ManialinkInterface $manialink
     *
     */
    protected function createContent(ManialinkInterface $manialink)
    {
        // Put content in the manialink here.
    }

    /**
     * Update content in the manialink.
     *
     * @param ManialinkInterface $manialink
     *
     */
    protected function updateContent(ManialinkInterface $manialink)
    {
        // Put content in the manialink here.
    }

    /**
     *  Hides and frees manialink resources
     *
     * @param Group $group
     *
     */
    public function destroy(Group $group)
    {
        $ml = $this->guiHandler->getManialink($group, $this);
        if ($ml) {
            $this->guiHandler->addToHide($ml, $this);

        }
    }

    /**
     * Create manialink object for user group.
     *
     * @param Group $group
     *
     * @return Manialink
     */
    protected function createManialink(Group $group)
    {
        $className = $this->className;

        return new $className($this, $group, $this->name, $this->sizeX, $this->sizeY, $this->posX, $this->posY);
    }
}


Pull Request — master (#254)

ManialinkFactory::setLocalRecord() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			namespace eXpansion\Framework\Core\Plugins\Gui;
4
5			use eXpansion\Framework\Core\Model\Gui\Manialink;
6			use eXpansion\Framework\Core\Model\Gui\ManialinkFactoryContext;
7			use eXpansion\Framework\Core\Model\Gui\ManialinkFactoryInterface;
8			use eXpansion\Framework\Core\Model\Gui\ManialinkInterface;
9			use eXpansion\Framework\Core\Model\Gui\Window;
10			use eXpansion\Framework\Core\Model\UserGroups\Group;
11			use eXpansion\Framework\Core\Plugins\GuiHandler;
12			use eXpansion\Framework\Core\Plugins\UserGroups\Factory;
13
14			/**
15			* Class ManialiveFactory allow the creation of manialinks.
16			*
17			* @package eXpansion\Framework\Core\Plugins\Gui
18			* @author Oliver de Cramer
19			*/
20			class ManialinkFactory implements ManialinkFactoryInterface
21			{
22			/** @var GuiHandler */
23			protected $guiHandler;
24
25			/** @var Factory */
26			protected $groupFactory;
27
28			/** @var ActionFactory */
29			protected $actionFactory;
30
31			/** @var string */
32			protected $name;
33
34			/** @var string */
35			protected $className;
36
37			/** @var Group[] */
38			protected $groups = [];
39
40			/** @var float\|int */
41			protected $sizeX;
42
43			/** @var float\|int */
44			protected $sizeY;
45
46			/** @var float\|int */
47			protected $posX;
48
49			/** @var float\|int */
50			protected $posY;
51
52			/**
53			* ManialinkFactory constructor.
54			*
55			* @param $name
56			* @param $sizeX
57			* @param $sizeY
58			* @param null $posX
59			* @param null $posY
60			* @param ManialinkFactoryContext $context
61			*/
62	4		public function __construct(
63			$name,
64			$sizeX,
65			$sizeY,
66			$posX = null,
67			$posY = null,
68			ManialinkFactoryContext $context
69			) {
70	4		if (is_null($posX)) {
71	4		$posX = $sizeX / -2;
72			}
73
74	4		if (is_null($posY)) {
75	4		$posY = $sizeY / 2;
76			}
77
78	4		$this->guiHandler = $context->getGuiHandler();
79	4		$this->groupFactory = $context->getGroupFactory();
80	4		$this->actionFactory = $context->getActionFactory();
81	4		$this->className = $context->getClassName();
82	4		$this->name = $name;
83	4		$this->sizeX = $sizeX;
84	4		$this->sizeY = $sizeY;
85	4		$this->posX = $posX;
86	4		$this->posY = $posY;
87	4		}
88
89			/**
90			* @return string
91			*/
92			public function getId()
93			{
94			return spl_object_hash($this);
95			}
96
97			/**
98			* Creates a new manialink.
99			*
100			* @param string\|array\|Group $group
101			* @return array\|Group\|string
102			*/
103	4		public function create($group)
104			{
105	4	View Code Duplication	if (is_string($group)) {
			0 ignored issues – show Duplication introduced 2017-11-14 00:04 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...
106	1		$group = $this->groupFactory->createForPlayer($group);
107			} else {
108	3		if (is_array($group)) {
109	2		$group = $this->groupFactory->createForPlayers($group);
110			}
111			}
112
113	4		if (!is_null($this->guiHandler->getManialink($group, $this))) {
114	1		$this->update($group);
115
116	1		return $group;
117			}
118
119
120	3		$ml = $this->createManialink($group);
121	3		$this->guiHandler->addToDisplay($ml, $this);
			0 ignored issues – show Unused Code introduced 2017-12-02 12:32 UTC by Report Bug Copy Issue Report The call to `GuiHandler::addToDisplay()` has too many arguments starting with `$this`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
122
123	3		$this->createContent($ml);
124	3		$this->updateContent($ml);
125
126	3		return $group;
127			}
128
129			/**
130			* Request an update for manialink.
131			*
132			* @param string\|array\|Group $group
133			*/
134	1		public function update($group)
135			{
136	1	View Code Duplication	if (is_string($group)) {
			0 ignored issues – show Duplication introduced 2017-11-14 00:04 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...
137			$group = $this->groupFactory->createForPlayer($group);
138			} else {
139	1		if (is_array($group)) {
140			$group = $this->groupFactory->createForPlayers($group);
141			}
142			}
143
144	1		$ml = $this->guiHandler->getManialink($group, $this);
145	1		if ($ml) {
146	1		$this->actionFactory->destroyNotPermanentActions($ml);
147	1		if ($ml instanceof Window) {
			0 ignored issues – show Bug introduced 2018-02-11 21:53 UTC by Report Bug Copy Issue Report The class `eXpansion\Framework\Core\Model\Gui\Window` 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...
148			$ml->busyCounter += 1;
149
150			if ($ml->isBusy && $ml->busyCounter > 1) {
151			$ml->setBusy(false);
152			}
153			}
154	1		$this->updateContent($ml);
155	1		$this->guiHandler->addToDisplay($ml, $this);
			0 ignored issues – show Unused Code introduced 2017-12-02 12:32 UTC by Report Bug Copy Issue Report The call to `GuiHandler::addToDisplay()` has too many arguments starting with `$this`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
156
157			}
158	1		}
159
160			/**
161			* Create content in the manialink.
162			*
163			* @param ManialinkInterface $manialink
164			*
165			*/
166	3		protected function createContent(ManialinkInterface $manialink)
167			{
168			// Put content in the manialink here.
169	3		}
170
171			/**
172			* Update content in the manialink.
173			*
174			* @param ManialinkInterface $manialink
175			*
176			*/
177	4		protected function updateContent(ManialinkInterface $manialink)
178			{
179			// Put content in the manialink here.
180	4		}
181
182			/**
183			* Hides and frees manialink resources
184			*
185			* @param Group $group
186			*
187			*/
188	1		public function destroy(Group $group)
189			{
190	1		$ml = $this->guiHandler->getManialink($group, $this);
191	1		if ($ml) {
192	1		$this->guiHandler->addToHide($ml, $this);
			0 ignored issues – show Unused Code introduced 2017-12-02 12:32 UTC by Report Bug Copy Issue Report The call to `GuiHandler::addToHide()` has too many arguments starting with `$this`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
193			}
194	1		}
195
196			/**
197			* Create manialink object for user group.
198			*
199			* @param Group $group
200			*
201			* @return Manialink
202			*/
203	3		protected function createManialink(Group $group)
204			{
205	3		$className = $this->className;
206
207	3		return new $className($this, $group, $this->name, $this->sizeX, $this->sizeY, $this->posX, $this->posY);
208			}
209			}
210

eXpansionPluginPack / eXpansion2

Pull Request — master (#254)

ManialinkFactory::setLocalRecord() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like