Game::addPlugin() - Code Metrics - dedicated-panel/dedipanel - Measure and Improve Code Quality continuously with Scrutinizer

Game::addPlugin() A
last analyzed 2016-08-19 23:54 UTC

↳ Parent: Game

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	2
eloc	4
nc	2
nop	1

<?php

/**
 * This file is part of Dedipanel project
 *
 * (c) 2010-2015 Dedipanel <http://www.dedicated-panel.net>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace DP\Core\GameBundle\Entity;

use Doctrine\ORM\Mapping as ORM;
use Knp\DictionaryBundle\Validator\Constraints\Dictionary;
use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Context\ExecutionContextInterface;

/**
 * DP\Core\GameBundle\Entity\Game
 * @author Albin Kerouanton
 *
 * @ORM\Table(name="game")
 * @ORM\Entity(repositoryClass="DP\Core\GameBundle\Entity\GameRepository")
 * @Assert\Callback(methods={"validateAppId"})
 * @UniqueEntity(fields="name", message="game.assert.name.unique")
 * @UniqueEntity(fields={"appId","appMod"}, message="game.assert.unique_id_mod")
 */
class Game
{
    /**
     * @var integer $id
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @var string $name
     *
     * @ORM\Column(name="name", type="string", length=32)
     * @Assert\NotBlank(message="game.assert.name.needed")
     */
    private $name;

    /**
     * @var boolean $steamCmd
     *
     * @ORM\Column(name="steamCmd", type="boolean")
     */
    private $steamCmd = false; // default value

    /**
     * @var boolean $source
     *
     * @ORM\Column(name="source", type="boolean")
     */
    private $source = false;

    /**
     * @var string $launchName
     *
     * @ORM\Column(name="launchName", type="string", length=24)
     * @Assert\NotBlank(message="game.assert.launchName")
     */
    private $launchName;

    /**
     * @var string $bin
     *
     * @ORM\Column(name="bin", type="string", length=24)
     * @Assert\NotBlank(message="game.assert.bin")
     */
    private $bin;

    /**
     * @var integer $appId
     *
     * @ORM\Column(name="appId", type="integer", nullable=true)
     */
    protected $appId;

    /**
     * @var string $appMod
     *
     * @ORM\Column(name="appMod", type="string", length=20, nullable=true)
     */
    protected $appMod;

    /**
     * @var string $map
     *
     * @ORM\Column(name="map", type="string", length=40, nullable=true)
     */
    private $map;

    /**
     * @var boolean $available
     *
     * @ORM\Column(name="available", type="boolean")
     * @Assert\NotNull(message="game.assert.available")
     */
    private $available = true;

    /**
     * @var string $binDir
     *
     * @ORM\Column(name="binDir", type="string", length=20, nullable=true)
     */
    private $binDir;

   /**
     * @var string $cfgPath
     *
     * @ORM\Column(name="cfgPath", type="string", length=255, nullable=true)
     */
    protected $cfgPath;

    /**
     * @var string $cfgPath
     *
     * @ORM\Column(name="cfgPath", type="string", length=255, nullable=true)
     */
    protected $cfgPath;

    /**
     * @ORM\Column(name="sourceImagesMaps", type="string", length=255, nullable=true)
     * @var string
     */
    private $sourceImagesMaps;

    /**
     * @var \Doctrine\Common\Collections\ArrayCollection $gameServers
     *
     * @ORM\OneToMany(targetEntity="DP\GameServer\GameServerBundle\Entity\GameServer", mappedBy="game", cascade={"remove"})
     */
    private $gameServers;

    /**
     * @var \Doctrine\Common\Collections\ArrayCollection $plugins
     *
     * @ORM\ManyToMany(targetEntity="DP\Core\GameBundle\Entity\Plugin", inversedBy="games")
     * @ORM\JoinTable(name="game_plugin",
     *      joinColumns={@ORM\JoinColumn(name="game_id", referencedColumnName="id")},
     *      inverseJoinColumns={@ORM\JoinColumn(name="plugin_id", referencedColumnName="id")}
     * )
     */
    private $plugins;

