ManialinkFactory::create() - Code Metrics - Inspection of "adding uiButton, uiCheckbox and uiLabel" - eXpansionPluginPack/eXpansion2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#95)

unknown

created 2017-07-26 17:17 UTC

ManialinkFactory::create() B

↳ Parent: ManialinkFactory

Complexity

Conditions	4
Paths	6

Size

Total Lines	24
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	4.0582

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	24
ccs	11
cts	13
cp	0.8462
rs	8.6845
c	1
b	0
f	0
cc	4
eloc	14
nc	6
nop	1
crap	4.0582

<?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\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 ManialinkInterface[] */
    protected $manialinks = [];

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

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

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

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

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

    /**
     * GroupManialinkFactory constructor.
     *
     * @param GuiHandler $guiHandler
     * @param Factory $groupFactory
     * @param ActionFactory $actionFactory
     * @param $name
     * @param $sizeX
     * @param $sizeY
     * @param null $posX
     * @param null $posY
     * @param string $className
     */
    public function __construct(
        $name,
        $sizeX,
        $sizeY,
        $posX = null,
        $posY = null,
        GuiHandler $guiHandler,
        Factory $groupFactory,
        ActionFactory $actionFactory,
        $className = Manialink::class
    ) {
        if (is_null($posX)) {
            $posX = $sizeX / -2;
        }

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

        $this->guiHandler = $guiHandler;
        $this->groupFactory = $groupFactory;
        $this->actionFactory = $actionFactory;
        $this->name = $name;
        $this->className = $className;
        $this->sizeX = $sizeX;
        $this->sizeY = $sizeY;
        $this->posX = $posX;
        $this->posY = $posY;
    }

    /**
     * @inheritdoc
     */
    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 (isset($this->manialinks[$group->getName()])) {
            $this->update($group);

            return $group;
        }

        $this->manialinks[$group->getName()] = $this->createManialink($group);
        $this->guiHandler->addToDisplay($this->manialinks[$group->getName()]);

        $this->createContent($this->manialinks[$group->getName()]);
        $this->updateContent($this->manialinks[$group->getName()]);

        return $group;
    }

    /**
     * @inheritdoc
     * @param Group $group
     */
    final public function update($group)
    {
        if (isset($this->manialinks[$group->getName()])) {
            $this->guiHandler->addToDisplay($this->manialinks[$group->getName()]);
            $this->updateContent($this->manialinks[$group->getName()]);
        }
    }

    /**
     * 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)
    {
        if (isset($this->manialinks[$group->getName()])) {
            $this->guiHandler->addToHide($this->manialinks[$group->getName()]);
            $this->actionFactory->destroyManialinkActions($this->manialinks[$group->getName()]);
            unset($this->manialinks[$group->getName()]);
        }
    }

    /**
     * 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);
    }

    /**
     * When a gup is destroyed, destroy manialinks of the group.
     *
     * @param Group $group
     * @param $lastLogin
     *
     * @return void
     */
    public function onExpansionGroupDestroy(Group $group, $lastLogin)
    {
        if (isset($this->manialinks[$group->getName()])) {
            // Gui Handler will handle delete by it's own.
            $this->actionFactory->destroyManialinkActions($this->manialinks[$group->getName()]);
            unset($this->manialinks[$group->getName()]);
        }
    }

    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\ManialinkFactoryInterface;
