TradingCard::getModelPath() - Code Metrics - Inspection of "Merge pull request #400 from gregorybesson/develop" - gregorybesson/PlaygroundGame - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d88f38...92f9ab )

by greg

created 2018-11-14 07:21 UTC

TradingCard::getModelPath() A

↳ Parent: TradingCard

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	3
nc	4
nop	1

<?php

namespace PlaygroundGame\Service;

use Zend\Stdlib\ErrorHandler;

class TradingCard extends Game
{
    protected $tradingcardMapper;
    protected $tradingcardmodelMapper;
    protected $tradingcardcardMapper;

    public function getModelPath($model)
    {
        $path = $this->getOptions()->getMediaPath().DIRECTORY_SEPARATOR;
        $path .= 'game'.$model->getGame()->getId().DIRECTORY_SEPARATOR;
        if (!is_dir($path)) {
            mkdir($path, 0777, true);
        }
        $path .= 'models'.DIRECTORY_SEPARATOR;
        if (!is_dir($path)) {
            mkdir($path, 0777, true);
        }

        return $path;
    }

    public function getModelMediaUrl($model)
    {
        $media_url = $this->getOptions()->getMediaUrl().'/';
        $media_url .= 'game'.$model->getGame()->getId().'/models/';

        return $media_url;
    }

