ProfileController::editAction() - Code Metrics - Inspection of "Add 'matchType' parameter for match reports" - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — fm-matches ( f867e2...7fc64f )

by Vladimir

created 2016-06-28 21:09 UTC

ProfileController::editAction() C

↳ Parent: ProfileController

Complexity

Conditions	8
Paths	9

Size

Total Lines	42
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	72

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	42
ccs	0
cts	0
cp	0
rs	5.3846
cc	8
eloc	23
nc	9
nop	3
crap	72

<?php

use BZIon\Form\Creator\ProfileFormCreator;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;

class ProfileController extends HTMLController
{
    public function setup()
    {
        $this->requireLogin();
    }

    /**
     * Edit a profile
     *
     * @param  Player  $me      The player's profile to edit
     * @param  Request $request
     * @param  bool $self    Whether a player is editing their own profile,
     *                          instead of an admin editing another player's
     *                          profile
     * @return array
     */
    public function editAction(Player $me, Request $request, $self = true)
    {
        $creator = new ProfileFormCreator($me);
        $creator->setEditingSelf($self);
        $form = $creator->create()->handleRequest($request);

        if ($form->isValid()) {
            if (!$self && $form->has('verify_email') && $form->get('verify_email')->isClicked()) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
                // An admin is editing a form and has chosen to verify a
                // player's e-mail address
                $me->setVerified(true);

                // Reset the form so that the "verify email" button gets hidden
                $form = $creator->create()->handleRequest($request);
            } else {
                $creator->update($form, $me);

                $email = $form->get('email')->getData();
                if ($email !== $me->getEmailAddress()) {
                    // User has changed their address, send a confirmation mail
                    $me->setEmailAddress($email);

                    if ($self) {
                        $this->sendConfirmationMessage($me);
                    } else {
                        // Admins can set users' e-mail addresses at will, without
                        // having to send them confirmation messages
                        $me->setVerified(true);
                    }
                }
            }

            $message = ($self) ? "Your profile has been updated." : $me->getUsername() . "'s profile has been updated.";
            $this->getFlashBag()->add("success", $message);
        }

        return $this->render('Profile/edit.html.twig', array(
            "editingSelf" => $self,
            "player"      => $me,
            "form"        => $form->createView()
        ));
    }

    /**
     * @todo Expire verification codes
     */
    public function confirmAction(Player $me, $token)
    {
        if (!$me->getEmailAddress()) {
            throw new ForbiddenException("You need to have an e-mail address to confirm!");
        }

        if ($me->isVerified()) {
            throw new ForbiddenException("You have already been verified");
        }

        if (!$me->isCorrectConfirmCode($token)) {
            throw new ForbiddenException("Invalid verification code");
        }

        $me->setVerified(true);

        $this->getFlashBag()->add('success', "Your e-mail address has been successfully verified");

        return new RedirectResponse($me->getUrl());
    }

    public function showAction(Player $me)
    {
        return new RedirectResponse($me->getUrl());
    }

    /**
     * Send a confirmation e-mail to a player
     * @param Player $player The receiving player
     */
    private function sendConfirmationMessage($player)
    {
        if ($player->getConfirmCode() === null) {
            // The player has no confirmation code, don't send them a message
            return;
        }

        $from = $this->container->getParameter('bzion.email.from');
        $title = $this->container->getParameter('bzion.site.name');

        if (!$from) {
            $this->getLogger()->addError('Unable to send verification e-mail message to player due to the "From:" address not being specified', array(
                'player' => array('id' => $player->getId(), 'username' => $player->getUsername())
            ));
            return;
        }

        $message = Swift_Message::newInstance()
            ->setSubject($title . ' Email Confirmation')
            ->setFrom(array($from => $title))
            ->setTo($player->getEmailAddress())
            ->setBody($this->render('Email/confirm.txt.twig',  array('player' => $player)))
            ->addPart($this->render('Email/confirm.html.twig', array('player' => $player)), 'text/html');

        $this->container->get('mailer')->send($message);

        $this->getFlashBag()->add('info',
            'Please check your inbox in order to confirm your email address.');
    }
}