    /**
     * @ORM\Column(name="type", type="string", length=32)
     * @Dictionary(name="game_type", message="game.assert.type")
     */
    private $type;

    /**
     * @ORM\Column(name="configTemplate", type="text", nullable=true)
     */
    private $configTemplate;


    public function __construct()
    {
        $this->plugins = new \Doctrine\Common\Collections\ArrayCollection(array());
    }

    /**
     * Get id
     *
     * @return integer
     */
    public function getId()
    {
        return $this->id;
    }

    /**
     * Set name
     *
     * @param string $name
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * Get name
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Set launchName
     *
     * @param string $launchName
     */
    public function setLaunchName($launchName)
    {
        $this->launchName = $launchName;
    }

    /**
     * Get launchName
     *
     * @return string
     */
    public function getLaunchName()
    {
        return $this->launchName;
    }

    /**
     * Set bin
     *
     * @param string $bin
     */
    public function setBin($bin)
    {
        $this->bin = $bin;
    }

    /**
     * Get bin
     *
     * @return string
     */
    public function getBin()
    {
        return $this->bin;
    }

    /**
     * Set map
     *
     * @param string $map
     */
    public function setMap($map)
    {
        $this->map = $map;
    }

    /**
     * Get map
     *
     * @return string
     */
    public function getMap()
    {
        return $this->map;
    }

    /**
     * Set available
     *
     * @param boolean $available
     */
    public function setAvailable($available)
    {
        $this->available = $available;
    }

    /**
     * Get available
     *
     * @return boolean
     */
    public function getAvailable()
    {
        return $this->available;
    }

    public function __toString()
    {
        return $this->name;
    }

    /**
     * Set binary directory
     *
     * @param string $binDir
     */
    public function setBinDir($binDir)
    {
        $this->binDir = $binDir;
    }

    /**
     * Get binary directory
     *
     * @return string
     */
    public function getBinDir()
    {
        if (empty($this->binDir)) {
            return '';
        }
        
        return $this->binDir;
    }

    /**
     * Set cfg path
     *
     * @param string $cfgPath
     */
    public function setCfgPath($cfgPath)
    {
        $this->cfgPath = $cfgPath;
    }

    /**

     * Get cfg path
     *
     * @return string
     */
    public function getCfgPath()
    {
        return $this->cfgPath;
    }


    /**
     * Set source of images maps
     *
     * @param string $sourceImagesMaps
     */
    public function setSourceImagesMaps($sourceImagesMaps)
    {
        $this->sourceImagesMaps = $sourceImagesMaps;
    }

    /**
     * Get source of images maps
     *
     * @return string
     */
    public function getSourceImagesMaps()
    {
        return $this->sourceImagesMaps;
    }

    /**
     * Add plugins
     *
     * @param  $plugin \Doctrine\Common\Collections\ArrayCollection
     */
    public function addPlugin(\DP\Core\GameBundle\Entity\Plugin $plugin)
    {
        $this->plugins[] = $plugin;

        if (!$plugin->getGames()->contains($this)) {
            $plugin->addGame($this);
        }
    }

    public function removePlugin(Plugin $plugin)
    {
        $this->plugins->removeElement($plugin);
    }

    /**
     * Set plugin list
     *
     * @param array $plugins
     */
    public function setPlugins(array $plugins = array())
    {
        $this->plugins = new \Doctrine\Common\Collections\ArrayCollection($plugins);
    }

    /**
     * Get plugins
     *
     * @return \Doctrine\Common\Collections\ArrayCollection
     */
    public function getPlugins()
    {
        return $this->plugins;
    }

    /**
     * Set game type (steam or minecraft)
     *
     * @param string $type
     */
    public function setType($type)
    {
        $this->type = $type;
    }

