AbstractController::abstractShowAction() - Code Metrics - Inspection of "[Scrutinizer] Code Duplication" - Dev-Int/glsr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0c935c...e309b8 )

by Laurent

created 2016-05-28 14:28 UTC

AbstractController::abstractShowAction() A

↳ Parent: AbstractController

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	9
rs	9.6666
cc	1
eloc	5
nc	1
nop	2

<?php
/**
 * AbstractController controller des méthodes communes.
 *
 * PHP Version 5
 *
 * @author    Quétier Laurent <[email protected]>
 * @copyright 2014 Dev-Int GLSR
 * @license   http://opensource.org/licenses/gpl-license.php GNU Public License
 *
 * @version since 1.0.0
 *
 * @link      https://github.com/Dev-Int/glsr
 */
namespace AppBundle\Controller;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Doctrine\ORM\QueryBuilder;

/**
 * Abstract controller.
 *
 * @category Controller
 */
abstract class AbstractController extends Controller
{
    /**
     * Lists all items entity.
     *
     * @param string $entityName Name of Entity
     * @return array
     */
    public function abstractIndexAction($entityName)
    {
        $etm = $this->getDoctrine()->getManager();
        $entities = $etm->getRepository('AppBundle:'.$entityName)->findAll();

        return array(
            'entities'  => $entities,
            'ctEntity' => count($entities),
        );
    }

    /**
     * Finds and displays an item entity.
     *
     * @param Object $entity     Entity
     * @param string $entityName Name of Entity
     * @return array
     */
    public function abstractShowAction($entity, $entityName)
    {
        $deleteForm = $this->createDeleteForm($entity->getId(), $entityName.'_delete');

        return array(
            $entityName => $entity,
            'delete_form' => $deleteForm->createView(),
        );
    }

    /**
     * Displays a form to create a new item entity.
     *
     * @param string $entity     Entity
     * @param string $entityPath Path of Entity
     * @param string $typePath   Path of FormType
     * @return array
     */
    public function abstractNewAction($entity, $entityPath, $typePath)
    {
        $etm = $this->getDoctrine()->getManager();
        $ctEntity = count($etm->getRepository('AppBundle:'.$entity)->findAll());
        
        if ($entity === 'Company' || $entity === 'Settings' && $ctEntity >= 1) {
            $return = $this->redirectToRoute('_home');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
            $this->addFlash('danger', 'gestock.settings.'.strtolower($entity).'.add2');
        }

        $entityNew = $etm->getClassMetadata($entityPath)->newInstance();
        $form = $this->createForm(new $typePath(), $entityNew, array(
            'action' => $this->generateUrl(strtolower($entity).'_create'),
        ));

        $return = array(strtolower($entity) => $entityNew, 'form'   => $form->createView(),);

        return $return;
    }

    /**
     * Creates a new item entity.
     *
     * @param Request $request   Request in progress
     * @param string $entity     Entity <i>First letter Upper</i>
     * @param string $entityPath Path of Entity
     * @param string $typePath   Path of FormType
     * @return array
     */
    public function abstractCreateAction(Request $request, $entity, $entityPath, $typePath)
    {
        $param = array();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $etm = $this->getDoctrine()->getManager();
        $entityNew = $etm->getClassMetadata($entityPath)->newInstance();
        $form = $this->createForm(new $typePath(), $entityNew, array(
            'action' => $this->generateUrl(strtolower($entity).'_create'),
        ));

        if ($form->handleRequest($request)->isValid()) {
            $etm = $this->getDoctrine()->getManager();
            $etm->persist($entityNew);
            $etm->flush();
            $this->addFlash('info', 'gestock.create.ok');

            $param = $this->testReturnParam($entityNew, strtolower($entity));
            $return = $form->get('addmore')->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.
    }
}
                ? $entity.'_new'
                : $entity.'_show';

