MatchFormCreator - Code Metrics - Inspection of "Move player sorting to SQL instead of PHP" - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/player-list ( be1f72...9f06dd )

by Vladimir

created 2017-07-21 02:51 UTC

MatchFormCreator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	182
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	14

Test Coverage

Coverage

60%

Importance

Changes

Metric	Value
wmc	19
lcom	2
cbo	14
dl	0
loc	182
ccs	69
cts	115
cp	0.6
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
B	build()	50	6
A	fill()	19	1
B	enter()	30	5
A	getPlayerList()	4	1
A	getModelToID()	6	1
B	update()	38	5

<?php
/**
 * This file contains a form creator for Matches
 *
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

namespace BZIon\Form\Creator;

use BZIon\Form\Type\DatetimeWithTimezoneType;
use BZIon\Form\Type\MatchTeamType;
use BZIon\Form\Type\ModelType;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\Validator\Constraints\LessThan;
use Symfony\Component\Validator\Constraints\NotBlank;

/**
 * Form creator for matches
 */
class MatchFormCreator extends ModelFormCreator
{
    /**
     * {@inheritdoc}
     */
    protected function build($builder)
    {
        $durations = \Service::getParameter('bzion.league.duration');
        foreach ($durations as $duration => &$value) {
            $durations[$duration] = $duration;
        }

        return $builder
            ->add('first_team', new MatchTeamType(), array(
                'disableTeam' => $this->isEdit() && $this->editing->isOfficial()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ))
            ->add('second_team', new MatchTeamType(), array(
                'disableTeam' => $this->isEdit() && $this->editing->isOfficial()
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ))
            ->add('duration', 'choice', array(
                'choices'     => $durations,
                'constraints' => new NotBlank(),
                'expanded'    => true
            ))
            ->add('server_address', 'text', array(
                'required' => false,
                'attr'     => array('placeholder' => 'brad.guleague.org:5100'),
            ))
            ->add('time', new DatetimeWithTimezoneType(), array(
                'constraints' => array(
                    new NotBlank(),
                    new LessThan(array(
                        'value'   => \TimeDate::now()->addMinutes(10),
                        'message' => 'The timestamp of the match must not be in the future'
                    ))
                ),
                'data' => ($this->isEdit())
                    ? $this->editing->getTimestamp()->setTimezone(\Controller::getMe()->getTimezone())
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                    : \TimeDate::now(\Controller::getMe()->getTimezone()),
                'with_seconds' => $this->isEdit()
            ))
            ->add('map', new ModelType('Map'), array(
                'required' => false
            ))
            ->add('type', 'choice', array(
                'choices'  => array(
                    \Match::OFFICIAL => 'Official',
                    \Match::FUN => 'Fun match',
                    \Match::SPECIAL => 'Special event match',
                ),
                'disabled' => $this->editing && $this->editing->isOfficial(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                'label' => 'Match Type'
            ))
            ->add('enter', 'submit');
    }

    /**
     * {@inheritdoc}
     *
     * @param \Match $match
     */
    public function fill($form, $match)
    {
        $form->get('first_team')->setData(array(
            'team'         => $match->getTeamA(),
            'participants' => $match->getTeamAPlayers(),
            'score'        => $match->getTeamAPoints()
        ));
        $form->get('second_team')->setData(array(
            'team'         => $match->getTeamB(),
            'participants' => $match->getTeamBPlayers(),
            'score'        => $match->getTeamBPoints()
        ));

        $form->get('duration')->setData($match->getDuration());
        $form->get('server_address')->setData($match->getServerAddress());
        $form->get('time')->setData($match->getTimestamp());
        $form->get('map')->setData($match->getMap());
        $form->get('type')->setData($match->getMatchType());
    }

    /**
     * {@inheritdoc}
     *
     * @param \Match $match
     */
    public function update($form, $match)
    {
        if (($match->getDuration() != $form->get('duration')->getData())
            || $match->getTimestamp()->ne($form->get('time')->getData())) {
            // The timestamp of the match was changed, we might need to
            // recalculate its ELO
            $this->controller->recalculateNeeded = true;

        }

        $firstTeam  = $form->get('first_team');
        $secondTeam = $form->get('second_team');

        if (!$match->isOfficial()) {
            $match->setTeamColors(
                $firstTeam->get('team')->getData(),
                $secondTeam->get('team')->getData()
            );
        }

        $match->setTeamPlayers(
            $this->getPlayerList($firstTeam),
            $this->getPlayerList($secondTeam)
        );

        $match->setTeamPoints(
            $firstTeam->get('score')->getData(),
            $secondTeam->get('score')->getData()
        );

        $match->setDuration($form->get('duration')->getData())
            ->setServerAddress($form->get('server_address')->getData())
            ->setTimestamp($form->get('time')->getData())
            ->setMap($form->get('map')->getData()->getId());

        if (!$match->isEloCorrect()) {
            $this->controller->recalculateNeeded = true;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function enter($form)
    {
        $firstTeam  = $form->get('first_team');
        $secondTeam = $form->get('second_team');

        $firstId = $firstTeam->get('team')->getData()->getId();
        $secondId = $secondTeam->get('team')->getData()->getId();

        $official = ($form->get('type')->getData() === \Match::OFFICIAL);

        $match = \Match::enterMatch(
            $official ? $firstId : null,
            $official ? $secondId : null,
            $firstTeam->get('score')->getData(),
            $secondTeam->get('score')->getData(),
            $form->get('duration')->getData(),
            $this->me->getId(),
            $form->get('time')->getData(),
            $this->getPlayerList($firstTeam),
            $this->getPlayerList($secondTeam),
            $form->get('server_address')->getData(),
            null,
            $form->get('map')->getData()->getId(),
            $form->get('type')->getData(),
            $official ? null : $firstId,
            $official ? null : $secondId
        );

        return $match;
    }

    /**
     * Get the player list of a team
     *
     * @param FormInterface $team A MatchTeamType form
     * @return array
     */
    private function getPlayerList(FormInterface $team)
    {
        return array_map($this->getModelToID(),  $team->get('participants')->getData());
    }

    /**
     * Get a function which converts models to their IDs
     *
     * Useful to store the match players into the database
     */
    private static function getModelToID()
    {
        return function ($model) {
            return $model->getId();
        };
    }
}


Push — feature/player-list ( be1f72...9f06dd )

MatchFormCreator A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2		/**
3		* This file contains a form creator for Matches
4		*
5		* @license https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
6		*/
7
8		namespace BZIon\Form\Creator;
9
10		use BZIon\Form\Type\DatetimeWithTimezoneType;
11		use BZIon\Form\Type\MatchTeamType;
12		use BZIon\Form\Type\ModelType;
13		use Symfony\Component\Form\FormInterface;
14		use Symfony\Component\Validator\Constraints\LessThan;
15		use Symfony\Component\Validator\Constraints\NotBlank;
16
17		/**
18		* Form creator for matches
19		*/
20		class MatchFormCreator extends ModelFormCreator
21		{
22		/**
23		* {@inheritdoc}
24		*/
25	1	protected function build($builder)
26		{
27	1	$durations = \Service::getParameter('bzion.league.duration');
28	1	foreach ($durations as $duration => &$value) {
29	1	$durations[$duration] = $duration;
30	1	}
31
32		return $builder
33	1	->add('first_team', new MatchTeamType(), array(
34	1	'disableTeam' => $this->isEdit() && $this->editing->isOfficial()
		0 ignored issues – show Bug introduced 2016-08-22 14:49 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Model` as the method `isOfficial()` does only exist in the following sub-classes of `Model`: `Match`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
35	1	))
36	1	->add('second_team', new MatchTeamType(), array(
37	1	'disableTeam' => $this->isEdit() && $this->editing->isOfficial()
		0 ignored issues – show Bug introduced 2016-08-22 14:49 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Model` as the method `isOfficial()` does only exist in the following sub-classes of `Model`: `Match`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
38	1	))
39	1	->add('duration', 'choice', array(
40	1	'choices' => $durations,
41	1	'constraints' => new NotBlank(),
42		'expanded' => true
43	1	))
44	1	->add('server_address', 'text', array(
45	1	'required' => false,
46	1	'attr' => array('placeholder' => 'brad.guleague.org:5100'),
47	1	))
48	1	->add('time', new DatetimeWithTimezoneType(), array(
49		'constraints' => array(
50	1	new NotBlank(),
51	1	new LessThan(array(
52	1	'value' => \TimeDate::now()->addMinutes(10),
53		'message' => 'The timestamp of the match must not be in the future'
54	1	))
55	1	),
56	1	'data' => ($this->isEdit())
57	1	? $this->editing->getTimestamp()->setTimezone(\Controller::getMe()->getTimezone())
		0 ignored issues – show Bug introduced 2016-02-26 00:07 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Model` as the method `getTimestamp()` does only exist in the following sub-classes of `Model`: `AbstractMessage`, `ConversationEvent`, `Match`, `Message`, `Notification`, `Visit`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
58	1	: \TimeDate::now(\Controller::getMe()->getTimezone()),
59	1	'with_seconds' => $this->isEdit()
60	1	))
61	1	->add('map', new ModelType('Map'), array(
62		'required' => false
63	1	))
64	1	->add('type', 'choice', array(
65		'choices' => array(
66	1	\Match::OFFICIAL => 'Official',
67	1	\Match::FUN => 'Fun match',
68	1	\Match::SPECIAL => 'Special event match',
69	1	),
70	1	'disabled' => $this->editing && $this->editing->isOfficial(),
		0 ignored issues – show Bug introduced 2016-08-22 21:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Model` as the method `isOfficial()` does only exist in the following sub-classes of `Model`: `Match`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
71		'label' => 'Match Type'
72	1	))
73	1	->add('enter', 'submit');
74		}
75
76		/**
77		* {@inheritdoc}
78		*
79		* @param \Match $match
80		*/
81		public function fill($form, $match)
82		{
83		$form->get('first_team')->setData(array(
84		'team' => $match->getTeamA(),
85		'participants' => $match->getTeamAPlayers(),
86		'score' => $match->getTeamAPoints()
87		));
88		$form->get('second_team')->setData(array(
89		'team' => $match->getTeamB(),
90		'participants' => $match->getTeamBPlayers(),
91		'score' => $match->getTeamBPoints()
92		));
93
94		$form->get('duration')->setData($match->getDuration());
95		$form->get('server_address')->setData($match->getServerAddress());
96		$form->get('time')->setData($match->getTimestamp());
97		$form->get('map')->setData($match->getMap());
98		$form->get('type')->setData($match->getMatchType());
99		}
100
101		/**
102		* {@inheritdoc}
103		*
104		* @param \Match $match
105		*/
106		public function update($form, $match)
107		{
108		if (($match->getDuration() != $form->get('duration')->getData())
109		\|\| $match->getTimestamp()->ne($form->get('time')->getData())) {
110		// The timestamp of the match was changed, we might need to
111		// recalculate its ELO
112		$this->controller->recalculateNeeded = true;
		0 ignored issues – show Bug introduced 2016-02-20 00:57 UTC by Report Bug Copy Issue Report The property `recalculateNeeded` does not seem to exist in `Controller`. An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
113		}
114
115		$firstTeam = $form->get('first_team');
116		$secondTeam = $form->get('second_team');
117
118		if (!$match->isOfficial()) {
119		$match->setTeamColors(
120		$firstTeam->get('team')->getData(),
121		$secondTeam->get('team')->getData()
122		);
123		}
124
125		$match->setTeamPlayers(
126		$this->getPlayerList($firstTeam),
127		$this->getPlayerList($secondTeam)
128		);
129
130		$match->setTeamPoints(
131		$firstTeam->get('score')->getData(),
132		$secondTeam->get('score')->getData()
133		);
134
135		$match->setDuration($form->get('duration')->getData())
136		->setServerAddress($form->get('server_address')->getData())
137		->setTimestamp($form->get('time')->getData())
138		->setMap($form->get('map')->getData()->getId());
139
140		if (!$match->isEloCorrect()) {
141		$this->controller->recalculateNeeded = true;
142		}
143		}
144
145		/**
146		* {@inheritdoc}
147		*/
148	1	public function enter($form)
149		{
150	1	$firstTeam = $form->get('first_team');
151	1	$secondTeam = $form->get('second_team');
152
153	1	$firstId = $firstTeam->get('team')->getData()->getId();
154	1	$secondId = $secondTeam->get('team')->getData()->getId();
155
156	1	$official = ($form->get('type')->getData() === \Match::OFFICIAL);
157
158	1	$match = \Match::enterMatch(
159	1	$official ? $firstId : null,
160	1	$official ? $secondId : null,
161	1	$firstTeam->get('score')->getData(),
162	1	$secondTeam->get('score')->getData(),
163	1	$form->get('duration')->getData(),
164	1	$this->me->getId(),
165	1	$form->get('time')->getData(),
166	1	$this->getPlayerList($firstTeam),
167	1	$this->getPlayerList($secondTeam),
168	1	$form->get('server_address')->getData(),
169	1	null,
170	1	$form->get('map')->getData()->getId(),
171	1	$form->get('type')->getData(),
172	1	$official ? null : $firstId,
173	1	$official ? null : $secondId
174	1	);
175
176	1	return $match;
177		}
178
179		/**
180		* Get the player list of a team
181		*
182		* @param FormInterface $team A MatchTeamType form
183		* @return array
184		*/
185	1	private function getPlayerList(FormInterface $team)
186		{
187	1	return array_map($this->getModelToID(), $team->get('participants')->getData());
188		}
189
190		/**
191		* Get a function which converts models to their IDs
192		*
193		* Useful to store the match players into the database
194		*/
195		private static function getModelToID()
196		{
197	1	return function ($model) {
198	1	return $model->getId();
199	1	};
200		}
201		}
202

allejo / bzion

Push — feature/player-list ( be1f72...9f06dd )

MatchFormCreator A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like