UnicornApiController::__construct() - Code Metrics - Inspection of "generating form stuff" - delboy1978uk/bonemvc - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/middleware ( e85030...d864e0 )

by Derek Stephen

created 2019-08-03 23:49 UTC

UnicornApiController::__construct() A

↳ Parent: UnicornApiController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	4
Ratio	100 %

Importance

Changes

Metric	Value
dl	4
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

declare(strict_types=1);

namespace BoneMvc\Module\Unicorn\Controller;

use BoneMvc\Module\Unicorn\Collection\UnicornCollection;
use BoneMvc\Module\Unicorn\Form\UnicornForm;
use BoneMvc\Module\Unicorn\Service\UnicornService;
use League\Route\Http\Exception\NotFoundException;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Zend\Diactoros\Response\JsonResponse;

class UnicornApiController

{
    /** @param UnicornService $service */
    private $service;

    /**
     * @param UnicornService $service
     */
    public function __construct(UnicornService $service)
    {
        $this->service = $service;
    }

    /**
     * @param ServerRequestInterface $request
     * @param array $args
     * @return ResponseInterface
     * @throws NotFoundException
     * @throws \Doctrine\ORM\NonUniqueResultException
     */
    public function indexAction(ServerRequestInterface $request, array $args): ResponseInterface

    {
        $params = $request->getQueryParams();
        $limit = $params['limit'];
        $offset = $params['offset'];
        $db = $this->service->getRepository();
        $unicorns = new UnicornCollection($db->findBy([], null, $limit, $offset));
        $total = $db->getTotalUnicornCount();
        $count = count($unicorns);
        if ($count < 1) {
            throw new NotFoundException();
        }

        $payload['_embedded'] = $unicorns->toArray();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $payload['count'] = $count;
        $payload['total'] = $total;

        return new JsonResponse($payload);
    }

    /**
     * @param ServerRequestInterface $request
     * @param array $args
     * @return ResponseInterface
     * @throws \Doctrine\ORM\ORMException
     * @throws \Doctrine\ORM\OptimisticLockException
     */
    public function createAction(ServerRequestInterface $request, array $args): ResponseInterface

    {
        $post = json_decode($request->getBody()->getContents(), true) ?: $request->getParsedBody();
        $form = new UnicornForm('create');
        $form->populate($post);

        if ($form->isValid()) {
            $data = $form->getValues();
            $unicorn = $this->service->createFromArray($data);
            $this->service->saveUnicorn($unicorn);

            return new JsonResponse($unicorn->toArray());
        }

        return new JsonResponse([
            'error' => $form->getErrorMessages(),
        ]);
    }

    /**
     * @param ServerRequestInterface $request
     * @param array $args
     * @return ResponseInterface
     * @throws \Doctrine\ORM\EntityNotFoundException
     */
    public function viewAction(ServerRequestInterface $request, array $args): ResponseInterface

    {
        $unicorn = $this->service->getRepository()->find($args['id']);

        return new JsonResponse($unicorn->toArray());
    }

    /**
     * @param ServerRequestInterface $request
     * @param array $args
     * @return ResponseInterface
     * @throws \Doctrine\ORM\EntityNotFoundException
     * @throws \Doctrine\ORM\ORMException
     * @throws \Doctrine\ORM\OptimisticLockException
     */
    public function updateAction(ServerRequestInterface $request, array $args): ResponseInterface
    {
        $db = $this->service->getRepository();
        $unicorn = $db->find($args['id']);

        $post = json_decode($request->getBody()->getContents(), true) ?: $request->getParsedBody();
        $form = new UnicornForm('update');
        $form->populate($post);

        if ($form->isValid()) {
            $data = $form->getValues();
            $unicorn = $this->service->updateFromArray($unicorn, $data);
            $this->service->saveUnicorn($unicorn);

            return new JsonResponse($unicorn->toArray());
        }

        return new JsonResponse([
            'error' => $form->getErrorMessages(),
        ]);
    }

    /**
     * @param ServerRequestInterface $request
     * @param array $args
     * @return ResponseInterface
     * @throws \Doctrine\ORM\EntityNotFoundException
     * @throws \Doctrine\ORM\ORMException
     * @throws \Doctrine\ORM\OptimisticLockException
     */
    public function deleteAction(ServerRequestInterface $request, array $args): ResponseInterface

