ManialinkFactory::getId() - Code Metrics - Inspection of "Merge pull request #137 from eXpansionPluginPack/f..." - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (83a2f0)

by De Cramer

created 2017-11-25 14:36 UTC

ManialinkFactory::getId() A

↳ Parent: ManialinkFactory

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
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

namespace eXpansion\Framework\Core\Plugins\Gui;

use eXpansion\Framework\Core\DataProviders\Listener\ListenerInterfaceExpUserGroup;
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\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, ListenerInterfaceExpUserGroup
{
    /** @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);
    }

    /**
     * @inheritdoc
     * @param string|array|Group $group
     */
    final 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;
    }

    /**
     * @inheritdoc
     * @param string|array|Group $group
     */
    final 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);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        if ($ml) {
            $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.
    }

    /**
     * @inheritdoc
     */
    final public function destroy(Group $group)
    {
        $ml = $this->guiHandler->getManialink($group, $this);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        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($group, $this->name, $this->sizeX, $this->sizeY, $this->posX, $this->posY);
    }

    public function onExpansionGroupDestroy(Group $group, $lastLogin)
    {
        // nothing to do here.
    }

    public function onExpansionGroupAddUser(Group $group, $loginAdded)
    {
        // nothing to do here.
    }

    public function onExpansionGroupRemoveUser(Group $group, $loginRemoved)
    {
        // nothing to do here.
    }

}


1			<?php
2
3			namespace eXpansion\Framework\Core\Plugins\Gui;
4
5			use eXpansion\Framework\Core\DataProviders\Listener\ListenerInterfaceExpUserGroup;
6			use eXpansion\Framework\Core\Model\Gui\Manialink;
7			use eXpansion\Framework\Core\Model\Gui\ManialinkFactoryContext;
8			use eXpansion\Framework\Core\Model\Gui\ManialinkFactoryInterface;
9			use eXpansion\Framework\Core\Model\Gui\ManialinkInterface;
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, ListenerInterfaceExpUserGroup
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	6		public function __construct(
63			$name,
64			$sizeX,
65			$sizeY,
66			$posX = null,
67			$posY = null,
68			ManialinkFactoryContext $context
69			) {
70	6		if (is_null($posX)) {
71	6		$posX = $sizeX / -2;
72			}
73
74	6		if (is_null($posY)) {
75	6		$posY = $sizeY / 2;
76			}
77
78	6		$this->guiHandler = $context->getGuiHandler();
79	6		$this->groupFactory = $context->getGroupFactory();
80	6		$this->actionFactory = $context->getActionFactory();
81	6		$this->className = $context->getClassName();
82	6		$this->name = $name;
83	6		$this->sizeX = $sizeX;
84	6		$this->sizeY = $sizeY;
85	6		$this->posX = $posX;
86	6		$this->posY = $posY;
87	6		}
88
89			/**
90			* @return string
91			*/
92			public function getId()
93			{
94			return spl_object_hash($this);
95			}
96
97			/**
98			* @inheritdoc
99			* @param string\|array\|Group $group
100			*/
101	4		final public function create($group)
102			{
103	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...
104	1		$group = $this->groupFactory->createForPlayer($group);
105			} else {
106	3		if (is_array($group)) {
107	2		$group = $this->groupFactory->createForPlayers($group);
108			}
109			}
110
111	4		if (!is_null($this->guiHandler->getManialink($group, $this))) {
112	1		$this->update($group);
113	1		return $group;
114			}
115
116
117	3		$ml = $this->createManialink($group);
118	3		$this->guiHandler->addToDisplay($ml, $this);
119
120	3		$this->createContent($ml);
121	3		$this->updateContent($ml);
122
123	3		return $group;
124			}
125
126			/**
127			* @inheritdoc
128			* @param string\|array\|Group $group
129			*/
130	1		final public function update($group)
131			{
132	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...
133			$group = $this->groupFactory->createForPlayer($group);
134			} else {
135	1		if (is_array($group)) {
136			$group = $this->groupFactory->createForPlayers($group);
137			}
138			}
139
140	1		$ml = $this->guiHandler->getManialink($group, $this);
			0 ignored issues – show Bug introduced 2017-11-25 14:31 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$ml` is correct as `$this->guiHandler->getManialink($group, $this)` (which targets `eXpansion\Framework\Core...Handler::getManialink()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
141	1		if ($ml) {
142	1		$this->updateContent($ml);
143	1		$this->guiHandler->addToDisplay($ml, $this);
144			}
145	1		}
146
147			/**
148			* Create content in the manialink.
149			*
150			* @param ManialinkInterface $manialink
151			*
152			*/
153	3		protected function createContent(ManialinkInterface $manialink)
154			{
155			// Put content in the manialink here.
156	3		}
157
158			/**
159			* Update content in the manialink.
160			*
161			* @param ManialinkInterface $manialink
162			*
163			*/
164	4		protected function updateContent(ManialinkInterface $manialink)
165			{
166			// Put content in the manialink here.
167	4		}
168
169			/**
170			* @inheritdoc
171			*/
172	1		final public function destroy(Group $group)
173			{
174	1		$ml = $this->guiHandler->getManialink($group, $this);
			0 ignored issues – show Bug introduced 2017-11-25 14:31 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$ml` is correct as `$this->guiHandler->getManialink($group, $this)` (which targets `eXpansion\Framework\Core...Handler::getManialink()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
175	1		if ($ml) {
176	1		$this->guiHandler->addToHide($ml, $this);
177			}
178	1		}
179
180			/**
181			* Create manialink object for user group.
182			*
183			* @param Group $group
184			*
185			* @return Manialink
186			*/
187	3		protected function createManialink(Group $group)
188			{
189	3		$className = $this->className;
190
191	3		return new $className($group, $this->name, $this->sizeX, $this->sizeY, $this->posX, $this->posY);
192			}
193
194	1		public function onExpansionGroupDestroy(Group $group, $lastLogin)
195			{
196			// nothing to do here.
197	1		}
198
199	1		public function onExpansionGroupAddUser(Group $group, $loginAdded)
200			{
201			// nothing to do here.
202	1		}
203
204	1		public function onExpansionGroupRemoveUser(Group $group, $loginRemoved)
205			{
206			// nothing to do here.
207	1		}
208
209			}
210

eXpansionPluginPack / eXpansion2

Branch — master (83a2f0)

ManialinkFactory::getId() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like