8		use eXpansion\Framework\Core\Model\Gui\ManialinkInterface;
9		use eXpansion\Framework\Core\Model\UserGroups\Group;
10		use eXpansion\Framework\Core\Plugins\GuiHandler;
11		use eXpansion\Framework\Core\Plugins\UserGroups\Factory;
12
13		/**
14		* Class ManialiveFactory allow the creation of manialinks.
15		*
16		* @package eXpansion\Framework\Core\Plugins\Gui
17		* @author Oliver de Cramer
18		*/
19		class ManialinkFactory implements ManialinkFactoryInterface, ListenerInterfaceExpUserGroup
20		{
21		/** @var GuiHandler */
22		protected $guiHandler;
23
24		/** @var Factory */
25		protected $groupFactory;
26
27		/** @var ActionFactory */
28		protected $actionFactory;
29
30		/** @var string */
31		protected $name;
32
33		/** @var string */
34		protected $className;
35
36		/** @var ManialinkInterface[] */
37		protected $manialinks = [];
38
39		/** @var Group[] */
40		protected $groups = [];
41
42		/** @var float\|int */
43		protected $sizeX;
44
45		/** @var float\|int */
46		protected $sizeY;
47
48		/** @var float\|int */
49		protected $posX;
50
51		/** @var float\|int */
52		protected $posY;
53
54		/**
55		* GroupManialinkFactory constructor.
56		*
57		* @param GuiHandler $guiHandler
58		* @param Factory $groupFactory
59		* @param ActionFactory $actionFactory
60		* @param $name
61		* @param $sizeX
62		* @param $sizeY
63		* @param null $posX
64		* @param null $posY
65		* @param string $className
66		*/
67	6	public function __construct(
68		$name,
69		$sizeX,
70		$sizeY,
71		$posX = null,
72		$posY = null,
73		GuiHandler $guiHandler,
74		Factory $groupFactory,
75		ActionFactory $actionFactory,
76		$className = Manialink::class
77		) {
78	6	if (is_null($posX)) {
79	6	$posX = $sizeX / -2;
80		}
81
82	6	if (is_null($posY)) {
83	6	$posY = $sizeY / 2;
84		}
85
86	6	$this->guiHandler = $guiHandler;
87	6	$this->groupFactory = $groupFactory;
88	6	$this->actionFactory = $actionFactory;
89	6	$this->name = $name;
90	6	$this->className = $className;
91	6	$this->sizeX = $sizeX;
92	6	$this->sizeY = $sizeY;
93	6	$this->posX = $posX;
94	6	$this->posY = $posY;
95	6	}
96
97		/**
98		* @inheritdoc
99		*/
100	5	final public function create($group)
101		{
102	5	if (is_string($group)) {
103	1	$group = $this->groupFactory->createForPlayer($group);
104		} else {
105	4	if (is_array($group)) {
106	3	$group = $this->groupFactory->createForPlayers($group);
107		}
108		}
109
110	5	if (isset($this->manialinks[$group->getName()])) {
111		$this->update($group);
112
113		return $group;
114		}
115
116	5	$this->manialinks[$group->getName()] = $this->createManialink($group);
117	5	$this->guiHandler->addToDisplay($this->manialinks[$group->getName()]);
118
119	5	$this->createContent($this->manialinks[$group->getName()]);
120	5	$this->updateContent($this->manialinks[$group->getName()]);
121
122	5	return $group;
123		}
124
125		/**
126		* @inheritdoc
127		* @param Group $group
128		*/
129	4	final public function update($group)
130		{
131	4	if (isset($this->manialinks[$group->getName()])) {
132		$this->guiHandler->addToDisplay($this->manialinks[$group->getName()]);
133		$this->updateContent($this->manialinks[$group->getName()]);
134		}
135	4	}
136
137		/**
138		* Create content in the manialink.
139		*
140		* @param ManialinkInterface $manialink
141		*
142		*/
143	5	protected function createContent(ManialinkInterface $manialink)
144		{
145		// Put content in the manialink here.
146	5	}
147
148		/**
149		* Update content in the manialink.
150		*
151		* @param ManialinkInterface $manialink
152		*
153		*/
154	5	protected function updateContent(ManialinkInterface $manialink)
155		{
156		// Put content in the manialink here.
157	5	}
158
159		/**
160		* @inheritdoc
161		*/
162	1	final public function destroy(Group $group)
163		{
164	1	if (isset($this->manialinks[$group->getName()])) {
165	1	$this->guiHandler->addToHide($this->manialinks[$group->getName()]);
166	1	$this->actionFactory->destroyManialinkActions($this->manialinks[$group->getName()]);
167	1	unset($this->manialinks[$group->getName()]);
168		}
169	1	}
170
171		/**
172		* Create manialink object for user group.
173		*
174		* @param Group $group
175		*
176		* @return Manialink
177		*/
178	5	protected function createManialink(Group $group)
179		{
180	5	$className = $this->className;
181
182	5	return new $className($group, $this->name, $this->sizeX, $this->sizeY, $this->posX, $this->posY);
183		}
184
185		/**
186		* When a gup is destroyed, destroy manialinks of the group.
187		*
188		* @param Group $group
189		* @param $lastLogin
190		*
191		* @return void
192		*/
193	1	public function onExpansionGroupDestroy(Group $group, $lastLogin)
194		{
195	1	if (isset($this->manialinks[$group->getName()])) {
196		// Gui Handler will handle delete by it's own.
197	1	$this->actionFactory->destroyManialinkActions($this->manialinks[$group->getName()]);
198	1	unset($this->manialinks[$group->getName()]);
199		}
200	1	}
201
202	1	public function onExpansionGroupAddUser(Group $group, $loginAdded)
203		{
204		// nothing to do here.
205	1	}
206
207	1	public function onExpansionGroupRemoveUser(Group $group, $loginRemoved)
208		{
209		// nothing to do here.
210	1	}
211
212		}
213

eXpansionPluginPack / eXpansion2

Pull Request — master (#95)

ManialinkFactory::create() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like