Completed
Push — sf2.7 ( 6f1cdc...5a2174 )
by Laurent
18:27
created

FamilyLogController   A

Complexity

Total Complexity 13

Size/Duplication

Total Lines 177
Duplicated Lines 20.34 %

Coupling/Cohesion

Components 1
Dependencies 6

Importance

Changes 3
Bugs 1 Features 1
Metric Value
wmc 13
c 3
b 1
f 1
lcom 1
cbo 6
dl 36
loc 177
rs 10

8 Methods

Rating   Name   Duplication   Size   Complexity  
A indexAction() 0 9 1
A showAction() 0 9 1
A newAction() 0 10 1
A editAction() 14 17 1
B createAction() 0 26 4
A updateAction() 22 22 2
A deleteAction() 0 11 2
A createDeleteForm() 0 8 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
3
namespace AppBundle\Controller\Settings\Divers;
4
5
use Symfony\Component\HttpFoundation\Request;
6
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
7
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
8
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
9
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Template;
10
use AppBundle\Entity\FamilyLog;
11
use AppBundle\Form\Type\FamilyLogType;
12
13
/**
14
 * FamilyLog controller.
15
 *
16
 * @Route("/admin/settings/divers/familylog")
17
 */
18
class FamilyLogController extends Controller
19
{
20
    /**
21
     * Lists all FamilyLog entities.
22
     *
23
     * @Route("/", name="admin_familylog")
24
     * @Method("GET")
25
     * @Template()
26
     */
27
    public function indexAction()
28
    {
29
        $em = $this->getDoctrine()->getManager();
30
        $entities = $em->getRepository('AppBundle:FamilyLog')->findAll();
31
        
32
        return array(
33
            'entities'  => $entities,
34
        );
35
    }
36
37
    /**
38
     * Finds and displays a FamilyLog entity.
39
     *
40
     * @Route("/{slug}/show", name="admin_familylog_show")
41
     * @Method("GET")
42
     * @Template()
43
     */
44
    public function showAction(FamilyLog $familylog)
45
    {
46
        $deleteForm = $this->createDeleteForm($familylog->getId(), 'admin_familylog_delete');
47
48
        return array(
49
            'familylog' => $familylog,
50
            'delete_form' => $deleteForm->createView(),
51
        );
52
    }
53
54
    /**
55
     * Displays a form to create a new FamilyLog entity.
56
     *
57
     * @Route("/new", name="admin_familylog_new")
58
     * @Method("GET")
59
     * @Template()
60
     */
61
    public function newAction()
62
    {
63
        $familylog = new FamilyLog();
64
        $form = $this->createForm(new FamilyLogType(), $familylog);
65
66
        return array(
67
            'familylog' => $familylog,
68
            'form'   => $form->createView(),
69
        );
70
    }
71
72
    /**
73
     * Creates a new FamilyLog entity.
74
     *
75
     * @Route("/create", name="admin_familylog_create")
76
     * @Method("POST")
77
     * @Template("AppBundle:FamilyLog:new.html.twig")
78
     */
79
    public function createAction(Request $request)
80
    {
81
        $familylog = new FamilyLog();
82
        $form = $this->createForm(new FamilyLogType(), $familylog);
83
        if ($form->handleRequest($request)->isValid()) {
84
            $em = $this->getDoctrine()->getManager();
85
            $em->persist($familylog);
86
            $em->flush();
87
88
            if ($form->get('save')->isClicked()) {
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
89
                $url = $this->redirect($this->generateUrl(
90
                    'admin_familylog_show',
91
                    array('slug' => $familylog->getSlug())
92
                ));
93
            } elseif ($form->get('addmore')->isClicked()) {
0 ignored issues
show
Bug introduced by
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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
94
                $this->addFlash('info', 'gestock.settings.add_ok');
95
                $url = $this->redirectToRoute('admin_familylog_new');
96
            }
97
            return $url;
0 ignored issues
show
Bug introduced by
The variable $url 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...
98
        }
99
100
        return array(
101
            'familylog' => $familylog,
102
            'form'   => $form->createView(),
103
        );
104
    }
105
106
    /**
107
     * Displays a form to edit an existing FamilyLog entity.
108
     *
109
     * @Route("/{slug}/edit", name="admin_familylog_edit")
110
     * @Method("GET")
111
     * @Template()
112
     */
113 View Code Duplication
    public function editAction(FamilyLog $familylog)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
114
    {
115
        $editForm = $this->createForm(new FamilyLogType(), $familylog, array(
116
            'action' => $this->generateUrl(
117
                'admin_familylog_update',
118
                array('slug' => $familylog->getSlug())
119
            ),
120
            'method' => 'PUT',
121
        ));
122
        $deleteForm = $this->createDeleteForm($familylog->getId(), 'admin_familylog_delete');
123
124
        return array(
125
            'familylog' => $familylog,
126
            'edit_form'   => $editForm->createView(),
127
            'delete_form' => $deleteForm->createView(),
128
        );
129
    }
130
131
    /**
132
     * Edits an existing FamilyLog entity.
133
     *
134
     * @Route("/{slug}/update", name="admin_familylog_update")
135
     * @Method("PUT")
136
     * @Template("AppBundle:FamilyLog:edit.html.twig")
137
     */
138 View Code Duplication
    public function updateAction(FamilyLog $famlog, Request $request)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in 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...
139
    {
140
        $editForm = $this->createForm(new FamilyLogType(), $famlog, array(
141
            'action' => $this->generateUrl(
142
                'admin_familylog_update',
143
                array('slug' => $famlog->getSlug())
144
            ),
145
            'method' => 'PUT',
146
        ));
147
        if ($editForm->handleRequest($request)->isValid()) {
148
            $this->getDoctrine()->getManager()->flush();
149
150
            return $this->redirectToRoute('admin_familylog_edit', array('slug' => $famlog->getSlug()));
151
        }
152
        $deleteForm = $this->createDeleteForm($famlog->getId(), 'admin_familylog_delete');
153
154
        return array(
155
            'familylog' => $famlog,
156
            'edit_form'   => $editForm->createView(),
157
            'delete_form' => $deleteForm->createView(),
158
        );
159
    }
160
161
    /**
162
     * Deletes a FamilyLog entity.
163
     *
164
     * @Route("/{id}/delete", name="admin_familylog_delete", requirements={"id"="\d+"})
165
     * @Method("DELETE")
166
     */
167
    public function deleteAction(FamilyLog $familylog, Request $request)
168
    {
169
        $form = $this->createDeleteForm($familylog->getId(), 'admin_familylog_delete');
170
        if ($form->handleRequest($request)->isValid()) {
171
            $em = $this->getDoctrine()->getManager();
172
            $em->remove($familylog);
173
            $em->flush();
174
        }
175
176
        return $this->redirectToRoute('admin_familylog');
177
    }
178
179
    /**
180
     * Create Delete form
181
     *
182
     * @param integer                       $id
183
     * @param string                        $route
184
     * @return \Symfony\Component\Form\Form
185
     */
186
    protected function createDeleteForm($id, $route)
187
    {
188
        return $this->createFormBuilder(null, array('attr' => array('id' => 'delete')))
0 ignored issues
show
Bug introduced by
The method getForm() does not exist on Symfony\Component\Form\FormConfigBuilder. Did you maybe mean getFormConfig()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
189
            ->setAction($this->generateUrl($route, array('id' => $id)))
190
            ->setMethod('DELETE')
191
            ->getForm()
192
        ;
193
    }
194
}
195