FormTrait - Code Metrics - Inspection of "Refactoring" - PastisD/xdaysaysay - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 45292f...31ad2c )

by PastisD

created 2016-04-09 10:26 UTC

FormTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	237
Duplicated Lines	6.75 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	14
c	1
b	0
f	0
lcom	1
cbo	1
dl	16
loc	237
rs	10

7 Methods

Rating	Name	Duplication	Size	Complexity
A	indexAction()	0	12	1
B	editAction()	8	30	3
B	newAction()	8	26	2
B	createNewEditForm()	0	28	2
A	deleteConfirmAction()	0	17	2
B	deleteAction()	0	24	3
A	createDeleteForm()	0	15	1

How to fix Duplicated Code

<?php

namespace Xdaysaysay\AdminBundle\FormTrait;

use Symfony\Component\Form\Extension\Core\Type\SubmitType;
use Symfony\Component\HttpFoundation\Request;

trait FormTrait
{
    /**
     * Displays list of existing entities.
     *
     * @return \Symfony\Component\HttpFoundation\Response
     *
     * @throws \LogicException
     * @throws \UnexpectedValueException
     */
    public function indexAction()
    {
        $this->get('avanzu_admin_theme.theme_manager')->registerScript('datatble', 'bundles/xdaysaysayadmin/js/datatable.js');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $entities = $this->getDoctrine()->getRepository($this->entityClassName)->findBy([], ['id' => 'DESC']);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        return $this->render(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->twigFormDirectory . ':index.html.twig', [
class MyClass { }

$x = new MyClass();
$x->foo = true;
                'entities' => $entities,
            ]
        );
    }