    /**
     * @return string Game type
     */
    public function getType()
    {
        return $this->type;
    }

    public function isBukkit()
    {
        return $this->getLaunchName() == 'bukkit';
    }

    /**
     * Set the server config file template
     * @param string|null $configTemplate
     */
    public function setConfigTemplate($configTemplate)
    {
        $this->configTemplate = $configTemplate;
    }

    /**
     * Get the server config file template
     *
     * @return string
     */
    public function getConfigTemplate()
    {
        return $this->configTemplate;
    }

    /**
     * Set appId
     *
     * @param integer $appId
     * @return Game
     */
    public function setAppId($appId)
    {
        $this->appId = $appId;

        return $this;
    }

    /**
     * Get appId
     *
     * @return integer
     */
    public function getAppId()
    {
        return $this->appId;
    }

    /**
     * Set appMod
     *
     * @param string $appMod
     * @return Game
     */
    public function setAppMod($appMod)
    {
        $this->appMod = $appMod;

        return $this;
    }

    /**
     * Get appMod
     *
     * @return integer
     */
    public function getAppMod()
    {
        return $this->appMod;
    }

    /**
     * Set source
     *
     * @param boolean $source
     */
    public function setSource($source)
    {
        $this->source = $source;
    }

    /**
     * Get source
     *
     * @return boolean
     */
    public function isSource()
    {
        return $this->source;
    }


    /**
     * Get source
     *
     * @return boolean
     */
    public function getSource()
    {
        return $this->source;
    }

    /**
     * Add gameServers
     *
     * @param \DP\GameServer\GameServerBundle\Entity\GameServer $gameServers
     * @return Game
     */
    public function addGameServer(\DP\GameServer\GameServerBundle\Entity\GameServer $gameServers)
    {
        $this->gameServers[] = $gameServers;

        return $this;
    }

    /**
     * Remove gameServers
     *
     * @param \DP\GameServer\GameServerBundle\Entity\GameServer $gameServers
     */
    public function removeGameServer(\DP\GameServer\GameServerBundle\Entity\GameServer $gameServers)
    {
        $this->gameServers->removeElement($gameServers);
    }

    /**
     * Get gameServers
     *
     * @return \Doctrine\Common\Collections\Collection
     */
    public function getGameServers()
    {
        return $this->gameServers;
    }

    public function validateAppId(ExecutionContextInterface $context)
    {
        $appId = $this->getAppId();
        
        if ('steam' === $this->getType() && empty($appId)) {
            $context->buildViolation('game.assert.appId.needed')
                ->atPath('appId')
                ->addViolation();
        } elseif ('steam' !== $this->getType() && !empty($appId)) {
            $context->buildViolation('game.assert.appId.not_needed')
                ->atPath('appId')
                ->addViolation();
        }
    }
}


