UserController::__construct() - Code Metrics - Inspection of "replaces also the rest of the entities by traits +..." - tfboe/fm-lib - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c087ad...47fff7 )

by Benedikt

created 2018-01-31 00:20 UTC

UserController::__construct() A

↳ Parent: UserController

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	2
rs	9.4285

<?php
declare(strict_types=1);

namespace Tfboe\FmLib\Http\Controllers;

use Doctrine\ORM\EntityManagerInterface;
use Illuminate\Contracts\Hashing\Hasher;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use Laravel\Lumen\Application;
use Tfboe\FmLib\Entity\UserInterface;
use Tfboe\FmLib\Exceptions\AuthenticationException;
use Tfboe\FmLib\Service\ObjectCreatorServiceInterface;
use Tymon\JWTAuth\Exceptions\JWTException;

/**
 * Class UserController
 * @package App\Http\Controllers
 */
class UserController extends BaseController
{
//<editor-fold desc="Public Methods">

  /** @var ObjectCreatorServiceInterface $objectCreatorService */
  private $objectCreatorService;

  /**
   * @inheritDoc
   */
  public function __construct(EntityManagerInterface $entityManager,
                              ObjectCreatorServiceInterface $objectCreatorService)
  {
    parent::__construct($entityManager);
    $this->objectCreatorService = $objectCreatorService;
  }


  /**
   * login action, checks credentials and returns token
   * @param Request $request the http request
   * @param Application $app
   * @return JsonResponse
   * @throws AuthenticationException wrong credentials or errors during creating a token
   */
  public function login(Request $request, Application $app): JsonResponse
  {
    $specification = $this->getCredentialSpecification($app);
    $this->addAdditionalLoginSpecifications($specification);
    $this->validateBySpecification($request, $specification);


    // grab credentials from the request
    $credentials = $request->only('email', 'password');

    /** @var string $token */
    $token = null;
    try {
      // attempt to verify the credentials and create a token for the user
      $token = Auth::attempt($credentials);
      if (!$token) {
        throw new AuthenticationException('invalid credentials');
      }
    } /** @noinspection PhpRedundantCatchClauseInspection */ catch (JWTException $e) {
      // something went wrong whilst attempting to encode the token
      throw new AuthenticationException('could not create token');
    }
    return $this->getLoginResponse($request, $token);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

  }

  /**
   * register action, registers a new user with email and password
   *
   * @param Request $request the http request
   * @param Application $app
   * @return JsonResponse
   */
  public function register(Request $request, Application $app): JsonResponse
  {
    $userClass = config('fm-lib')['entityMaps']['Tfboe\FmLib\Entity\UserInterface'];
    $specification = [];
    $specification['user'] = $this->getCredentialSpecification($app);
    $specification['user']['email']['validation'] .= '|unique:' . $userClass . ',email';
    $specification['user']['confirmedAGBVersion'] = ['validation' => 'integer|min:0'];

    $this->addAdditionalRegisterSpecifications($specification);

    $this->validateBySpecification($request, array_merge(...array_values($specification)));

    $input = $request->input();
    /** @var UserInterface $user */

    $user = $this->setFromSpecification($this->newUser(), $specification['user'], $input);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
    $this->getEntityManager()->persist($user); //sets the user id

    $this->createAdditionalRegisterEntities($user, $specification, $input);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

    $this->getEntityManager()->flush();

    return $this->getRegisterResponse($request, $app, $user);
  }

  /**
   * Creates a new user
   * @return UserInterface
   */
  protected function newUser(): UserInterface
  {
    return $this->objectCreatorService->createObjectFromInterface(UserInterface::class);
  }

  /**
   * Gets the response for a successful register action
   * @param Request $request the request
   * @param Application $app the application
   * @param UserInterface $user the newly registered user
   * @return JsonResponse the json response
   */
  protected function getRegisterResponse(/** @noinspection PhpUnusedParameterInspection */
    Request $request, /** @noinspection PhpUnusedParameterInspection */

    Application $app, UserInterface $user)

  {
    return response()->json(['id' => $user->getId()]);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
  }

  /**
   * @return JsonResponse
   */
  public function userId(): JsonResponse
  {
    /** @noinspection PhpUnhandledExceptionInspection */
    return response()->json(['id' => Auth::user()->getAuthIdentifier()]);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
  }
//</editor-fold desc="Public Methods">

//<editor-fold desc="Protected Methods">
  /**
   * Gets additional input specifications for the login action
   * @param array $specification the specification to add to / modify
   */
  protected function addAdditionalLoginSpecifications(array &$specification)

  {
    //do nothing by default
  }

