Completed
Pull Request — dev (#24)
by
unknown
03:38
created

SurveyController::apiSurveyUpdateAction()   C

Complexity

Conditions 7
Paths 8

Size

Total Lines 31
Code Lines 23

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 31
rs 6.7272
c 0
b 0
f 0
cc 7
eloc 23
nc 8
nop 2
1
<?php
2
3
namespace AppBundle\Controller\Api;
4
5
use AppBundle\Entity\SurveyAnswer;
6
use AppBundle\Entity\Survey;
7
use AppBundle\Entity\SurveyQuestion;
8
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
9
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
10
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
11
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
12
use Symfony\Component\HttpFoundation\Request;
13
14
class SurveyController extends Controller
15
{
16
    /**
17
     * @Route("/surveys", name="api_surveys")
18
     * @Method("GET")
19
     */
20
    public function apiSurveysAction()
21
    {
22
        $user = $this->getUser();
23
        if (!$user) {
24
            return $this->json(['message' => 'User is not authorized'], 401);
25
        }
26
        $em = $this->getDoctrine()->getManager();
27
        $surveys = $em->getRepository(Survey::class)->findSurveyByUser($user);
28
        if (!$surveys) {
29
            return $this->json(['message' => 'No surveys'], 404);
30
        }
31
        $serializer = $this->get('serializer');
32
33
        $json = $serializer->normalize(
34
            $surveys,
35
            null,
36
            array('groups' => array('group1'))
37
        );
38
39
        return $this->json($json);
40
    }
41
42
    /**
43
     * @param Survey $survey
44
     * @Route("/survey/{id}", name="api_survey_byid")
45
     * @Method("GET")
46
     * @ParamConverter("survey", class="AppBundle:Survey")
47
     */
48
    public function apiSurveyAction(Survey $survey)
49
    {
50
        $user = $this->getUser();
51
        if (!$user) {
52
            return $this->json(['message' => 'User is not authorized'], 401);
53
        }
54
55
        if (!$survey) {
56
            return $this->json(['message' => 'No surveys'], 404);
57
        }
58
        $serializer = $this->get('serializer');
59
        if ($survey->getStatus() == 'submited') {
60
            $json = $serializer->normalize(
61
                $survey,
62
                null,
63
                array('groups' => array('group1', 'group2'))
64
            );
65
        }
66
        if ($survey->getStatus() == 'current') {
67
            $json = $serializer->normalize(
68
                $survey,
69
                null,
70
                array('groups' => array('group1', 'group3'))
71
            );
72
        }
73
74
        return $this->json($json);
0 ignored issues
show
Bug introduced by
The variable $json 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

  1. 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;
        }
    }
    
  2. 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;
    }
    
  3. 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...
75
    }
76
77
    /**
78
     * @param Request $request, Survey $survey
0 ignored issues
show
Documentation introduced by
There is no parameter named $request,. Did you maybe mean $request?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

Consider the following example. The parameter $ireland is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was changed, but the annotation was not.

Loading history...
79
     * @Route("/survey/update/{id}", name="api_survey_update")
80
     * @Method("POST")
81
     * @ParamConverter("survey", class="AppBundle:Survey")
82
     */
83
    public function apiSurveyUpdateAction(Request $request, Survey $survey)
84
    {
85
        $user = $this->getUser();
86
        if (!$user) {
87
            return $this->json(['message' => 'User is not authorized'], 401);
88
        }
89
        if (!$survey || $survey->getStatus() == 'submited') {
90
            return $this->json(['message' => 'No survey'], 404);
91
        }
92
        $questKey = array();
93
        foreach ($survey->getType()->getQuestions() as $question) {
94
            $questKey[] = $question->getId();
95
        }
96
        $data = json_decode($request->getContent(), true);
97
        $em = $this->getDoctrine()->getManager();
98
        foreach ($questKey as $key) {
99
            $answer = $data[$key];
100
            if ($answer == null) {
101
                return $this->json(['message' => 'Wrong question id'], 400);
102
            }
103
            $newAnswer = new SurveyAnswer();
104
            $newAnswer->setSurvey($survey);
105
            $newAnswer->setQuestion($em->getRepository(SurveyQuestion::class)->find($key));
0 ignored issues
show
Documentation introduced by
$em->getRepository(\AppB...ion::class)->find($key) is of type object|null, but the function expects a object<AppBundle\Entity\SurveyQuestion>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
106
            $newAnswer->setContent($answer);
107
            $em->persist($newAnswer);
108
        }
109
        $survey->setStatus('submited');
110
        $em->flush();
111
112
        return $this->json(['message' => 'Survey updated'], 200);
113
    }
114
}
115