1			<?php
2
3			/**
4			* This file is part of Dedipanel project
5			*
6			* (c) 2010-2015 Dedipanel <http://www.dedicated-panel.net>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace DP\Core\GameBundle\Entity;
13
14			use Doctrine\ORM\Mapping as ORM;
15			use Knp\DictionaryBundle\Validator\Constraints\Dictionary;
16			use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
17			use Symfony\Component\Validator\Constraints as Assert;
18			use Symfony\Component\Validator\Context\ExecutionContextInterface;
19
20			/**
21			* DP\Core\GameBundle\Entity\Game
22			* @author Albin Kerouanton
23			*
24			* @ORM\Table(name="game")
25			* @ORM\Entity(repositoryClass="DP\Core\GameBundle\Entity\GameRepository")
26			* @Assert\Callback(methods={"validateAppId"})
27			* @UniqueEntity(fields="name", message="game.assert.name.unique")
28			* @UniqueEntity(fields={"appId","appMod"}, message="game.assert.unique_id_mod")
29			*/
30			class Game
31			{
32			/**
33			* @var integer $id
34			*
35			* @ORM\Column(name="id", type="integer")
36			* @ORM\Id
37			* @ORM\GeneratedValue(strategy="AUTO")
38			*/
39			private $id;
40
41			/**
42			* @var string $name
43			*
44			* @ORM\Column(name="name", type="string", length=32)
45			* @Assert\NotBlank(message="game.assert.name.needed")
46			*/
47			private $name;
48
49			/**
50			* @var boolean $steamCmd
51			*
52			* @ORM\Column(name="steamCmd", type="boolean")
53			*/
54			private $steamCmd = false; // default value
55
56			/**
57			* @var boolean $source
58			*
59			* @ORM\Column(name="source", type="boolean")
60			*/
61			private $source = false;
62
63			/**
64			* @var string $launchName
65			*
66			* @ORM\Column(name="launchName", type="string", length=24)
67			* @Assert\NotBlank(message="game.assert.launchName")
68			*/
69			private $launchName;
70
71			/**
72			* @var string $bin
73			*
74			* @ORM\Column(name="bin", type="string", length=24)
75			* @Assert\NotBlank(message="game.assert.bin")
76			*/
77			private $bin;
78
79			/**
80			* @var integer $appId
81			*
82			* @ORM\Column(name="appId", type="integer", nullable=true)
83			*/
84			protected $appId;
85
86			/**
87			* @var string $appMod
88			*
89			* @ORM\Column(name="appMod", type="string", length=20, nullable=true)
90			*/
91			protected $appMod;
92
93			/**
94			* @var string $map
95			*
96			* @ORM\Column(name="map", type="string", length=40, nullable=true)
97			*/
98			private $map;
99
100			/**
101			* @var boolean $available
102			*
103			* @ORM\Column(name="available", type="boolean")
104			* @Assert\NotNull(message="game.assert.available")
105			*/
106			private $available = true;
107
108			/**
109			* @var string $binDir
110			*
111			* @ORM\Column(name="binDir", type="string", length=20, nullable=true)
112			*/
113			private $binDir;
114
115			/**
116			* @var string $cfgPath
117			*
118			* @ORM\Column(name="cfgPath", type="string", length=255, nullable=true)
119			*/
120			protected $cfgPath;
121
122			/**
123			* @var string $cfgPath
124			*
125			* @ORM\Column(name="cfgPath", type="string", length=255, nullable=true)
126			*/
127			protected $cfgPath;
128
129			/**
130			* @ORM\Column(name="sourceImagesMaps", type="string", length=255, nullable=true)
131			* @var string
132			*/
133			private $sourceImagesMaps;
134
135			/**
136			* @var \Doctrine\Common\Collections\ArrayCollection $gameServers
137			*
138			* @ORM\OneToMany(targetEntity="DP\GameServer\GameServerBundle\Entity\GameServer", mappedBy="game", cascade={"remove"})
139			*/
140			private $gameServers;
141
142			/**
143			* @var \Doctrine\Common\Collections\ArrayCollection $plugins
144			*
145			* @ORM\ManyToMany(targetEntity="DP\Core\GameBundle\Entity\Plugin", inversedBy="games")
146			* @ORM\JoinTable(name="game_plugin",
147			* joinColumns={@ORM\JoinColumn(name="game_id", referencedColumnName="id")},
148			* inverseJoinColumns={@ORM\JoinColumn(name="plugin_id", referencedColumnName="id")}
149			* )
150			*/
151			private $plugins;
152
153			/**
154			* @ORM\Column(name="type", type="string", length=32)
155			* @Dictionary(name="game_type", message="game.assert.type")
156			*/
157			private $type;
158
159			/**
160			* @ORM\Column(name="configTemplate", type="text", nullable=true)
161			*/
162			private $configTemplate;
163
164
165			public function __construct()
166			{
167			$this->plugins = new \Doctrine\Common\Collections\ArrayCollection(array());
168			}
169
170			/**
171			* Get id
172			*
173			* @return integer
174			*/
175			public function getId()
176			{
177			return $this->id;
178			}
179
180			/**
181			* Set name
182			*
183			* @param string $name
184			*/
185			public function setName($name)
186			{
187			$this->name = $name;
188			}
189
190			/**
191			* Get name
192			*
193			* @return string
194			*/
195			public function getName()
196			{
197			return $this->name;
198			}
199
200			/**
201			* Set launchName
202			*
203			* @param string $launchName
204			*/
205			public function setLaunchName($launchName)
206			{
207			$this->launchName = $launchName;
208			}
209
210			/**
211			* Get launchName
212			*
213			* @return string
214			*/
215			public function getLaunchName()
216			{
217			return $this->launchName;
218			}
219
220			/**
221			* Set bin
222			*
223			* @param string $bin
224			*/
225			public function setBin($bin)
226			{
227			$this->bin = $bin;
228			}
229
230			/**
231			* Get bin
232			*
233			* @return string
234			*/
235			public function getBin()
236			{
237			return $this->bin;
238			}
239
240			/**
241			* Set map
242			*
243			* @param string $map
244			*/
245			public function setMap($map)
246			{
247			$this->map = $map;
248			}
249
250			/**
251			* Get map
252			*
253			* @return string
254			*/
255			public function getMap()
256			{
257			return $this->map;
258			}
259
260			/**
261			* Set available
262			*
263			* @param boolean $available
264			*/
265			public function setAvailable($available)
266			{
267			$this->available = $available;
268			}
269
270			/**
271			* Get available
272			*
273			* @return boolean
274			*/
275			public function getAvailable()
276			{
277			return $this->available;
278			}
279
280			public function __toString()
281			{
282			return $this->name;
283			}
284
285			/**
286			* Set binary directory
287			*
288			* @param string $binDir
289			*/
290			public function setBinDir($binDir)
291			{
292			$this->binDir = $binDir;
293			}
294
295			/**
296			* Get binary directory
297			*
298			* @return string
299			*/
300			public function getBinDir()
301			{
302			if (empty($this->binDir)) {
303			return '';
304			}
305
306			return $this->binDir;
307			}
308
309			/**
310			* Set cfg path
311			*
312			* @param string $cfgPath
313			*/
314			public function setCfgPath($cfgPath)
315			{
316			$this->cfgPath = $cfgPath;
317			}
318
319			/**
320
321			* Get cfg path
322			*
323			* @return string
324			*/
325			public function getCfgPath()
326			{
327			return $this->cfgPath;
328			}
329
330
331			/**
332			* Set source of images maps
333			*
334			* @param string $sourceImagesMaps
335			*/
336			public function setSourceImagesMaps($sourceImagesMaps)
337			{
338			$this->sourceImagesMaps = $sourceImagesMaps;
339			}
340
341			/**
342			* Get source of images maps
343			*
344			* @return string
345			*/
346			public function getSourceImagesMaps()
347			{
348			return $this->sourceImagesMaps;
349			}
350
351			/**
352			* Add plugins
353			*
354			* @param $plugin \Doctrine\Common\Collections\ArrayCollection
355			*/
356			public function addPlugin(\DP\Core\GameBundle\Entity\Plugin $plugin)
357			{
358			$this->plugins[] = $plugin;
359
360			if (!$plugin->getGames()->contains($this)) {
361			$plugin->addGame($this);
362			}
363			}
364
365			public function removePlugin(Plugin $plugin)
366			{
367			$this->plugins->removeElement($plugin);
368			}
369
370			/**
371			* Set plugin list
372			*
373			* @param array $plugins
374			*/
375			public function setPlugins(array $plugins = array())
376			{
377			$this->plugins = new \Doctrine\Common\Collections\ArrayCollection($plugins);
378			}
379
380			/**
381			* Get plugins
382			*
383			* @return \Doctrine\Common\Collections\ArrayCollection
384			*/
385			public function getPlugins()
386			{
387			return $this->plugins;
388			}
389
390			/**
391			* Set game type (steam or minecraft)
392			*
393			* @param string $type
394			*/
395			public function setType($type)
396			{
397			$this->type = $type;
398			}
399
400			/**
401			* @return string Game type
402			*/
403			public function getType()
404			{
405			return $this->type;
406			}
407
408			public function isBukkit()
409			{
410			return $this->getLaunchName() == 'bukkit';
411			}
412
413			/**
414			* Set the server config file template
415			* @param string\|null $configTemplate
416			*/
417			public function setConfigTemplate($configTemplate)
418			{
419			$this->configTemplate = $configTemplate;
420			}
421
422			/**
423			* Get the server config file template
424			*
425			* @return string
426			*/
427			public function getConfigTemplate()
428			{
429			return $this->configTemplate;
430			}
431
432			/**
433			* Set appId
434			*
435			* @param integer $appId
436			* @return Game
437			*/
438			public function setAppId($appId)
439			{
440			$this->appId = $appId;
441
442			return $this;
443			}
444
445			/**
446			* Get appId
447			*
448			* @return integer
449			*/
450			public function getAppId()
451			{
452			return $this->appId;
453			}
454
455			/**
456			* Set appMod
457			*
458			* @param string $appMod
459			* @return Game
460			*/
461			public function setAppMod($appMod)
462			{
463			$this->appMod = $appMod;
464
465			return $this;
466			}
467
468			/**
469			* Get appMod
470			*
471			* @return integer
472			*/
473			public function getAppMod()
474			{
475			return $this->appMod;
476			}
477
478			/**
479			* Set source
480			*
481			* @param boolean $source
482			*/
483			public function setSource($source)
484			{
485			$this->source = $source;
486			}
487
488			/**
489			* Get source
490			*
491			* @return boolean
492			*/
493			public function isSource()
494			{
495			return $this->source;
496			}
497
498
499			/**
500			* Get source
501			*
502			* @return boolean
503			*/
504			public function getSource()
505			{
506			return $this->source;
507			}
508
509			/**
510			* Add gameServers
511			*
512			* @param \DP\GameServer\GameServerBundle\Entity\GameServer $gameServers
513			* @return Game
514			*/
515			public function addGameServer(\DP\GameServer\GameServerBundle\Entity\GameServer $gameServers)
516			{
517			$this->gameServers[] = $gameServers;
518
519			return $this;
520			}
521
522			/**
523			* Remove gameServers
524			*
525			* @param \DP\GameServer\GameServerBundle\Entity\GameServer $gameServers
526			*/
527			public function removeGameServer(\DP\GameServer\GameServerBundle\Entity\GameServer $gameServers)
528			{
529			$this->gameServers->removeElement($gameServers);
530			}
531
532			/**
533			* Get gameServers
534			*
535			* @return \Doctrine\Common\Collections\Collection
536			*/
537			public function getGameServers()
538			{
539			return $this->gameServers;
540			}
541
542			public function validateAppId(ExecutionContextInterface $context)
543			{
544			$appId = $this->getAppId();
545
546			if ('steam' === $this->getType() && empty($appId)) {
547			$context->buildViolation('game.assert.appId.needed')
548			->atPath('appId')
549			->addViolation();
550			} elseif ('steam' !== $this->getType() && !empty($appId)) {
551			$context->buildViolation('game.assert.appId.not_needed')
552			->atPath('appId')
553			->addViolation();
554			}
555			}
556			}
557

dedicated-panel / dedipanel

Game::addPlugin() A last analyzed 2016-08-19 23:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Game::addPlugin() A
last analyzed 2016-08-19 23:54 UTC