CourseUpdateController::__invoke() - Code Metrics - chubbyphp/chubbyphp-api-slim-skeleton - Measure and Improve Code Quality continuously with Scrutinizer

CourseUpdateController::__invoke() B
last analyzed 2018-10-10 17:13 UTC

↳ Parent: CourseUpdateController

Complexity

Conditions	6
Paths	6

Size

Total Lines

Duplication

Lines	16
Ratio	40 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
cc	6
nc	6
nop	1
dl	16
loc	40
rs	8.6577
c	0
b	0
f	0
ccs	0
cts	30
cp	0
crap	42

<?php

declare(strict_types=1);

namespace Chubbyphp\ApiSkeleton\Controller\Course;

use Chubbyphp\ApiHttp\Error\Error;
use Chubbyphp\ApiHttp\Manager\RequestManagerInterface;
use Chubbyphp\ApiHttp\Manager\ResponseManagerInterface;
use Chubbyphp\Model\RepositoryInterface;
use Chubbyphp\Translation\TranslatorInterface;
use Chubbyphp\Validation\Error\NestedErrorMessages;
use Chubbyphp\Validation\ValidatorInterface;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use Chubbyphp\ApiSkeleton\Model\Course;

final class CourseUpdateController
{
    /**
     * @var string
     */
    private $defaultLanguage;

    /**
     * @var RepositoryInterface
     */
    private $repository;

    /**
     * @var RequestManagerInterface
     */
    private $requestManager;

    /**
     * @var ResponseManagerInterface
     */
    private $responseManager;

    /**
     * @var TranslatorInterface
     */
    private $translator;

    /**
     * @var ValidatorInterface
     */
    private $validator;

    /**
     * @param string                   $defaultLanguage
     * @param RepositoryInterface      $repository
     * @param RequestManagerInterface  $requestManager
     * @param ResponseManagerInterface $responseManager
     * @param TranslatorInterface      $translator
     * @param ValidatorInterface       $validator
     */
    public function __construct(

        string $defaultLanguage,
        RepositoryInterface $repository,
        RequestManagerInterface $requestManager,
        ResponseManagerInterface $responseManager,
        TranslatorInterface $translator,
        ValidatorInterface $validator
    ) {
        $this->defaultLanguage = $defaultLanguage;
        $this->repository = $repository;
        $this->requestManager = $requestManager;
        $this->responseManager = $responseManager;
        $this->translator = $translator;
        $this->validator = $validator;
    }

    /**
     * @param Request $request
     *
     * @return Response
     */
    public function __invoke(Request $request): Response
    {
        if (null === $accept = $this->requestManager->getAccept($request)) {
            return $this->responseManager->createAcceptNotSupportedResponse($request);
        }

        if (null === $contentType = $this->requestManager->getContentType($request)) {

            return $this->responseManager->createContentTypeNotSupportedResponse($request, $accept);
        }

        $id = $request->getAttribute('id');

        /** @var Course $course */
        if (null === $course = $this->repository->find($id)) {
            return $this->responseManager->createResourceNotFoundResponse($request, $accept, 'course', ['id' => $id]);
        }

        /** @var Course $course */
        if (null === $course = $this->requestManager->getDataFromRequestBody($request, $course, $contentType)) {
            return $this->responseManager->createBodyNotDeserializableResponse($request, $accept, $contentType);
        }

        if ([] !== $errors = $this->validator->validateObject($course)) {
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.
    }
}
            $locale = $this->requestManager->getAcceptLanguage($request, $this->defaultLanguage);