  /**
   * adds additional register specifications
   * @param array $specification the specification to add to / modify
   */
  protected function addAdditionalRegisterSpecifications(array &$specification)

  {
    //do nothing by default
  }

  /**
   * creates additional entities after registration using the specification and the given input
   * @param UserInterface $user the newly registered user
   * @param array $specification the specification
   * @param array $input the given request input
   */
  protected function createAdditionalRegisterEntities(UserInterface $user, array $specification, array $input)

  {
    //do nothing by default
  }

  /**
   * Gets the response for a successful login action
   * @param Request $request the request
   * @param string $token the login token
   * @return JsonResponse the response
   */
  protected function getLoginResponse(Request $request, string $token): JsonResponse
  {
    $user = $request->user();
    return response()->json(['id' => $user->getId()], 200, ['jwt-token' => $token]);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
  }
//</editor-fold desc="Protected Methods">

//<editor-fold desc="Private Methods">
  /**
   * Gets the specification for the login credentials
   * @param Application $app
   * @return array
   */
  private function getCredentialSpecification(Application $app)
  {
    /** @var Hasher $hasher */
    return [
      'email' => ['validation' => 'required|email'],
      'password' => ['validation' => 'required|string|min:8',
        'transformer' => function ($value) use ($app) {
          return $app['hash']->make($value);
        }]
    ];
  }
//</editor-fold desc="Private Methods">
}


Push — master ( c087ad...47fff7 )

