ApiResponseFactory::createNotFoundResponse() - Code Metrics - Inspection of "Ambassador form types became abstract" - VAPC/RockParade-API - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1b9891...006f9a )

by Petr

created 2016-09-18 16:52 UTC

ApiResponseFactory::createNotFoundResponse() A

↳ Parent: ApiResponseFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

namespace AppBundle\Response;

use AppBundle\Entity\Image;
use AppBundle\Entity\Infrasctucture\AbstractRepository;
use AppBundle\Entity\User;
use AppBundle\Enum\ApiOperation;
use AppBundle\Exception\UnsupportedTypeException;
use AppBundle\Form\AbstractFormType;
use AppBundle\Response\Infrastructure\AbstractApiResponse;
use AppBundle\Service\Entity\EntityService;
use Doctrine\ORM\EntityManager;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Intl\Exception\MethodNotImplementedException;
use Symfony\Component\Routing\Router;

/**
 * @author Vehsamrak
 */
class ApiResponseFactory
{

    /** @var string */
    private $filePath;

    /** @var EntityManager */
    private $entityManager;

    /** @var EntityService */
    private $entityService;

    /** @var Router */
    private $router;

    public function __construct(
        string $applicationRootPath,
        EntityManager $entityManager,
function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}
        EntityService $entityService,
        Router $router
    )
    {
        $this->filePath = realpath($applicationRootPath . '/../var/upload');
        $this->entityManager = $entityManager;
        $this->entityService = $entityService;
        $this->router = $router;
    }

    /**
     * Api response factory method
     */
    public function createResponse(
        ApiOperation $operation,
        FormInterface $form,
        User $creator,
        string $entityClass = null
    ): AbstractApiResponse
    {
        if (!$form->isValid()) {
            return new ApiValidationError($form);
        }

        if ($operation->getValue() === ApiOperation::CREATE) {
            return $this->processCreation($form, $creator, $entityClass);
        }
    }

    /**
     * @deprecated
     * @throws UnsupportedTypeException
     */
    public function createImageResponse($responseData): FileResponse
    {
        if ($responseData instanceof Image) {
            $imagesBasePath = $this->filePath . '/images/';
            $imagePath = $imagesBasePath . $responseData->getName();
            $response = new FileResponse($imagePath);
        } else {
            throw new UnsupportedTypeException();
        }

        return $response;
    }

    public function createNotFoundResponse(): ApiError
    {
        return new ApiError('Resource was not found.', Response::HTTP_NOT_FOUND);
    }

    private function processCreation(
        FormInterface $form,
        User $creator,
        string $entityClass = null
    ): AbstractApiResponse
    {
        /** @var AbstractFormType $formData */
        $formData = $form->getData();
        $entityClass = $entityClass ?: $formData->getEntityClassName();

        $entity = $this->entityService->createEntityByFormData($formData, $creator, $entityClass);
        $location = $this->createEntityHttpLocation($entity);

        return new CreatedApiResponse($location);
    }

    private function createEntityHttpLocation($entity): string
    {
        $entityShortName = (new \ReflectionClass($entity))->getShortName();
        $route = strtolower($entityShortName) . '_view';

        if (method_exists($entity, 'getId')) {
            $id = $entity->getId();
        } else {
            throw new MethodNotImplementedException('getId');
        }

        return $this->router->generate($route, ['id' => $id], Router::ABSOLUTE_URL);
    }
}