            return $this->responseManager->createValidationErrorResponse(
                $request,
                $accept,
                Error::SCOPE_BODY,
                'course',
                (new NestedErrorMessages($errors, function (string $key, array $arguments) use ($locale) {
                    return $this->translator->translate($locale, $key, $arguments);
                }))->getMessages()
            );
        }

        $this->repository->persist($course);

        return $this->responseManager->createResponse($request, 200, $accept, $course);
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Chubbyphp\ApiSkeleton\Controller\Course;
6
7		use Chubbyphp\ApiHttp\Error\Error;
8		use Chubbyphp\ApiHttp\Manager\RequestManagerInterface;
9		use Chubbyphp\ApiHttp\Manager\ResponseManagerInterface;
10		use Chubbyphp\Model\RepositoryInterface;
11		use Chubbyphp\Translation\TranslatorInterface;
12		use Chubbyphp\Validation\Error\NestedErrorMessages;
13		use Chubbyphp\Validation\ValidatorInterface;
14		use Psr\Http\Message\ServerRequestInterface as Request;
15		use Psr\Http\Message\ResponseInterface as Response;
16		use Chubbyphp\ApiSkeleton\Model\Course;
17
18		final class CourseUpdateController
19		{
20		/**
21		* @var string
22		*/
23		private $defaultLanguage;
24
25		/**
26		* @var RepositoryInterface
27		*/
28		private $repository;
29
30		/**
31		* @var RequestManagerInterface
32		*/
33		private $requestManager;
34
35		/**
36		* @var ResponseManagerInterface
37		*/
38		private $responseManager;
39
40		/**
41		* @var TranslatorInterface
42		*/
43		private $translator;
44
45		/**
46		* @var ValidatorInterface
47		*/
48		private $validator;
49
50		/**
51		* @param string $defaultLanguage
52		* @param RepositoryInterface $repository
53		* @param RequestManagerInterface $requestManager
54		* @param ResponseManagerInterface $responseManager
55		* @param TranslatorInterface $translator
56		* @param ValidatorInterface $validator
57		*/
58	View Code Duplication	public function __construct(
		0 ignored issues – show Duplication introduced 2017-08-24 18:32 UTC by Report Bug Copy Issue Report 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...
59		string $defaultLanguage,
60		RepositoryInterface $repository,
61		RequestManagerInterface $requestManager,
62		ResponseManagerInterface $responseManager,
63		TranslatorInterface $translator,
64		ValidatorInterface $validator
65		) {
66		$this->defaultLanguage = $defaultLanguage;
67		$this->repository = $repository;
68		$this->requestManager = $requestManager;
69		$this->responseManager = $responseManager;
70		$this->translator = $translator;
71		$this->validator = $validator;
72		}
73
74		/**
75		* @param Request $request
76		*
77		* @return Response
78		*/
79		public function __invoke(Request $request): Response
80		{
81		if (null === $accept = $this->requestManager->getAccept($request)) {
82		return $this->responseManager->createAcceptNotSupportedResponse($request);
83		}
84
85	View Code Duplication	if (null === $contentType = $this->requestManager->getContentType($request)) {
		0 ignored issues – show Duplication introduced 2017-09-04 18:26 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
86		return $this->responseManager->createContentTypeNotSupportedResponse($request, $accept);
87		}
88
89		$id = $request->getAttribute('id');
90
91		/** @var Course $course */
92		if (null === $course = $this->repository->find($id)) {
93		return $this->responseManager->createResourceNotFoundResponse($request, $accept, 'course', ['id' => $id]);
94		}
95
96		/** @var Course $course */
97		if (null === $course = $this->requestManager->getDataFromRequestBody($request, $course, $contentType)) {
98		return $this->responseManager->createBodyNotDeserializableResponse($request, $accept, $contentType);
99		}
100
101	View Code Duplication	if ([] !== $errors = $this->validator->validateObject($course)) {
		0 ignored issues – show Duplication introduced 2017-08-24 18:32 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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... Bug introduced 2018-10-10 17:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Chubbyphp\Validation\ValidatorInterface` as the method `validateObject()` does only exist in the following implementations of said interface: `Chubbyphp\Validation\Validator`. 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...
102		$locale = $this->requestManager->getAcceptLanguage($request, $this->defaultLanguage);
103
104		return $this->responseManager->createValidationErrorResponse(
105		$request,
106		$accept,
107		Error::SCOPE_BODY,
108		'course',
109		(new NestedErrorMessages($errors, function (string $key, array $arguments) use ($locale) {
110		return $this->translator->translate($locale, $key, $arguments);
111		}))->getMessages()
112		);
113		}
114
115		$this->repository->persist($course);
116
117		return $this->responseManager->createResponse($request, 200, $accept, $course);
118		}
119		}
120

chubbyphp / chubbyphp-api-slim-skeleton

CourseUpdateController::__invoke() B last analyzed 2018-10-10 17:13 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

CourseUpdateController::__invoke() B
last analyzed 2018-10-10 17:13 UTC