    /**
     * @param  array $data
     * @return \PlaygroundGame\Entity\Game
     */
    public function updateModel(array $data, $model)
    {
        $form        = $this->serviceLocator->get('playgroundgame_tradingcardmodel_form');
        $tradingcard = $this->getGameMapper()->findById($data['trading_card_id']);
        $model->setGame($tradingcard);
        $path      = $this->getModelPath($model);
        $media_url = $this->getModelMediaUrl($model);

        $form->bind($model);
        $form->setData($data);

        if (!$form->isValid()) {
            return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

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

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
        if (!empty($data['upload_image']['tmp_name'])) {

            
            ErrorHandler::start();
            $data['upload_image']['name'] = $this->fileNewname(
                $path,
                $model->getId()."-".$data['upload_image']['name']
            );
            move_uploaded_file($data['upload_image']['tmp_name'], $path.$data['upload_image']['name']);
            $model->setImage($media_url.$data['upload_image']['name']);
            ErrorHandler::stop(true);
        }

        $this->getTradingCardModelMapper()->update($model);
        $this->getEventManager()->trigger(
            __FUNCTION__ .'.post',
            $this,
            array('model' => $model, 'data' => $data)
        );

        return $model;
    }

    public function getBooster($game, $user, $entry)
    {
        // get booster config from $game
        $em      = $this->serviceLocator->get('doctrine.entitymanager.orm_default');
        $nb      = $game->getBoosterCardNumber();
        $booster = [];

        $today = new \DateTime("now");
        $today = $today->format('Y-m-d H:i:s');

        $qb  = $em->createQueryBuilder();
        $and = $qb->expr()->andx();
        $and->add(
            $qb->expr()->orX(
                $qb->expr()->lte('g.availability', ':date'),
                $qb->expr()->isNull('g.availability')
            )
        );

        $qb->setParameter('date', $today);
        $qb->select('g')
           ->from('PlaygroundGame\Entity\TradingCardModel', 'g')
           ->where($and);

        $query  = $qb->getQuery();
        $models = $query->getResult();

        shuffle($models);

        $eventModels = $this->getEventManager()->trigger(
            __FUNCTION__ .'.pre',
            $this,
            array(
                'game'   => $game,
                'user'   => $user,
                'entry'  => $entry,
                'models' => $models,
            )
        )->last();

        if ($eventModels) {
            $models = $eventModels;
        }

        for ($i = 0; $i < $nb; $i++) {
            $model = $models[$i];
            $card  = new \PlaygroundGame\Entity\TradingCardCard();
            $card->setUser($user);
            $card->setModel($model);
            $card->setGame($game);
            $card->setEntry($entry);
            $card = $this->getTradingCardCardMapper()->insert($card);

            $booster[] = $card;
        }

        $eventBooster = $this->getEventManager()->trigger(
            __FUNCTION__ .'.post',
            $this,
            array(
                'game'    => $game,
                'user'    => $user,
                'entry'   => $entry,
                'booster' => $booster,
            )
        )->last();

        if ($eventBooster) {
            $booster = $eventBooster;
        }

        // sending a booster represents an entry. We close the entry after that
        $entry->setActive(0);
        $entry = $this->getEntryMapper()->update($entry);
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        return $booster;
    }

    public function getAlbum($game, $user)
    {
        // all the models of the album
        $models = $this->getTradingCardModelMapper()->findAll();
        $em = $this->serviceLocator->get('doctrine.entitymanager.orm_default');

        if ($user) {
            $qb = $em->createQueryBuilder();
            $and = $qb->expr()->andx();
            $and->add($qb->expr()->eq('g.id', ':game'));
            $qb->setParameter('game', $game);
            $and->add($qb->expr()->eq('u.id', ':user'));
            $qb->setParameter('user', $user);
            $qb->select('c')
                ->from('PlaygroundGame\Entity\TradingCardCard', 'c')
                ->innerJoin('c.game', 'g')
                ->innerJoin('c.model', 'm')
                ->innerJoin('c.user', 'u')
                ->where($and)
                ->orderBy('m.id', 'ASC')
                ->groupBy('c.model');
            $query = $qb->getQuery();
        } elseif ($game->getAnonymousAllowed() && $this->getAnonymousIdentifier()) {
            $limitDate = $this->getLimitDate('always');
            $entries = $this->getEntryMapper()->findLastEntriesByAnonymousIdentifier(
                $game,
                $this->getAnonymousIdentifier(),
                $limitDate
            );
            $qb = $em->createQueryBuilder();
            $qb->andWhere('e.id IN (:entries)')->setParameter('entries', $entries);
            $qb->select('c')
                ->from('PlaygroundGame\Entity\TradingCardCard', 'c')
                ->innerJoin('c.model', 'm')
                ->innerJoin('c.game', 'g')
                ->innerJoin('c.entry', 'e')
                ->orderBy('m.id', 'ASC')
                ->groupBy('c.model');
            $query = $qb->getQuery();
        } elseif ($game->getAnonymousAllowed()) {
            $limitDate = $this->getLimitDate('always');
            $entries = $this->getEntryMapper()->findLastEntriesByIp(
                $game,
                $this->getIp(),
                $limitDate
            );
            $qb = $em->createQueryBuilder();
            $qb->andWhere('e.id IN (:entries)')->setParameter('entries', $entries);
            $qb->select('c')
                ->from('PlaygroundGame\Entity\TradingCardCard', 'c')
                ->innerJoin('c.model', 'm')
                ->innerJoin('c.game', 'g')
                ->innerJoin('c.entry', 'e')
                ->orderBy('m.id', 'ASC')
                ->groupBy('c.model');
            $query = $qb->getQuery();
        } else {

            // If the game is supposed to be a regular user game or an anonymous identified game,
            // it means that the registration/login is at the end of the game
            if((!$user &&  !$game->getAnonymousAllowed()) || ($game->getAnonymousAllowed() && $game->getAnonymousIdentifier())) {
                return 0;
            }
            return $this->getEntryMapper()->findLastEntriesByIp($game, $this->getIp(), $limitDate);
function someFunction() {
    $x = 5;
    echo $x;
}
        }

        
        // all the cards of the user
        $cards = $query->getResult();
        $cardsArray = [];
        foreach ($cards as $card) {
            $cardsArray[$card->getModel()->getId()] = $card;
        }

        $album = [];

        // I create the complete album including the cards of the user
        foreach($models as $model) {
            $sticker['model'] = $model;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            if(isset($cardsArray[$model->getId()])) {
                $sticker['card'] = $cardsArray[$model->getId()];
            } else {
                $sticker['card'] = null;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            }
            $album[] = $sticker;
        }

        return $album;
    }

    public function getGameEntity()
    {
        return new \PlaygroundGame\Entity\TradingCard;
    }

    public function getTradingCardMapper()
    {
        if (null === $this->tradingcardMapper) {
            $this->tradingcardMapper = $this->serviceLocator->get('playgroundgame_tradingcard_mapper');
        }

        return $this->tradingcardMapper;
    }

    public function getTradingCardCardMapper()
    {
        if (null === $this->tradingcardcardMapper) {
            $this->tradingcardcardMapper = $this->serviceLocator->get('playgroundgame_tradingcard_card_mapper');
        }

        return $this->tradingcardcardMapper;
    }

    public function getTradingCardModelMapper()
    {
        if (null === $this->tradingcardmodelMapper) {
            $this->tradingcardmodelMapper = $this->serviceLocator->get('playgroundgame_tradingcard_model_mapper');
        }

        return $this->tradingcardmodelMapper;
    }
}


1		<?php
2
3		namespace PlaygroundGame\Service;
4
5		use Zend\Stdlib\ErrorHandler;
6
7		class TradingCard extends Game
8		{
9		protected $tradingcardMapper;
10		protected $tradingcardmodelMapper;
11		protected $tradingcardcardMapper;
12
13		public function getModelPath($model)
14		{
15		$path = $this->getOptions()->getMediaPath().DIRECTORY_SEPARATOR;
16		$path .= 'game'.$model->getGame()->getId().DIRECTORY_SEPARATOR;
17		if (!is_dir($path)) {
18		mkdir($path, 0777, true);
19		}
20		$path .= 'models'.DIRECTORY_SEPARATOR;
21		if (!is_dir($path)) {
22		mkdir($path, 0777, true);
23		}
24
25		return $path;
26		}
27
28		public function getModelMediaUrl($model)
29		{
30		$media_url = $this->getOptions()->getMediaUrl().'/';
31		$media_url .= 'game'.$model->getGame()->getId().'/models/';
32
33		return $media_url;
34		}
35
36		/**
37		* @param array $data
38		* @return \PlaygroundGame\Entity\Game
39		*/
40		public function updateModel(array $data, $model)
41		{
42		$form = $this->serviceLocator->get('playgroundgame_tradingcardmodel_form');
43		$tradingcard = $this->getGameMapper()->findById($data['trading_card_id']);
44		$model->setGame($tradingcard);
45		$path = $this->getModelPath($model);
46		$media_url = $this->getModelMediaUrl($model);
47
48		$form->bind($model);
49		$form->setData($data);
50
51		if (!$form->isValid()) {
52		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-02-09 23:46 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `PlaygroundGame\Service\TradingCard::updateModel` of type `PlaygroundGame\Entity\Game`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
53		}
54	View Code Duplication	if (!empty($data['upload_image']['tmp_name'])) {
		0 ignored issues – show Duplication introduced 2016-02-09 23:46 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...
55
56		ErrorHandler::start();
57		$data['upload_image']['name'] = $this->fileNewname(
58		$path,
59		$model->getId()."-".$data['upload_image']['name']
60		);
61		move_uploaded_file($data['upload_image']['tmp_name'], $path.$data['upload_image']['name']);
62		$model->setImage($media_url.$data['upload_image']['name']);
63		ErrorHandler::stop(true);
64		}
65
66		$this->getTradingCardModelMapper()->update($model);
67		$this->getEventManager()->trigger(
68		__FUNCTION__ .'.post',
69		$this,
70		array('model' => $model, 'data' => $data)
71		);
72
73		return $model;
74		}
75
76		public function getBooster($game, $user, $entry)
77		{
78		// get booster config from $game
79		$em = $this->serviceLocator->get('doctrine.entitymanager.orm_default');
80		$nb = $game->getBoosterCardNumber();
81		$booster = [];
82
83		$today = new \DateTime("now");
84		$today = $today->format('Y-m-d H:i:s');
85
86		$qb = $em->createQueryBuilder();
87		$and = $qb->expr()->andx();
88		$and->add(
89		$qb->expr()->orX(
90		$qb->expr()->lte('g.availability', ':date'),
91		$qb->expr()->isNull('g.availability')
92		)
93		);
94
95		$qb->setParameter('date', $today);
96		$qb->select('g')
97		->from('PlaygroundGame\Entity\TradingCardModel', 'g')
98		->where($and);
99
100		$query = $qb->getQuery();
101		$models = $query->getResult();
102
103		shuffle($models);
104
105		$eventModels = $this->getEventManager()->trigger(
106		__FUNCTION__ .'.pre',
107		$this,
108		array(
109		'game' => $game,
110		'user' => $user,
111		'entry' => $entry,
112		'models' => $models,
113		)
114		)->last();
115
116		if ($eventModels) {
117		$models = $eventModels;
118		}
119
120		for ($i = 0; $i < $nb; $i++) {
121		$model = $models[$i];
122		$card = new \PlaygroundGame\Entity\TradingCardCard();
123		$card->setUser($user);
124		$card->setModel($model);
125		$card->setGame($game);
126		$card->setEntry($entry);
127		$card = $this->getTradingCardCardMapper()->insert($card);
128
129		$booster[] = $card;
130		}
131
132		$eventBooster = $this->getEventManager()->trigger(
133		__FUNCTION__ .'.post',
134		$this,
135		array(
136		'game' => $game,
137		'user' => $user,
138		'entry' => $entry,
139		'booster' => $booster,
140		)
141		)->last();
142
143		if ($eventBooster) {
144		$booster = $eventBooster;
145		}
146
147		// sending a booster represents an entry. We close the entry after that
148		$entry->setActive(0);
149		$entry = $this->getEntryMapper()->update($entry);
		0 ignored issues – show Unused Code introduced 2016-02-09 23:46 UTC by Report Bug Copy Issue Report `$entry` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
150
151		return $booster;
152		}
153
154		public function getAlbum($game, $user)
155		{
156		// all the models of the album
157		$models = $this->getTradingCardModelMapper()->findAll();
158		$em = $this->serviceLocator->get('doctrine.entitymanager.orm_default');
159
160		if ($user) {
161		$qb = $em->createQueryBuilder();
162		$and = $qb->expr()->andx();
163		$and->add($qb->expr()->eq('g.id', ':game'));
164		$qb->setParameter('game', $game);
165		$and->add($qb->expr()->eq('u.id', ':user'));
166		$qb->setParameter('user', $user);
167		$qb->select('c')
168		->from('PlaygroundGame\Entity\TradingCardCard', 'c')
169		->innerJoin('c.game', 'g')
170		->innerJoin('c.model', 'm')
171		->innerJoin('c.user', 'u')
172		->where($and)
173		->orderBy('m.id', 'ASC')
174		->groupBy('c.model');
175		$query = $qb->getQuery();
176		} elseif ($game->getAnonymousAllowed() && $this->getAnonymousIdentifier()) {
177		$limitDate = $this->getLimitDate('always');
178		$entries = $this->getEntryMapper()->findLastEntriesByAnonymousIdentifier(
179		$game,
180		$this->getAnonymousIdentifier(),
181		$limitDate
182		);
183		$qb = $em->createQueryBuilder();
184		$qb->andWhere('e.id IN (:entries)')->setParameter('entries', $entries);
185		$qb->select('c')
186		->from('PlaygroundGame\Entity\TradingCardCard', 'c')
187		->innerJoin('c.model', 'm')
188		->innerJoin('c.game', 'g')
189		->innerJoin('c.entry', 'e')
190		->orderBy('m.id', 'ASC')
191		->groupBy('c.model');
192		$query = $qb->getQuery();
193		} elseif ($game->getAnonymousAllowed()) {
194		$limitDate = $this->getLimitDate('always');
195		$entries = $this->getEntryMapper()->findLastEntriesByIp(
196		$game,
197		$this->getIp(),
198		$limitDate
199		);
200		$qb = $em->createQueryBuilder();
201		$qb->andWhere('e.id IN (:entries)')->setParameter('entries', $entries);
202		$qb->select('c')
203		->from('PlaygroundGame\Entity\TradingCardCard', 'c')
204		->innerJoin('c.model', 'm')
205		->innerJoin('c.game', 'g')
206		->innerJoin('c.entry', 'e')
207		->orderBy('m.id', 'ASC')
208		->groupBy('c.model');
209		$query = $qb->getQuery();
210	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2018-11-14 02:55 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...
211		// If the game is supposed to be a regular user game or an anonymous identified game,
212		// it means that the registration/login is at the end of the game
213		if((!$user && !$game->getAnonymousAllowed()) \|\| ($game->getAnonymousAllowed() && $game->getAnonymousIdentifier())) {
214		return 0;
215		}
216		return $this->getEntryMapper()->findLastEntriesByIp($game, $this->getIp(), $limitDate);
		0 ignored issues – show Bug introduced 2018-11-14 02:55 UTC by Report Bug Copy Issue Report The variable `$limitDate` seems only to be defined at a later point. Did you maybe move this code here without moving the variable definition? This error can happen if you refactor code and forget to move the variable initialization. Let’s take a look at a simple example: function someFunction() { $x = 5; echo $x; } The above code is perfectly fine. Now imagine that we re-order the statements: function someFunction() { echo $x; $x = 5; } In that case, `$x` would be read before it is initialized. This was a very basic example, however the principle is the same for the found issue. Loading history...
217		}
218
219
220		// all the cards of the user
221		$cards = $query->getResult();
222		$cardsArray = [];
223		foreach ($cards as $card) {
224		$cardsArray[$card->getModel()->getId()] = $card;
225		}
226
227		$album = [];
228
229		// I create the complete album including the cards of the user
230		foreach($models as $model) {
231		$sticker['model'] = $model;
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-11-11 15:44 UTC by Report Bug Copy Issue Report `$sticker` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$sticker = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
232		if(isset($cardsArray[$model->getId()])) {
233		$sticker['card'] = $cardsArray[$model->getId()];
234		} else {
235		$sticker['card'] = null;
		0 ignored issues – show Bug introduced 2018-11-11 15:44 UTC by Report Bug Copy Issue Report The variable `$sticker` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
236		}
237		$album[] = $sticker;
238		}
239
240		return $album;
241		}
242
243		public function getGameEntity()
244		{
245		return new \PlaygroundGame\Entity\TradingCard;
246		}
247
248		public function getTradingCardMapper()
249		{
250		if (null === $this->tradingcardMapper) {
251		$this->tradingcardMapper = $this->serviceLocator->get('playgroundgame_tradingcard_mapper');
252		}
253
254		return $this->tradingcardMapper;
255		}
256
257		public function getTradingCardCardMapper()
258		{
259		if (null === $this->tradingcardcardMapper) {
260		$this->tradingcardcardMapper = $this->serviceLocator->get('playgroundgame_tradingcard_card_mapper');
261		}
262
263		return $this->tradingcardcardMapper;
264		}
265
266		public function getTradingCardModelMapper()
267		{
268		if (null === $this->tradingcardmodelMapper) {
269		$this->tradingcardmodelMapper = $this->serviceLocator->get('playgroundgame_tradingcard_model_mapper');
270		}
271
272		return $this->tradingcardmodelMapper;
273		}
274		}
275

gregorybesson / PlaygroundGame

Push — master ( d88f38...92f9ab )

TradingCard::getModelPath() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like