    /**
     * Displays a form to edit an existing entity.
     *
     * @param Request $request
     * @param int $id
     *
     * @return \Symfony\Component\HttpFoundation\Response
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     * @throws \LogicException
     * @throws \InvalidArgumentException
     * @throws \Symfony\Component\Form\Exception\AlreadySubmittedException
     * @throws \Symfony\Component\Form\Exception\LogicException
     * @throws \Symfony\Component\Form\Exception\UnexpectedTypeException
     */
    public function editAction(Request $request, $id)
    {
        $em = $this->getDoctrine()->getManager();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $entity = $em->getRepository($this->entityClassName)->find($id);

        if (!$entity) {
            throw $this->createNotFoundException('Unable to find entity.');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        $form = $this->createNewEditForm($entity);

        $form->handleRequest($request);

        if ($form->isValid()) {

            $em->persist($entity);
            $em->flush();

            $this->addFlash('success', $this->get('translator')->trans('admin.' . $this->translation . '.flash.edit', [], 'admin'));
class MyClass { }

$x = new MyClass();
$x->foo = true;

            return $this->redirect($this->generateUrl('xdaysaysay_admin_' . $this->formRoute . '_edit', ['id' => $entity->getId()]));
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }

        return $this->render(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->twigFormDirectory . ':edit.html.twig', [
                'entity' => $entity,
                'form'   => $form->createView(),
            ]
        );
    }


    /**
     * Displays a form to edit an existing entity.
     *
     * @param Request $request
     *
     * @return \Symfony\Component\HttpFoundation\Response
     *
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     * @throws \LogicException
     * @throws \InvalidArgumentException
     * @throws \Symfony\Component\Form\Exception\AlreadySubmittedException
     * @throws \Symfony\Component\Form\Exception\LogicException
     * @throws \Symfony\Component\Form\Exception\UnexpectedTypeException
     */
    public function newAction(Request $request)
    {
        $em = $this->getDoctrine()->getManager();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $entity = new $this->entityClassName;

        $form = $this->createNewEditForm($entity);

        $form->handleRequest($request);

        if ($form->isValid()) {

            $em->persist($entity);
            $em->flush();

            $this->addFlash('success', $this->get('translator')->trans('admin.' . $this->translation . '.flash.create', [], 'admin'));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            return $this->redirect($this->generateUrl('xdaysaysay_admin_' . $this->formRoute . '_edit', ['id' => $entity->getId()]));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this->render(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->twigFormDirectory . ':new.html.twig', [
                'entity' => $entity,
                'form'   => $form->createView(),
            ]
        );
    }


    /**
     * Creates a form to create a entity.
     *
     * @param $entity
     *
     * @return \Symfony\Component\Form\Form The form
     *
     * @throws \InvalidArgumentException
     * @throws \Symfony\Component\Form\Exception\AlreadySubmittedException
     * @throws \Symfony\Component\Form\Exception\LogicException
     * @throws \Symfony\Component\Form\Exception\UnexpectedTypeException
     */
    private function createNewEditForm($entity)
    {
        if ($entity->getId() !== null) {
            $action = $this->generateUrl('xdaysaysay_admin_' . $this->formRoute . '_edit', ['id' => $entity->getId()]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $submitText = $this->get('translator')->trans('admin.common.form.update', [], 'admin');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } else {
            $action = $this->generateUrl('xdaysaysay_admin_' . $this->formRoute . '_new');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $submitText = $this->get('translator')->trans('admin.common.form.create', [], 'admin');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        $form = $this->createForm(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->formType, $entity, [
class MyClass { }

$x = new MyClass();
$x->foo = true;
                'action' => $action,
                'method' => 'PUT',
            ]
        );

        $form->add(
            'submit', SubmitType::class, [
                'label' => $submitText,
                'attr'  => [
                    'class' => 'btn btn-primary',
                ],
            ]
        );

        return $form;
    }


    /**
     * @param $id
     *
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function deleteConfirmAction($id)
    {
        $em = $this->getDoctrine()->getManager();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $entity = $em->getRepository($this->entityClassName)->find($id);

        if (!$entity) {
            throw $this->createNotFoundException('Unable to find entity.');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        return $this->render(
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->twigFormDirectory . ':confirm_delete.html.twig', [
                'entity' => $entity,
                'form'   => $this->createDeleteForm($entity)->createView(),
            ]
        );
    }


    /**
     * @param Request $request
     * @param $id
     *
     * @return \Symfony\Component\HttpFoundation\RedirectResponse
     *
     * @throws \LogicException
     * @throws \InvalidArgumentException
     * @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException
     */
    public function deleteAction(Request $request, $id)
    {
        $em = $this->getDoctrine()->getManager();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        $entity = $em->getRepository($this->entityClassName)->find($id);

        if (!$entity) {
            throw $this->createNotFoundException('Unable to find entity.');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        $form = $this->createDeleteForm($entity);

        $form->handleRequest($request);
        if ($form->isValid()) {
            $em->remove($entity);
            $em->flush();

            $this->addFlash('success', $this->get('translator')->trans('admin.' . $this->translation . '.flash.delete', [], 'admin'));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

            return $this->redirectToRoute('xdaysaysay_admin_' . $this->formRoute . '_index');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } else {
            return $this->redirectToRoute('xdaysaysay_admin_' . $this->formRoute . '_delete_confirm', ['id' => $id]);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * @param $entity
     *
     * @return \Symfony\Component\Form\Form
     *
     * @throws \InvalidArgumentException
     */
    private function createDeleteForm($entity)
    {
        $form = $this->createFormBuilder()
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->setAction($this->generateUrl('xdaysaysay_admin_' . $this->formRoute . '_delete', ['id' => $entity->getId()]))
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            ->setMethod('DELETE')
            ->add('submit', SubmitType::class, [
                'label' => $this->get('translator')->trans('admin.common.action.delete', [], 'admin'),
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                'attr'  => [
                    'class' => 'btn btn-danger',
                ],
            ])
            ->getForm();

        return $form;
    }
}

1			<?php
2
3			namespace Xdaysaysay\AdminBundle\FormTrait;
4
5			use Symfony\Component\Form\Extension\Core\Type\SubmitType;
6			use Symfony\Component\HttpFoundation\Request;
7
8			trait FormTrait
9			{
10			/**
11			* Displays list of existing entities.
12			*
13			* @return \Symfony\Component\HttpFoundation\Response
14			*
15			* @throws \LogicException
16			* @throws \UnexpectedValueException
17			*/
18			public function indexAction()
19			{
20			$this->get('avanzu_admin_theme.theme_manager')->registerScript('datatble', 'bundles/xdaysaysayadmin/js/datatable.js');
			0 ignored issues – show Bug introduced 2016-04-09 10:28 UTC by Report Bug Copy Issue Report It seems like `get()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
21
22			$entities = $this->getDoctrine()->getRepository($this->entityClassName)->findBy([], ['id' => 'DESC']);
			1 ignored issue – show Bug introduced 2016-04-09 10:28 UTC by Report Bug Copy Issue Report The property `entityClassName` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2016-04-09 10:28 UTC by Report Bug Copy Issue Report It seems like `getDoctrine()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
23
24			return $this->render(
			1 ignored issue – show Bug introduced 2016-04-09 10:28 UTC by Report Bug Copy Issue Report It seems like `render()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
25			$this->twigFormDirectory . ':index.html.twig', [
			0 ignored issues – show Bug introduced 2016-04-09 10:28 UTC by Report Bug Copy Issue Report The property `twigFormDirectory` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
26			'entities' => $entities,
27			]
28			);
29			}
30
31
32			/**
33			* Displays a form to edit an existing entity.
34			*
35			* @param Request $request
36			* @param int $id

PastisD / xdaysaysay

Push — master ( 45292f...31ad2c )

FormTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

7 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like