1		<?php
2
3		namespace AppBundle\Response;
4
5		use AppBundle\Entity\Image;
6		use AppBundle\Entity\Infrasctucture\AbstractRepository;
7		use AppBundle\Entity\User;
8		use AppBundle\Enum\ApiOperation;
9		use AppBundle\Exception\UnsupportedTypeException;
10		use AppBundle\Form\AbstractFormType;
11		use AppBundle\Response\Infrastructure\AbstractApiResponse;
12		use AppBundle\Service\Entity\EntityService;
13		use Doctrine\ORM\EntityManager;
14		use Symfony\Component\Form\FormInterface;
15		use Symfony\Component\HttpFoundation\Response;
16		use Symfony\Component\Intl\Exception\MethodNotImplementedException;
17		use Symfony\Component\Routing\Router;
18
19		/**
20		* @author Vehsamrak
21		*/
22		class ApiResponseFactory
23		{
24
25		/** @var string */
26		private $filePath;
27
28		/** @var EntityManager */
29		private $entityManager;
30
31		/** @var EntityService */
32		private $entityService;
33
34		/** @var Router */
35		private $router;
36
37	6	public function __construct(
38		string $applicationRootPath,
39		EntityManager $entityManager,
		0 ignored issues – show Bug introduced 2016-09-15 23:08 UTC by Report Bug Copy Issue Report You have injected the EntityManager via parameter `$entityManager`. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via `getManager()` each time you need it. The `EntityManager` might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following: function someFunction(ManagerRegistry $registry) { $em = $registry->getManager(); $em->getConnection()->beginTransaction(); try { // Do something. $em->getConnection()->commit(); } catch (\Exception $ex) { $em->getConnection()->rollback(); $em->close(); throw $ex; } } If that code throws an exception and the `EntityManager` is closed. Any other code which depends on the same instance of the `EntityManager` during this request will fail. On the other hand, if you instead inject the `ManagerRegistry`, the `getManager()` method guarantees that you will always get a usable manager instance. Loading history...
40		EntityService $entityService,
41		Router $router
42		)
43		{
44	6	$this->filePath = realpath($applicationRootPath . '/../var/upload');
45	6	$this->entityManager = $entityManager;
46	6	$this->entityService = $entityService;
47	6	$this->router = $router;
48	6	}
49
50		/**
51		* Api response factory method
52		*/
53	5	public function createResponse(
54		ApiOperation $operation,
55		FormInterface $form,
56		User $creator,
57		string $entityClass = null
58		): AbstractApiResponse
59		{
60	5	if (!$form->isValid()) {
61	3	return new ApiValidationError($form);
62		}
63
64	2	if ($operation->getValue() === ApiOperation::CREATE) {
65	2	return $this->processCreation($form, $creator, $entityClass);
66		}
67		}
68
69		/**
70		* @deprecated
71		* @throws UnsupportedTypeException
72		*/
73	1	public function createImageResponse($responseData): FileResponse
74		{
75	1	if ($responseData instanceof Image) {
76	1	$imagesBasePath = $this->filePath . '/images/';
77	1	$imagePath = $imagesBasePath . $responseData->getName();
78	1	$response = new FileResponse($imagePath);
79		} else {
80		throw new UnsupportedTypeException();
81		}
82
83	1	return $response;
84		}
85
86		public function createNotFoundResponse(): ApiError
87		{
88		return new ApiError('Resource was not found.', Response::HTTP_NOT_FOUND);
89		}
90
91	2	private function processCreation(
92		FormInterface $form,
93		User $creator,
94		string $entityClass = null
95		): AbstractApiResponse
96		{
97		/** @var AbstractFormType $formData */
98	2	$formData = $form->getData();
99	2	$entityClass = $entityClass ?: $formData->getEntityClassName();
100
101	2	$entity = $this->entityService->createEntityByFormData($formData, $creator, $entityClass);
102	2	$location = $this->createEntityHttpLocation($entity);
103
104	2	return new CreatedApiResponse($location);
105		}
106
107	2	private function createEntityHttpLocation($entity): string
108		{
109	2	$entityShortName = (new \ReflectionClass($entity))->getShortName();
110	2	$route = strtolower($entityShortName) . '_view';
111
112	2	if (method_exists($entity, 'getId')) {
113	2	$id = $entity->getId();
114		} else {
115		throw new MethodNotImplementedException('getId');
116		}
117
118	2	return $this->router->generate($route, ['id' => $id], Router::ABSOLUTE_URL);
119		}
120		}
121

VAPC / RockParade-API

Push — master ( 1b9891...006f9a )

ApiResponseFactory::createNotFoundResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like