1		<?php
2
3		use BZIon\Form\Creator\ProfileFormCreator;
4		use Symfony\Component\HttpFoundation\RedirectResponse;
5		use Symfony\Component\HttpFoundation\Request;
6
7		class ProfileController extends HTMLController
8		{
9	1	public function setup()
10		{
11	1	$this->requireLogin();
12		}
13
14		/**
15		* Edit a profile
16		*
17		* @param Player $me The player's profile to edit
18		* @param Request $request
19		* @param bool $self Whether a player is editing their own profile,
20		* instead of an admin editing another player's
21		* profile
22		* @return array
23		*/
24		public function editAction(Player $me, Request $request, $self = true)
25		{
26		$creator = new ProfileFormCreator($me);
27		$creator->setEditingSelf($self);
28		$form = $creator->create()->handleRequest($request);
29
30		if ($form->isValid()) {
31		if (!$self && $form->has('verify_email') && $form->get('verify_email')->isClicked()) {
		0 ignored issues – show Bug introduced 2015-12-02 06:58 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Form\FormInterface` as the method `isClicked()` does only exist in the following implementations of said interface: `Symfony\Component\Form\SubmitButton`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
32		// An admin is editing a form and has chosen to verify a
33		// player's e-mail address
34		$me->setVerified(true);
35
36		// Reset the form so that the "verify email" button gets hidden
37		$form = $creator->create()->handleRequest($request);
38		} else {
39		$creator->update($form, $me);
40
41		$email = $form->get('email')->getData();
42		if ($email !== $me->getEmailAddress()) {
43		// User has changed their address, send a confirmation mail
44		$me->setEmailAddress($email);
45
46		if ($self) {
47		$this->sendConfirmationMessage($me);
48		} else {
49		// Admins can set users' e-mail addresses at will, without
50		// having to send them confirmation messages
51		$me->setVerified(true);
52		}
53		}
54		}
55
56		$message = ($self) ? "Your profile has been updated." : $me->getUsername() . "'s profile has been updated.";
57		$this->getFlashBag()->add("success", $message);
58		}
59
60		return $this->render('Profile/edit.html.twig', array(
61		"editingSelf" => $self,
62		"player" => $me,
63		"form" => $form->createView()
64		));
65		}
66
67		/**
68		* @todo Expire verification codes
69		*/
70		public function confirmAction(Player $me, $token)
71		{
72		if (!$me->getEmailAddress()) {
73		throw new ForbiddenException("You need to have an e-mail address to confirm!");
74		}
75
76		if ($me->isVerified()) {
77		throw new ForbiddenException("You have already been verified");
78		}
79
80		if (!$me->isCorrectConfirmCode($token)) {
81		throw new ForbiddenException("Invalid verification code");
82		}
83
84		$me->setVerified(true);
85
86		$this->getFlashBag()->add('success', "Your e-mail address has been successfully verified");
87
88		return new RedirectResponse($me->getUrl());
89		}
90
91		public function showAction(Player $me)
92		{
93		return new RedirectResponse($me->getUrl());
94		}
95
96		/**
97		* Send a confirmation e-mail to a player
98		* @param Player $player The receiving player
99		*/
100		private function sendConfirmationMessage($player)
101		{
102		if ($player->getConfirmCode() === null) {
103		// The player has no confirmation code, don't send them a message
104		return;
105		}
106
107		$from = $this->container->getParameter('bzion.email.from');
108		$title = $this->container->getParameter('bzion.site.name');
109
110		if (!$from) {
111		$this->getLogger()->addError('Unable to send verification e-mail message to player due to the "From:" address not being specified', array(
112		'player' => array('id' => $player->getId(), 'username' => $player->getUsername())
113		));
114		return;
115		}
116
117		$message = Swift_Message::newInstance()
118		->setSubject($title . ' Email Confirmation')
119		->setFrom(array($from => $title))
120		->setTo($player->getEmailAddress())
121		->setBody($this->render('Email/confirm.txt.twig', array('player' => $player)))
122		->addPart($this->render('Email/confirm.html.twig', array('player' => $player)), 'text/html');
123
124		$this->container->get('mailer')->send($message);
125
126		$this->getFlashBag()->add('info',
127		'Please check your inbox in order to confirm your email address.');
128		}
129		}
130

allejo / bzion

Push — fm-matches ( f867e2...7fc64f )

ProfileController::editAction() C

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like