Inspection of "Code quality and minor bugfixes" - Maelstromeous/ps2alerts-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#22)

by Matthew

created 2017-07-16 15:27 UTC

Status

Doc Comments +1 added lines, -3 removed lines patch added patch discarded remove patch

@@ -15,9 +15,7 @@
 block discarded – undo
     /**
      * Construct
      *
-     * @param Ps2alerts\Api\Repository\AlertRepository   $repository
-     * @param Ps2alerts\Api\Transformer\AlertTransformer $transformer
-     * @param League\Fractal\Manager                     $fractal
+     * @param Manager                     $fractal
      */
     public function __construct(
         Manager          $fractal

Please login to merge, or discard this patch.

src/Controller/Endpoint/Data/DataEndpointController.php 1 patch

Doc Comments +10 added lines, -10 removed lines patch added patch discarded remove patch

@@ -25,7 +25,7 @@  discard block
 block discarded – undo
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                    $fractal
+     * @param Manager                    $fractal
      */
     public function __construct(
         Manager $fractal,
@@ -38,11 +38,11 @@  discard block
 block discarded – undo
     /**
      * Gets supplemental data
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function getSupplementalData(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {
@@ -57,11 +57,11 @@  discard block
 block discarded – undo
     /**
      * Gets a player's info, either from redis or db cache
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function character(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {
@@ -102,11 +102,11 @@  discard block
 block discarded – undo
     /**
      * Gets an outfits's info, either from redis or db cache
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface
      */
     public function outfit(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {

Please login to merge, or discard this patch.

src/Controller/Endpoint/Leaderboards/LeaderboardEndpointController.php 1 patch

Doc Comments +11 added lines, -11 removed lines patch added patch discarded remove patch

@@ -23,7 +23,7 @@  discard block
 block discarded – undo
     /**
      * Construct
      *
-     * @param League\Fractal\Manager $fractal
+     * @param Manager $fractal
      */
     public function __construct(
         Manager                $fractal,
@@ -43,10 +43,10 @@  discard block
 block discarded – undo
     /**
      * Get Player Leaderboard
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return League\Fractal\Manager
+     * @return ResponseInterface
      */
     public function players(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -136,10 +136,10 @@  discard block
 block discarded – undo
     /**
      * Get Outfit Leaderboard
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return League\Fractal\Manager
+     * @return ResponseInterface
      */
     public function outfits(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -210,10 +210,10 @@  discard block
 block discarded – undo
     /**
      * Get Weapon Leaderboard
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return League\Fractal\Manager
+     * @return ResponseInterface
      */
     public function weapons(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -275,7 +275,7 @@  discard block
 block discarded – undo
     /**
      * Validates the request variables
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
+     * @param  ServerRequestInterface  $request
      *
      * @return boolean|InvalidArgumentException
      */

Please login to merge, or discard this patch.

Controller/Endpoint/Leaderboards/LeaderboardLadderEndpointController.php 1 patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

@@ -29,10 +29,10 @@  discard block
 block discarded – undo
     /**
      * Prompts the Leaderboard:Check command to resync the leaderboards
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return Symfony\Component\HttpFoundation\Response
+     * @return ResponseInterface
      */
     public function update(ServerRequestInterface $request, ResponseInterface $response)
     {
@@ -71,10 +71,10 @@  discard block
 block discarded – undo
     /**
      * Returns a list of times that a server leaderboard has been updated
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      *
-     * @return Symfony\Component\HttpFoundation\Response
+     * @return ResponseInterface
      */
     public function lastUpdate(ServerRequestInterface $request, ResponseInterface $response)
     {

Please login to merge, or discard this patch.

src/Controller/Endpoint/Profiles/OutfitProfileEndpointController.php 1 patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

@@ -14,9 +14,9 @@  discard block
 block discarded – undo
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                                      $fractal
-     * @param Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository      $outfitTotalRepo
-     * @param Ps2alerts\Api\Transformer\Profiles\OutfitProfileTransformer $outfitProfileTransformer
+     * @param Manager                                      $fractal
+     * @param OutfitTotalRepository      $outfitTotalRepo
+     * @param OutfitProfileTransformer $outfitProfileTransformer
      */
     public function __construct(
         Manager                  $fractal,
@@ -31,11 +31,11 @@  discard block
 block discarded – undo
     /**
      * Gets a outfit
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return array
+     * @return ResponseInterface
      */
     public function getOutfit(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {

Please login to merge, or discard this patch.

src/Controller/Endpoint/Profiles/PlayerProfileEndpointController.php 1 patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

@@ -14,9 +14,9 @@  discard block
 block discarded – undo
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                                      $fractal
-     * @param Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository      $playerTotalRepo
-     * @param Ps2alerts\Api\Transformer\Profiles\PlayerProfileTransformer $playerProfileTransformer
+     * @param Manager                                      $fractal
+     * @param PlayerTotalRepository      $playerTotalRepo
+     * @param PlayerProfileTransformer $playerProfileTransformer
      */
     public function __construct(
         Manager                  $fractal,
@@ -31,11 +31,11 @@  discard block
 block discarded – undo
     /**
      * Gets a player
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return array
+     * @return ResponseInterface
      */
     public function getPlayer(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {

Please login to merge, or discard this patch.

src/Controller/Endpoint/Search/SearchEndpointController.php 1 patch

Doc Comments +11 added lines, -11 removed lines patch added patch discarded remove patch

@@ -17,11 +17,11 @@  discard block
 block discarded – undo
     /**
      * Construct
      *
-     * @param League\Fractal\Manager                                   $fractal
-     * @param Ps2alerts\Api\Transformer\Search\OutfitSearchTransformer $outfitSearchTransformer
-     * @param Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository   $outfitTotalRepo
-     * @param Ps2alerts\Api\Transformer\Search\PlayerSearchTransformer $playerSearchTransformer
-     * @param Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository   $playerTotalRepo
+     * @param Manager                                   $fractal
+     * @param OutfitSearchTransformer $outfitSearchTransformer
+     * @param OutfitTotalRepository   $outfitTotalRepo
+     * @param PlayerSearchTransformer $playerSearchTransformer
+     * @param PlayerTotalRepository   $playerTotalRepo
      */
     public function __construct(
         Manager                 $fractal,
@@ -40,11 +40,11 @@  discard block
 block discarded – undo
     /**
      * Endpoint to return potential players based on search term
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface|null
      */
     public function getPlayersByTerm(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {
@@ -67,11 +67,11 @@  discard block
 block discarded – undo
     /**
      * Endpoint to return potential players based on search term
      *
-     * @param  Psr\Http\Message\ServerRequestInterface  $request
-     * @param  Psr\Http\Message\ResponseInterface $response
+     * @param  ServerRequestInterface  $request
+     * @param  ResponseInterface $response
      * @param  array                                     $args
      *
-     * @return \League\Fractal\TransformerAbstract
+     * @return ResponseInterface|null
      */
     public function getOutfitsByTerm(ServerRequestInterface $request, ResponseInterface $response, array $args)
     {

Please login to merge, or discard this patch.

src/Transformer/DataTransformer.php 1 patch

Doc Comments -1 removed lines patch added patch discarded remove patch

@@ -57,7 +57,6 @@
 block discarded – undo
     /**
      * The tranform method required by Fractal to parse the data and return proper typing and fields.
      *
-     * @param  array $data Data to transform
      *
      * @return array
      */

Please login to merge, or discard this patch.

src/Transformer/Profiles/OutfitProfileTransformer.php 1 patch

Doc Comments +3 added lines patch added patch discarded remove patch

@@ -219,6 +219,9 @@
 block discarded – undo
         return $players;
     }
 
+    /**
+     * @param integer $offset
+     */
     public function getOutfitMembers($data, $offset)
     {
         $client = $this->getHttpClientDriver();

Please login to merge, or discard this patch.

		@@ -57,7 +57,6 @@
		block discarded – undo
57	57	/**
58	58	* The tranform method required by Fractal to parse the data and return proper typing and fields.
59	59	*
60		- * @param array $data Data to transform
61	60	*
62	61	* @return array
63	62	*/

		@@ -219,6 +219,9 @@
		block discarded – undo
219	219	return $players;
220	220	}
221	221
	222	+ /**
	223	+ * @param integer $offset
	224	+ */
222	225	public function getOutfitMembers($data, $offset)
223	226	{
224	227	$client = $this->getHttpClientDriver();

		@@ -15,9 +15,7 @@
		block discarded – undo
15	15	/**
16	16	* Construct
17	17	*
18		- * @param Ps2alerts\Api\Repository\AlertRepository $repository
19		- * @param Ps2alerts\Api\Transformer\AlertTransformer $transformer
20		- * @param League\Fractal\Manager $fractal
	18	+ * @param Manager $fractal
21	19	*/
22	20	public function __construct(
23	21	Manager $fractal

		@@ -25,7 +25,7 @@ discard block
		block discarded – undo
25	25	/**
26	26	* Construct
27	27	*
28		- * @param League\Fractal\Manager $fractal
	28	+ * @param Manager $fractal
29	29	*/
30	30	public function __construct(
31	31	Manager $fractal,
		@@ -38,11 +38,11 @@ discard block
		block discarded – undo
38	38	/**
39	39	* Gets supplemental data
40	40	*
41		- * @param Psr\Http\Message\ServerRequestInterface $request
42		- * @param Psr\Http\Message\ResponseInterface $response
	41	+ * @param ServerRequestInterface $request
	42	+ * @param ResponseInterface $response
43	43	* @param array $args
44	44	*
45		- * @return \League\Fractal\TransformerAbstract
	45	+ * @return ResponseInterface
46	46	*/
47	47	public function getSupplementalData(ServerRequestInterface $request, ResponseInterface $response, array $args)
48	48	{
		@@ -57,11 +57,11 @@ discard block
		block discarded – undo
57	57	/**
58	58	* Gets a player's info, either from redis or db cache
59	59	*
60		- * @param Psr\Http\Message\ServerRequestInterface $request
61		- * @param Psr\Http\Message\ResponseInterface $response
	60	+ * @param ServerRequestInterface $request
	61	+ * @param ResponseInterface $response
62	62	* @param array $args
63	63	*
64		- * @return \League\Fractal\TransformerAbstract
	64	+ * @return ResponseInterface
65	65	*/
66	66	public function character(ServerRequestInterface $request, ResponseInterface $response, array $args)
67	67	{
		@@ -102,11 +102,11 @@ discard block
		block discarded – undo
102	102	/**
103	103	* Gets an outfits's info, either from redis or db cache
104	104	*
105		- * @param Psr\Http\Message\ServerRequestInterface $request
106		- * @param Psr\Http\Message\ResponseInterface $response
	105	+ * @param ServerRequestInterface $request
	106	+ * @param ResponseInterface $response
107	107	* @param array $args
108	108	*
109		- * @return \League\Fractal\TransformerAbstract
	109	+ * @return ResponseInterface
110	110	*/
111	111	public function outfit(ServerRequestInterface $request, ResponseInterface $response, array $args)
112	112	{

		@@ -23,7 +23,7 @@ discard block
		block discarded – undo
23	23	/**
24	24	* Construct
25	25	*
26		- * @param League\Fractal\Manager $fractal
	26	+ * @param Manager $fractal
27	27	*/
28	28	public function __construct(
29	29	Manager $fractal,
		@@ -43,10 +43,10 @@ discard block
		block discarded – undo
43	43	/**
44	44	* Get Player Leaderboard
45	45	*
46		- * @param Psr\Http\Message\ServerRequestInterface $request
47		- * @param Psr\Http\Message\ResponseInterface $response
	46	+ * @param ServerRequestInterface $request
	47	+ * @param ResponseInterface $response
48	48	*
49		- * @return League\Fractal\Manager
	49	+ * @return ResponseInterface
50	50	*/
51	51	public function players(ServerRequestInterface $request, ResponseInterface $response)
52	52	{
		@@ -136,10 +136,10 @@ discard block
		block discarded – undo
136	136	/**
137	137	* Get Outfit Leaderboard
138	138	*
139		- * @param Psr\Http\Message\ServerRequestInterface $request
140		- * @param Psr\Http\Message\ResponseInterface $response
	139	+ * @param ServerRequestInterface $request
	140	+ * @param ResponseInterface $response
141	141	*
142		- * @return League\Fractal\Manager
	142	+ * @return ResponseInterface
143	143	*/
144	144	public function outfits(ServerRequestInterface $request, ResponseInterface $response)
145	145	{
		@@ -210,10 +210,10 @@ discard block
		block discarded – undo
210	210	/**
211	211	* Get Weapon Leaderboard
212	212	*
213		- * @param Psr\Http\Message\ServerRequestInterface $request
214		- * @param Psr\Http\Message\ResponseInterface $response
	213	+ * @param ServerRequestInterface $request
	214	+ * @param ResponseInterface $response
215	215	*
216		- * @return League\Fractal\Manager
	216	+ * @return ResponseInterface
217	217	*/
218	218	public function weapons(ServerRequestInterface $request, ResponseInterface $response)
219	219	{
		@@ -275,7 +275,7 @@ discard block
		block discarded – undo
275	275	/**
276	276	* Validates the request variables
277	277	*
278		- * @param Psr\Http\Message\ServerRequestInterface $request
	278	+ * @param ServerRequestInterface $request
279	279	*
280	280	* @return boolean\|InvalidArgumentException
281	281	*/

		@@ -29,10 +29,10 @@ discard block
		block discarded – undo
29	29	/**
30	30	* Prompts the Leaderboard:Check command to resync the leaderboards
31	31	*
32		- * @param Psr\Http\Message\ServerRequestInterface $request
33		- * @param Psr\Http\Message\ResponseInterface $response
	32	+ * @param ServerRequestInterface $request
	33	+ * @param ResponseInterface $response
34	34	*
35		- * @return Symfony\Component\HttpFoundation\Response
	35	+ * @return ResponseInterface
36	36	*/
37	37	public function update(ServerRequestInterface $request, ResponseInterface $response)
38	38	{
		@@ -71,10 +71,10 @@ discard block
		block discarded – undo
71	71	/**
72	72	* Returns a list of times that a server leaderboard has been updated
73	73	*
74		- * @param Psr\Http\Message\ServerRequestInterface $request
75		- * @param Psr\Http\Message\ResponseInterface $response
	74	+ * @param ServerRequestInterface $request
	75	+ * @param ResponseInterface $response
76	76	*
77		- * @return Symfony\Component\HttpFoundation\Response
	77	+ * @return ResponseInterface
78	78	*/
79	79	public function lastUpdate(ServerRequestInterface $request, ResponseInterface $response)
80	80	{

		@@ -14,9 +14,9 @@ discard block
		block discarded – undo
14	14	/**
15	15	* Construct
16	16	*
17		- * @param League\Fractal\Manager $fractal
18		- * @param Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository $outfitTotalRepo
19		- * @param Ps2alerts\Api\Transformer\Profiles\OutfitProfileTransformer $outfitProfileTransformer
	17	+ * @param Manager $fractal
	18	+ * @param OutfitTotalRepository $outfitTotalRepo
	19	+ * @param OutfitProfileTransformer $outfitProfileTransformer
20	20	*/
21	21	public function __construct(
22	22	Manager $fractal,
		@@ -31,11 +31,11 @@ discard block
		block discarded – undo
31	31	/**
32	32	* Gets a outfit
33	33	*
34		- * @param Psr\Http\Message\ServerRequestInterface $request
35		- * @param Psr\Http\Message\ResponseInterface $response
	34	+ * @param ServerRequestInterface $request
	35	+ * @param ResponseInterface $response
36	36	* @param array $args
37	37	*
38		- * @return array
	38	+ * @return ResponseInterface
39	39	*/
40	40	public function getOutfit(ServerRequestInterface $request, ResponseInterface $response, array $args)
41	41	{

		@@ -17,11 +17,11 @@ discard block
		block discarded – undo
17	17	/**
18	18	* Construct
19	19	*
20		- * @param League\Fractal\Manager $fractal
21		- * @param Ps2alerts\Api\Transformer\Search\OutfitSearchTransformer $outfitSearchTransformer
22		- * @param Ps2alerts\Api\Repository\Metrics\OutfitTotalRepository $outfitTotalRepo
23		- * @param Ps2alerts\Api\Transformer\Search\PlayerSearchTransformer $playerSearchTransformer
24		- * @param Ps2alerts\Api\Repository\Metrics\PlayerTotalRepository $playerTotalRepo
	20	+ * @param Manager $fractal
	21	+ * @param OutfitSearchTransformer $outfitSearchTransformer
	22	+ * @param OutfitTotalRepository $outfitTotalRepo
	23	+ * @param PlayerSearchTransformer $playerSearchTransformer
	24	+ * @param PlayerTotalRepository $playerTotalRepo
25	25	*/
26	26	public function __construct(
27	27	Manager $fractal,
		@@ -40,11 +40,11 @@ discard block
		block discarded – undo
40	40	/**
41	41	* Endpoint to return potential players based on search term
42	42	*
43		- * @param Psr\Http\Message\ServerRequestInterface $request
44		- * @param Psr\Http\Message\ResponseInterface $response
	43	+ * @param ServerRequestInterface $request
	44	+ * @param ResponseInterface $response
45	45	* @param array $args
46	46	*
47		- * @return \League\Fractal\TransformerAbstract
	47	+ * @return ResponseInterface\|null
48	48	*/
49	49	public function getPlayersByTerm(ServerRequestInterface $request, ResponseInterface $response, array $args)
50	50	{
		@@ -67,11 +67,11 @@ discard block
		block discarded – undo
67	67	/**
68	68	* Endpoint to return potential players based on search term
69	69	*
70		- * @param Psr\Http\Message\ServerRequestInterface $request
71		- * @param Psr\Http\Message\ResponseInterface $response
	70	+ * @param ServerRequestInterface $request
	71	+ * @param ResponseInterface $response
72	72	* @param array $args
73	73	*
74		- * @return \League\Fractal\TransformerAbstract
	74	+ * @return ResponseInterface\|null
75	75	*/
76	76	public function getOutfitsByTerm(ServerRequestInterface $request, ResponseInterface $response, array $args)
77	77	{

Maelstromeous / ps2alerts-api

Pull Request — master (#22)

Status

Category

Doc Comments +1 added lines, -3 removed lines patch added patch discarded remove patch

Doc Comments +10 added lines, -10 removed lines patch added patch discarded remove patch

Doc Comments +11 added lines, -11 removed lines patch added patch discarded remove patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

Doc Comments +6 added lines, -6 removed lines patch added patch discarded remove patch

Doc Comments +11 added lines, -11 removed lines patch added patch discarded remove patch

Doc Comments -1 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines patch added patch discarded remove patch