            return $this->redirectToRoute($return, $param);
        }

        return array($entity => $entityNew, 'form' => $form->createView(),);
    }

    /**
     * Displays a form to edit an existing item entity.
     *
     * @param Object $entity     Entity
     * @param string $entityName Name of Entity
     * @param string $typePath   Path of FormType
     * @return array
     */
    public function abstractEditAction($entity, $entityName, $typePath)
    {
        $param = $this->testReturnParam($entity, $entityName);
        $editForm = $this->createForm(new $typePath(), $entity, array(
            'action' => $this->generateUrl($entityName.'_update', $param),
            'method' => 'PUT',
        ));
        $deleteForm = $this->createDeleteForm($entity->getId(), $entityName.'_delete');

        return array(
            $entityName => $entity,
            'edit_form'   => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),
        );
    }

    /**
     * Edits an existing item entity.
     *
     * @param Object $entity     Entity
     * @param Request $request   Request in progress
     * @param string $entityName Name of Entity
     * @param string $typePath   Path of FormType
     * @return array
     */
    public function abstractUpdateAction($entity, Request $request, $entityName, $typePath)
    {
        $param = $this->testReturnParam($entity, $entityName);
        $editForm = $this->createForm(new $typePath(), $entity, array(
            'action' => $this->generateUrl($entityName.'_update', $param),
            'method' => 'PUT',
        ));
        if ($editForm->handleRequest($request)->isValid()) {
            $this->getDoctrine()->getManager()->flush();
            $this->addFlash('info', 'gestock.edit.ok');

            return $this->redirectToRoute($entityName.'_edit', $param);
        }
        $deleteForm = $this->createDeleteForm($entity->getId(), $entityName.'_delete');

        return array(
            $entityName => $entity,
            'edit_form'   => $editForm->createView(),
            'delete_form' => $deleteForm->createView(),
        );
    }

    /**
     * Deletes an item entity.
     *
     * @param Object $entity     Entity
     * @param Request $request   Request in progress
     * @param string $entityName Name of Entity
     * @return array
     */
    public function abstractDeleteAction($entity, Request $request, $entityName)
    {
        $form = $this->createDeleteForm($entity->getId(), $entityName.'_delete');
        if ($form->handleRequest($request)->isValid()) {
            $etm = $this->getDoctrine()->getManager();
            $etm->remove($entity);
            $etm->flush();
        }
    }

    private function testReturnParam($entity, $entityName) {
        if ($entityName === 'company' || $entityName === 'settings' || $entityName === 'tva') {
            $param = array('id' => $entity->getId());
        } else {
            $param = array('slug' => $entity->getSlug());
        }

        return $param;
    }
    /**
     * SetOrder for the SortAction in views.
     *
     * @param string $name  session name
     * @param string $field field name
     * @param string $type  sort type ("ASC"/"DESC")
     */
    protected function setOrder($name, $field, $type = 'ASC')
    {
        $this->getRequest()->getSession()->set('sort.'.$name, array('field' => $field, 'type' => $type));

    }

    /**
     * GetOrder for the SortAction in views.
     *
     * @param string $name
     *
     * @return array
     */
    protected function getOrder($name)
    {
        $session = $this->getRequest()->getSession();


        return $session->has('sort.' . $name) ? $session->get('sort.' . $name) : null;
    }

    /**
     * AddQueryBuilderSort for the SortAction in views.
     *
     * @param QueryBuilder $qbd
     * @param string       $name
     */
    protected function addQueryBuilderSort(QueryBuilder $qbd, $name)
    {
        $alias = current($qbd->getDQLPart('from'))->getAlias();
        if (is_array($order = $this->getOrder($name))) {
            $qbd->orderBy($alias . '.' . $order['field'], $order['type']);
        }
    }

    /**
     * Create Delete form.
     *
     * @param int    $id
     * @param string $route
     *
     * @return \Symfony\Component\Form\Form
     */
    protected function createDeleteForm($id, $route)
    {
        return $this->createFormBuilder(null, array('attr' => array('id' => 'delete')))
            ->setAction($this->generateUrl($route, array('id' => $id)))
            ->setMethod('DELETE')
            ->getForm()
        ;
    }

    /**
     * Test Inventory.
     *
     * @return string|null
     */
    protected function testInventory()
    {
        $url = null;
        $etm = $this->getDoctrine()->getManager();
        $inventories = $etm->getRepository('AppBundle:Inventory')->getInventory();

        if (empty($inventories)) {
            $url = 'gs_install_st7';
        } else {
            foreach ($inventories as $inventory) {
                if ($inventory->getstatus() === 1 || $inventory->getStatus() === 2) {
                    $message = $this->get('translator')
                        ->trans('yet', array(), 'gs_inventories');
                    $this->addFlash('danger', $message);
                    $url = 'inventory';
                    break;
                }
            }
        }

        return $url;
    }
}