    {
        $db = $this->service->getRepository();
        $unicorn = $db->find($args['id']);
        $this->service->deleteUnicorn($unicorn);

        return new JsonResponse(['deleted' => true]);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace BoneMvc\Module\Unicorn\Controller;
6
7		use BoneMvc\Module\Unicorn\Collection\UnicornCollection;
8		use BoneMvc\Module\Unicorn\Form\UnicornForm;
9		use BoneMvc\Module\Unicorn\Service\UnicornService;
10		use League\Route\Http\Exception\NotFoundException;
11		use Psr\Http\Message\ResponseInterface;
12		use Psr\Http\Message\ServerRequestInterface;
13		use Zend\Diactoros\Response\JsonResponse;
14
15	View Code Duplication	class UnicornApiController
		0 ignored issues – show Duplication introduced 2019-08-03 23:55 UTC by Report Bug Copy Issue Report This class 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...
16		{
17		/** @param UnicornService $service */
18		private $service;
19
20		/**
21		* @param UnicornService $service
22		*/
23		public function __construct(UnicornService $service)
24		{
25		$this->service = $service;
26		}
27
28		/**
29		* @param ServerRequestInterface $request
30		* @param array $args
31		* @return ResponseInterface
32		* @throws NotFoundException
33		* @throws \Doctrine\ORM\NonUniqueResultException
34		*/
35		public function indexAction(ServerRequestInterface $request, array $args): ResponseInterface
		0 ignored issues – show Unused Code introduced 2019-08-03 23:55 UTC by Report Bug Copy Issue Report The parameter `$args` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
36		{
37		$params = $request->getQueryParams();
38		$limit = $params['limit'];
39		$offset = $params['offset'];
40		$db = $this->service->getRepository();
41		$unicorns = new UnicornCollection($db->findBy([], null, $limit, $offset));
42		$total = $db->getTotalUnicornCount();
43		$count = count($unicorns);
44		if ($count < 1) {
45		throw new NotFoundException();
46		}
47
48		$payload['_embedded'] = $unicorns->toArray();
		0 ignored issues – show Coding Style Comprehensibility introduced 2019-08-03 23:55 UTC by Report Bug Copy Issue Report `$payload` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$payload = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
49		$payload['count'] = $count;
50		$payload['total'] = $total;
51
52		return new JsonResponse($payload);
53		}
54
55		/**
56		* @param ServerRequestInterface $request
57		* @param array $args
58		* @return ResponseInterface
59		* @throws \Doctrine\ORM\ORMException
60		* @throws \Doctrine\ORM\OptimisticLockException
61		*/
62		public function createAction(ServerRequestInterface $request, array $args): ResponseInterface
		0 ignored issues – show Unused Code introduced 2019-08-03 23:55 UTC by Report Bug Copy Issue Report The parameter `$args` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
63		{
64		$post = json_decode($request->getBody()->getContents(), true) ?: $request->getParsedBody();
65		$form = new UnicornForm('create');
66		$form->populate($post);
67
68		if ($form->isValid()) {
69		$data = $form->getValues();
70		$unicorn = $this->service->createFromArray($data);
71		$this->service->saveUnicorn($unicorn);
72
73		return new JsonResponse($unicorn->toArray());
74		}
75
76		return new JsonResponse([
77		'error' => $form->getErrorMessages(),
78		]);
79		}
80
81		/**
82		* @param ServerRequestInterface $request
83		* @param array $args
84		* @return ResponseInterface
85		* @throws \Doctrine\ORM\EntityNotFoundException
86		*/
87		public function viewAction(ServerRequestInterface $request, array $args): ResponseInterface
		0 ignored issues – show Unused Code introduced 2019-08-03 23:55 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
88		{
89		$unicorn = $this->service->getRepository()->find($args['id']);
90
91		return new JsonResponse($unicorn->toArray());
92		}
93
94		/**
95		* @param ServerRequestInterface $request
96		* @param array $args
97		* @return ResponseInterface
98		* @throws \Doctrine\ORM\EntityNotFoundException
99		* @throws \Doctrine\ORM\ORMException
100		* @throws \Doctrine\ORM\OptimisticLockException
101		*/
102		public function updateAction(ServerRequestInterface $request, array $args): ResponseInterface
103		{
104		$db = $this->service->getRepository();
105		$unicorn = $db->find($args['id']);
106
107		$post = json_decode($request->getBody()->getContents(), true) ?: $request->getParsedBody();
108		$form = new UnicornForm('update');
109		$form->populate($post);
110
111		if ($form->isValid()) {
112		$data = $form->getValues();
113		$unicorn = $this->service->updateFromArray($unicorn, $data);
114		$this->service->saveUnicorn($unicorn);
115
116		return new JsonResponse($unicorn->toArray());
117		}
118
119		return new JsonResponse([
120		'error' => $form->getErrorMessages(),
121		]);
122		}
123
124		/**
125		* @param ServerRequestInterface $request
126		* @param array $args
127		* @return ResponseInterface
128		* @throws \Doctrine\ORM\EntityNotFoundException
129		* @throws \Doctrine\ORM\ORMException
130		* @throws \Doctrine\ORM\OptimisticLockException
131		*/
132		public function deleteAction(ServerRequestInterface $request, array $args): ResponseInterface
		0 ignored issues – show Unused Code introduced 2019-08-03 23:55 UTC by Report Bug Copy Issue Report The parameter `$request` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
133		{
134		$db = $this->service->getRepository();
135		$unicorn = $db->find($args['id']);
136		$this->service->deleteUnicorn($unicorn);
137
138		return new JsonResponse(['deleted' => true]);
139		}
140		}
141

delboy1978uk / bonemvc

Push — feature/middleware ( e85030...d864e0 )

UnicornApiController::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like