UserController::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			declare(strict_types=1);
3
4			namespace Tfboe\FmLib\Http\Controllers;
5
6			use Doctrine\ORM\EntityManagerInterface;
7			use Illuminate\Contracts\Hashing\Hasher;
8			use Illuminate\Http\JsonResponse;
9			use Illuminate\Http\Request;
10			use Illuminate\Support\Facades\Auth;
11			use Laravel\Lumen\Application;
12			use Tfboe\FmLib\Entity\UserInterface;
13			use Tfboe\FmLib\Exceptions\AuthenticationException;
14			use Tfboe\FmLib\Service\ObjectCreatorServiceInterface;
15			use Tymon\JWTAuth\Exceptions\JWTException;
16
17			/**
18			* Class UserController
19			* @package App\Http\Controllers
20			*/
21			class UserController extends BaseController
22			{
23			//<editor-fold desc="Public Methods">
24
25			/** @var ObjectCreatorServiceInterface $objectCreatorService */
26			private $objectCreatorService;
27
28			/**
29			* @inheritDoc
30			*/
31			public function __construct(EntityManagerInterface $entityManager,
32			ObjectCreatorServiceInterface $objectCreatorService)
33			{
34			parent::__construct($entityManager);
35			$this->objectCreatorService = $objectCreatorService;
36			}
37
38
39			/**
40			* login action, checks credentials and returns token
41			* @param Request $request the http request
42			* @param Application $app
43			* @return JsonResponse
44			* @throws AuthenticationException wrong credentials or errors during creating a token
45			*/
46			public function login(Request $request, Application $app): JsonResponse
47			{
48			$specification = $this->getCredentialSpecification($app);
49			$this->addAdditionalLoginSpecifications($specification);
50			$this->validateBySpecification($request, $specification);
51
52
53			// grab credentials from the request
54			$credentials = $request->only('email', 'password');
55
56			/** @var string $token */
57			$token = null;
58			try {
59			// attempt to verify the credentials and create a token for the user
60			$token = Auth::attempt($credentials);
61			if (!$token) {
62			throw new AuthenticationException('invalid credentials');
63			}
64			} /** @noinspection PhpRedundantCatchClauseInspection */ catch (JWTException $e) {
65			// something went wrong whilst attempting to encode the token
66			throw new AuthenticationException('could not create token');
67			}
68			return $this->getLoginResponse($request, $token);
			0 ignored issues – show Documentation introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report `$token` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
69
70			}
71
72			/**
73			* register action, registers a new user with email and password
74			*
75			* @param Request $request the http request
76			* @param Application $app
77			* @return JsonResponse
78			*/
79			public function register(Request $request, Application $app): JsonResponse
80			{
81			$userClass = config('fm-lib')['entityMaps']['Tfboe\FmLib\Entity\UserInterface'];
82			$specification = [];
83			$specification['user'] = $this->getCredentialSpecification($app);
84			$specification['user']['email']['validation'] .= '\|unique:' . $userClass . ',email';
85			$specification['user']['confirmedAGBVersion'] = ['validation' => 'integer\|min:0'];
86
87			$this->addAdditionalRegisterSpecifications($specification);
88
89			$this->validateBySpecification($request, array_merge(...array_values($specification)));
90
91			$input = $request->input();
92			/** @var UserInterface $user */
93
94			$user = $this->setFromSpecification($this->newUser(), $specification['user'], $input);
			0 ignored issues – show Bug introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report It seems like `$input` defined by `$request->input()` on line `91` can also be of type `string`; however, `Tfboe\FmLib\Http\Control...:setFromSpecification()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
95			$this->getEntityManager()->persist($user); //sets the user id
96
97			$this->createAdditionalRegisterEntities($user, $specification, $input);
			0 ignored issues – show Bug introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report It seems like `$input` defined by `$request->input()` on line `91` can also be of type `string`; however, `Tfboe\FmLib\Http\Control...ionalRegisterEntities()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
98
99			$this->getEntityManager()->flush();
100
101			return $this->getRegisterResponse($request, $app, $user);
102			}
103
104			/**
105			* Creates a new user
106			* @return UserInterface
107			*/
108			protected function newUser(): UserInterface
109			{
110			return $this->objectCreatorService->createObjectFromInterface(UserInterface::class);
111			}
112
113			/**
114			* Gets the response for a successful register action
115			* @param Request $request the request
116			* @param Application $app the application
117			* @param UserInterface $user the newly registered user
118			* @return JsonResponse the json response
119			*/
120			protected function getRegisterResponse(/** @noinspection PhpUnusedParameterInspection */
121			Request $request, /** @noinspection PhpUnusedParameterInspection */
			0 ignored issues – show Unused Code introduced 2018-01-30 14: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...
122			Application $app, UserInterface $user)
			0 ignored issues – show Unused Code introduced 2018-01-31 00:23 UTC by Report Bug Copy Issue Report The parameter `$app` 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...
123			{
124			return response()->json(['id' => $user->getId()]);
			0 ignored issues – show Bug introduced 2018-01-27 10:52 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Laravel\Lumen\Http\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
125			}
126
127			/**
128			* @return JsonResponse
129			*/
130			public function userId(): JsonResponse
131			{
132			/** @noinspection PhpUnhandledExceptionInspection */
133			return response()->json(['id' => Auth::user()->getAuthIdentifier()]);
			0 ignored issues – show Bug introduced 2018-01-27 10:52 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Laravel\Lumen\Http\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
134			}
135			//</editor-fold desc="Public Methods">
136
137			//<editor-fold desc="Protected Methods">
138			/**
139			* Gets additional input specifications for the login action
140			* @param array $specification the specification to add to / modify
141			*/
142			protected function addAdditionalLoginSpecifications(array &$specification)
			0 ignored issues – show Unused Code introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report The parameter `$specification` 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...
143			{
144			//do nothing by default
145			}
146
147			/**
148			* adds additional register specifications
149			* @param array $specification the specification to add to / modify
150			*/
151			protected function addAdditionalRegisterSpecifications(array &$specification)
			0 ignored issues – show Unused Code introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report The parameter `$specification` 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...
152			{
153			//do nothing by default
154			}
155
156			/**
157			* creates additional entities after registration using the specification and the given input
158			* @param UserInterface $user the newly registered user
159			* @param array $specification the specification
160			* @param array $input the given request input
161			*/
162			protected function createAdditionalRegisterEntities(UserInterface $user, array $specification, array $input)
			0 ignored issues – show Unused Code introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report The parameter `$user` 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... Unused Code introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report The parameter `$specification` 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... Unused Code introduced 2018-01-30 14:43 UTC by Report Bug Copy Issue Report The parameter `$input` 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...
163			{
164			//do nothing by default
165			}
166
167			/**
168			* Gets the response for a successful login action
169			* @param Request $request the request
170			* @param string $token the login token
171			* @return JsonResponse the response
172			*/
173			protected function getLoginResponse(Request $request, string $token): JsonResponse
174			{
175			$user = $request->user();
176			return response()->json(['id' => $user->getId()], 200, ['jwt-token' => $token]);
			0 ignored issues – show Bug introduced 2018-01-27 10:52 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Laravel\Lumen\Http\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
177			}
178			//</editor-fold desc="Protected Methods">
179
180			//<editor-fold desc="Private Methods">
181			/**
182			* Gets the specification for the login credentials
183			* @param Application $app
184			* @return array
185			*/
186			private function getCredentialSpecification(Application $app)
187			{
188			/** @var Hasher $hasher */
189			return [
190			'email' => ['validation' => 'required\|email'],
191			'password' => ['validation' => 'required\|string\|min:8',
192			'transformer' => function ($value) use ($app) {
193			return $app['hash']->make($value);
194			}]
195			];
196			}
197			//</editor-fold desc="Private Methods">
198			}
199

tfboe / fm-lib

Push — master ( c087ad...47fff7 )

UserController::__construct() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like