1			<?php
2			/**
3			* AbstractController controller des méthodes communes.
4			*
5			* PHP Version 5
6			*
7			* @author Quétier Laurent <[email protected]>
8			* @copyright 2014 Dev-Int GLSR
9			* @license http://opensource.org/licenses/gpl-license.php GNU Public License
10			*
11			* @version since 1.0.0
12			*
13			* @link https://github.com/Dev-Int/glsr
14			*/
15			namespace AppBundle\Controller;
16
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Bundle\FrameworkBundle\Controller\Controller;
19			use Doctrine\ORM\QueryBuilder;
20
21			/**
22			* Abstract controller.
23			*
24			* @category Controller
25			*/
26			abstract class AbstractController extends Controller
27			{
28			/**
29			* Lists all items entity.
30			*
31			* @param string $entityName Name of Entity
32			* @return array
33			*/
34			public function abstractIndexAction($entityName)
35			{
36			$etm = $this->getDoctrine()->getManager();
37			$entities = $etm->getRepository('AppBundle:'.$entityName)->findAll();
38
39			return array(
40			'entities' => $entities,
41			'ctEntity' => count($entities),
42			);
43			}
44
45			/**
46			* Finds and displays an item entity.
47			*
48			* @param Object $entity Entity
49			* @param string $entityName Name of Entity
50			* @return array
51			*/
52			public function abstractShowAction($entity, $entityName)
53			{
54			$deleteForm = $this->createDeleteForm($entity->getId(), $entityName.'_delete');
55
56			return array(
57			$entityName => $entity,
58			'delete_form' => $deleteForm->createView(),
59			);
60			}
61
62			/**
63			* Displays a form to create a new item entity.
64			*
65			* @param string $entity Entity
66			* @param string $entityPath Path of Entity
67			* @param string $typePath Path of FormType
68			* @return array
69			*/
70			public function abstractNewAction($entity, $entityPath, $typePath)
71			{
72			$etm = $this->getDoctrine()->getManager();
73			$ctEntity = count($etm->getRepository('AppBundle:'.$entity)->findAll());
74
75			if ($entity === 'Company' \|\| $entity === 'Settings' && $ctEntity >= 1) {
76			$return = $this->redirectToRoute('_home');
			1 ignored issue – show Unused Code introduced 2016-05-28 10:52 UTC by Report Bug Copy Issue Report `$return` 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...
77			$this->addFlash('danger', 'gestock.settings.'.strtolower($entity).'.add2');
78			}
79
80			$entityNew = $etm->getClassMetadata($entityPath)->newInstance();
81			$form = $this->createForm(new $typePath(), $entityNew, array(
82			'action' => $this->generateUrl(strtolower($entity).'_create'),
83			));
84
85			$return = array(strtolower($entity) => $entityNew, 'form' => $form->createView(),);
86
87			return $return;
88			}
89
90			/**
91			* Creates a new item entity.
92			*
93			* @param Request $request Request in progress
94			* @param string $entity Entity <i>First letter Upper</i>
95			* @param string $entityPath Path of Entity
96			* @param string $typePath Path of FormType
97			* @return array
98			*/
99			public function abstractCreateAction(Request $request, $entity, $entityPath, $typePath)
100			{
101			$param = array();
			1 ignored issue – show Unused Code introduced 2016-05-28 10:52 UTC by Report Bug Copy Issue Report `$param` 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...
102			$etm = $this->getDoctrine()->getManager();
103			$entityNew = $etm->getClassMetadata($entityPath)->newInstance();
104			$form = $this->createForm(new $typePath(), $entityNew, array(
105			'action' => $this->generateUrl(strtolower($entity).'_create'),
106			));
107
108			if ($form->handleRequest($request)->isValid()) {
109			$etm = $this->getDoctrine()->getManager();
110			$etm->persist($entityNew);
111			$etm->flush();
112			$this->addFlash('info', 'gestock.create.ok');
113
114			$param = $this->testReturnParam($entityNew, strtolower($entity));
115			$return = $form->get('addmore')->isClicked()
			0 ignored issues – show Bug introduced 2016-05-28 10:52 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...
116			? $entity.'_new'
117			: $entity.'_show';
118
119			return $this->redirectToRoute($return, $param);
120			}
121
122			return array($entity => $entityNew, 'form' => $form->createView(),);
123			}
124
125			/**
126			* Displays a form to edit an existing item entity.
127			*
128			* @param Object $entity Entity
129			* @param string $entityName Name of Entity
130			* @param string $typePath Path of FormType
131			* @return array
132			*/
133			public function abstractEditAction($entity, $entityName, $typePath)
134			{
135			$param = $this->testReturnParam($entity, $entityName);
136			$editForm = $this->createForm(new $typePath(), $entity, array(
137			'action' => $this->generateUrl($entityName.'_update', $param),
138			'method' => 'PUT',
139			));
140			$deleteForm = $this->createDeleteForm($entity->getId(), $entityName.'_delete');
141
142			return array(
143			$entityName => $entity,
144			'edit_form' => $editForm->createView(),
145			'delete_form' => $deleteForm->createView(),
146			);
147			}
148
149			/**
150			* Edits an existing item entity.
151			*
152			* @param Object $entity Entity
153			* @param Request $request Request in progress
154			* @param string $entityName Name of Entity
155			* @param string $typePath Path of FormType
156			* @return array
157			*/
158			public function abstractUpdateAction($entity, Request $request, $entityName, $typePath)
159			{
160			$param = $this->testReturnParam($entity, $entityName);
161			$editForm = $this->createForm(new $typePath(), $entity, array(
162			'action' => $this->generateUrl($entityName.'_update', $param),
163			'method' => 'PUT',
164			));
165			if ($editForm->handleRequest($request)->isValid()) {
166			$this->getDoctrine()->getManager()->flush();
167			$this->addFlash('info', 'gestock.edit.ok');
168
169			return $this->redirectToRoute($entityName.'_edit', $param);
170			}
171			$deleteForm = $this->createDeleteForm($entity->getId(), $entityName.'_delete');
172
173			return array(
174			$entityName => $entity,
175			'edit_form' => $editForm->createView(),
176			'delete_form' => $deleteForm->createView(),
177			);
178			}
179
180			/**
181			* Deletes an item entity.
182			*
183			* @param Object $entity Entity
184			* @param Request $request Request in progress
185			* @param string $entityName Name of Entity
186			* @return array
187			*/
188			public function abstractDeleteAction($entity, Request $request, $entityName)
189			{
190			$form = $this->createDeleteForm($entity->getId(), $entityName.'_delete');
191			if ($form->handleRequest($request)->isValid()) {
192			$etm = $this->getDoctrine()->getManager();
193			$etm->remove($entity);
194			$etm->flush();
195			}
196			}
197
198			private function testReturnParam($entity, $entityName) {
199			if ($entityName === 'company' \|\| $entityName === 'settings' \|\| $entityName === 'tva') {
200			$param = array('id' => $entity->getId());
201			} else {
202			$param = array('slug' => $entity->getSlug());
203			}
204
205			return $param;
206			}
207			/**
208			* SetOrder for the SortAction in views.
209			*
210			* @param string $name session name
211			* @param string $field field name
212			* @param string $type sort type ("ASC"/"DESC")
213			*/
214			protected function setOrder($name, $field, $type = 'ASC')
215			{
216			$this->getRequest()->getSession()->set('sort.'.$name, array('field' => $field, 'type' => $type));
			0 ignored issues – show Deprecated Code introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report The method `Symfony\Bundle\Framework...ontroller::getRequest()` has been deprecated with message: since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
217			}
218
219			/**
220			* GetOrder for the SortAction in views.
221			*
222			* @param string $name
223			*
224			* @return array
225			*/
226			protected function getOrder($name)
227			{
228			$session = $this->getRequest()->getSession();
			0 ignored issues – show Deprecated Code introduced 2016-03-27 22:01 UTC by Report Bug Copy Issue Report The method `Symfony\Bundle\Framework...ontroller::getRequest()` has been deprecated with message: since version 2.4, to be removed in 3.0. Ask Symfony to inject the Request object into your controller method instead by type hinting it in the method's signature. This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
229
230			return $session->has('sort.' . $name) ? $session->get('sort.' . $name) : null;
231			}
232
233			/**
234			* AddQueryBuilderSort for the SortAction in views.
235			*
236			* @param QueryBuilder $qbd
237			* @param string $name
238			*/
239			protected function addQueryBuilderSort(QueryBuilder $qbd, $name)
240			{
241			$alias = current($qbd->getDQLPart('from'))->getAlias();
242			if (is_array($order = $this->getOrder($name))) {
243			$qbd->orderBy($alias . '.' . $order['field'], $order['type']);
244			}
245			}
246
247			/**
248			* Create Delete form.
249			*
250			* @param int $id
251			* @param string $route
252			*
253			* @return \Symfony\Component\Form\Form
254			*/
255			protected function createDeleteForm($id, $route)
256			{
257			return $this->createFormBuilder(null, array('attr' => array('id' => 'delete')))
258			->setAction($this->generateUrl($route, array('id' => $id)))
259			->setMethod('DELETE')
260			->getForm()
261			;
262			}
263
264			/**
265			* Test Inventory.
266			*
267			* @return string\|null
268			*/
269			protected function testInventory()
270			{
271			$url = null;
272			$etm = $this->getDoctrine()->getManager();
273			$inventories = $etm->getRepository('AppBundle:Inventory')->getInventory();
274
275			if (empty($inventories)) {
276			$url = 'gs_install_st7';
277			} else {
278			foreach ($inventories as $inventory) {
279			if ($inventory->getstatus() === 1 \|\| $inventory->getStatus() === 2) {
280			$message = $this->get('translator')
281			->trans('yet', array(), 'gs_inventories');
282			$this->addFlash('danger', $message);
283			$url = 'inventory';
284			break;
285			}
286			}
287			}
288
289			return $url;
290			}
291			}
292

Dev-Int / glsr

Push — master ( 0c935c...e309b8 )

AbstractController::abstractShowAction() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like