Inspection of "readme" - SherifElfadaly/Laravel-Api-Skeleton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a877ca...503ff2 )

by Sherif

created 2016-04-07 11:21 UTC

Status

Unused Use Statements -1 removed lines patch added patch discarded remove patch

@@ -1,6 +1,5 @@
 block discarded – undo
 <?php namespace App\Modules\Acl;
 
-use Illuminate\Database\Eloquent\Model;
 use App\User;
 use Illuminate\Database\Eloquent\SoftDeletes;
 

Please login to merge, or discard this patch.

src/Modules/V1/Reporting/Repositories/ReportRepository.php 1 patch

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

@@ -46,7 +46,7 @@
 block discarded – undo
      *
      * @param  array   $conditions array of conditions
      * @param  array   $relations
-     * @param  array   $colunmns
+     * @param  array   $columns
      * @return object
      */
     public function first($conditions, $relations = [], $columns = array('*'))

Please login to merge, or discard this patch.

src/Modules/V1/Acl/Repositories/UserRepository.php 1 patch

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

@@ -202,7 +202,7 @@
 block discarded – undo
      * Reset the given user's password.
      *
      * @param  array  $credentials
-     * @return integer
+     * @return false|null
      */
     public function resetPassword($credentials)
     {

Please login to merge, or discard this patch.

src/Modules/V1/Core/AbstractRepositories/AbstractRepository.php 1 patch

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

@@ -32,7 +32,7 @@  discard block
 block discarded – undo
      *
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -50,7 +50,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -133,7 +133,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -151,7 +151,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -468,7 +468,7 @@  discard block
 block discarded – undo
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */

Please login to merge, or discard this patch.

src/Modules/V1/Core/Http/Controllers/BaseApiController.php 1 patch

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

@@ -37,7 +37,7 @@  discard block
 block discarded – undo
     /**
      * Fetch all records with relations from model repository.
      * 
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getIndex() 
     {
@@ -52,7 +52,7 @@  discard block
 block discarded – undo
      * Fetch the single object with relations from model repository.
      * 
      * @param  integer $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getFind($id) 
     {
@@ -70,8 +70,8 @@  discard block
 block discarded – undo
      * @param  string  $query
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getSearch($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -88,8 +88,8 @@  discard block
 block discarded – undo
      * 
      * @param  \Illuminate\Http\Request  $request
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postFindby(Request $request, $sortBy = 'created_at', $desc = 1) 
     {
@@ -105,7 +105,7 @@  discard block
 block discarded – undo
      * condition.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postFirst(Request $request) 
     {
@@ -121,8 +121,8 @@  discard block
 block discarded – undo
      * 
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getPaginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -140,8 +140,8 @@  discard block
 block discarded – undo
      * @param  \Illuminate\Http\Request  $request
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postPaginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -156,7 +156,7 @@  discard block
 block discarded – undo
      * Save the given model to repository.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function postSave(Request $request) 
     {
@@ -189,7 +189,7 @@  discard block
 block discarded – undo
      * Delete by the given id from model repository.
      * 
      * @param  integer  $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getDelete($id) 
     {

Please login to merge, or discard this patch.

src/Modules/V1/Core/Interfaces/RepositoryInterface.php 1 patch

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

@@ -7,7 +7,7 @@  discard block
 block discarded – undo
      * 
      * @param  array  $relations
      * @param  array  $sortBy
-     * @param  array  $desc
+     * @param  integer  $desc
      * @param  array  $columns
      * @return collection
      */
@@ -21,7 +21,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */
@@ -33,7 +33,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */
@@ -47,7 +47,7 @@  discard block
 block discarded – undo
      * @param  integer $perPage
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */
@@ -90,7 +90,7 @@  discard block
 block discarded – undo
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  array   $sortBy
-     * @param  array   $desc
+     * @param  integer   $desc
      * @param  array   $columns
      * @return collection
      */

Please login to merge, or discard this patch.

		@@ -202,7 +202,7 @@
		block discarded – undo
202	202	* Reset the given user's password.
203	203	*
204	204	* @param array $credentials
205		- * @return integer
	205	+ * @return false\|null
206	206	*/
207	207	public function resetPassword($credentials)
208	208	{

		@@ -1,6 +1,5 @@
		block discarded – undo
1	1	<?php namespace App\Modules\Acl;
2	2
3		-use Illuminate\Database\Eloquent\Model;
4	3	use App\User;
5	4	use Illuminate\Database\Eloquent\SoftDeletes;
6	5

		@@ -46,7 +46,7 @@
		block discarded – undo
46	46	*
47	47	* @param array $conditions array of conditions
48	48	* @param array $relations
49		- * @param array $colunmns
	49	+ * @param array $columns
50	50	* @return object
51	51	*/
52	52	public function first($conditions, $relations = [], $columns = array('*'))

		@@ -32,7 +32,7 @@ discard block
		block discarded – undo
32	32	*
33	33	* @param array $relations
34	34	* @param string $sortBy
35		- * @param boolean $desc
	35	+ * @param integer $desc
36	36	* @param array $columns
37	37	* @return collection
38	38	*/
		@@ -50,7 +50,7 @@ discard block
		block discarded – undo
50	50	* @param integer $perPage
51	51	* @param array $relations
52	52	* @param string $sortBy
53		- * @param boolean $desc
	53	+ * @param integer $desc
54	54	* @param array $columns
55	55	* @return collection
56	56	*/
		@@ -133,7 +133,7 @@ discard block
		block discarded – undo
133	133	* @param integer $perPage
134	134	* @param array $relations
135	135	* @param string $sortBy
136		- * @param boolean $desc
	136	+ * @param integer $desc
137	137	* @param array $columns
138	138	* @return collection
139	139	*/
		@@ -151,7 +151,7 @@ discard block
		block discarded – undo
151	151	* @param integer $perPage
152	152	* @param array $relations
153	153	* @param string $sortBy
154		- * @param boolean $desc
	154	+ * @param integer $desc
155	155	* @param array $columns
156	156	* @return collection
157	157	*/
		@@ -468,7 +468,7 @@ discard block
		block discarded – undo
468	468	* @param array $conditions array of conditions
469	469	* @param array $relations
470	470	* @param string $sortBy
471		- * @param boolean $desc
	471	+ * @param integer $desc
472	472	* @param array $columns
473	473	* @return collection
474	474	*/

		@@ -37,7 +37,7 @@ discard block
		block discarded – undo
37	37	/**
38	38	* Fetch all records with relations from model repository.
39	39	*
40		- * @return \Illuminate\Http\Response
	40	+ * @return \Illuminate\Http\JsonResponse\|null
41	41	*/
42	42	public function getIndex()
43	43	{
		@@ -52,7 +52,7 @@ discard block
		block discarded – undo
52	52	* Fetch the single object with relations from model repository.
53	53	*
54	54	* @param integer $id
55		- * @return \Illuminate\Http\Response
	55	+ * @return \Illuminate\Http\JsonResponse\|null
56	56	*/
57	57	public function getFind($id)
58	58	{
		@@ -70,8 +70,8 @@ discard block
		block discarded – undo
70	70	* @param string $query
71	71	* @param integer $perPage
72	72	* @param string $sortBy
73		- * @param boolean $desc
74		- * @return \Illuminate\Http\Response
	73	+ * @param integer $desc
	74	+ * @return \Illuminate\Http\JsonResponse\|null
75	75	*/
76	76	public function getSearch($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1)
77	77	{
		@@ -88,8 +88,8 @@ discard block
		block discarded – undo
88	88	*
89	89	* @param \Illuminate\Http\Request $request
90	90	* @param string $sortBy
91		- * @param boolean $desc
92		- * @return \Illuminate\Http\Response
	91	+ * @param integer $desc
	92	+ * @return \Illuminate\Http\JsonResponse\|null
93	93	*/
94	94	public function postFindby(Request $request, $sortBy = 'created_at', $desc = 1)
95	95	{
		@@ -105,7 +105,7 @@ discard block
		block discarded – undo
105	105	* condition.
106	106	*
107	107	* @param \Illuminate\Http\Request $request
108		- * @return \Illuminate\Http\Response
	108	+ * @return \Illuminate\Http\JsonResponse\|null
109	109	*/
110	110	public function postFirst(Request $request)
111	111	{
		@@ -121,8 +121,8 @@ discard block
		block discarded – undo
121	121	*
122	122	* @param integer $perPage
123	123	* @param string $sortBy
124		- * @param boolean $desc
125		- * @return \Illuminate\Http\Response
	124	+ * @param integer $desc
	125	+ * @return \Illuminate\Http\JsonResponse\|null
126	126	*/
127	127	public function getPaginate($perPage = 15, $sortBy = 'created_at', $desc = 1)
128	128	{
		@@ -140,8 +140,8 @@ discard block
		block discarded – undo
140	140	* @param \Illuminate\Http\Request $request
141	141	* @param integer $perPage
142	142	* @param string $sortBy
143		- * @param boolean $desc
144		- * @return \Illuminate\Http\Response
	143	+ * @param integer $desc
	144	+ * @return \Illuminate\Http\JsonResponse\|null
145	145	*/
146	146	public function postPaginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1)
147	147	{
		@@ -156,7 +156,7 @@ discard block
		block discarded – undo
156	156	* Save the given model to repository.
157	157	*
158	158	* @param \Illuminate\Http\Request $request
159		- * @return \Illuminate\Http\Response
	159	+ * @return \Illuminate\Http\JsonResponse\|null
160	160	*/
161	161	public function postSave(Request $request)
162	162	{
		@@ -189,7 +189,7 @@ discard block
		block discarded – undo
189	189	* Delete by the given id from model repository.
190	190	*
191	191	* @param integer $id
192		- * @return \Illuminate\Http\Response
	192	+ * @return \Illuminate\Http\JsonResponse\|null
193	193	*/
194	194	public function getDelete($id)
195	195	{

		@@ -7,7 +7,7 @@ discard block
		block discarded – undo
7	7	*
8	8	* @param array $relations
9	9	* @param array $sortBy
10		- * @param array $desc
	10	+ * @param integer $desc
11	11	* @param array $columns
12	12	* @return collection
13	13	*/
		@@ -21,7 +21,7 @@ discard block
		block discarded – undo
21	21	* @param integer $perPage
22	22	* @param array $relations
23	23	* @param array $sortBy
24		- * @param array $desc
	24	+ * @param integer $desc
25	25	* @param array $columns
26	26	* @return collection
27	27	*/
		@@ -33,7 +33,7 @@ discard block
		block discarded – undo
33	33	* @param integer $perPage
34	34	* @param array $relations
35	35	* @param array $sortBy
36		- * @param array $desc
	36	+ * @param integer $desc
37	37	* @param array $columns
38	38	* @return collection
39	39	*/
		@@ -47,7 +47,7 @@ discard block
		block discarded – undo
47	47	* @param integer $perPage
48	48	* @param array $relations
49	49	* @param array $sortBy
50		- * @param array $desc
	50	+ * @param integer $desc
51	51	* @param array $columns
52	52	* @return collection
53	53	*/
		@@ -90,7 +90,7 @@ discard block
		block discarded – undo
90	90	* @param array $conditions array of conditions
91	91	* @param array $relations
92	92	* @param array $sortBy
93		- * @param array $desc
	93	+ * @param integer $desc
94	94	* @param array $columns
95	95	* @return collection
96	96	*/

SherifElfadaly / Laravel-Api-Skeleton

Push — master ( a877ca...503ff2 )

Status

Category

Unused Use Statements -1 removed lines patch added patch discarded remove patch

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

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

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

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

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