Inspection of "Fix bugs and comments to save and search methods i..." - SherifElfadaly/Laravel-Api-Skeleton - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 262a61...e9fbf8 )

by Sherif

created 2016-04-06 15:34 UTC

Status

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

@@ -54,9 +54,7 @@  discard block
 block discarded – undo
     /**
      * Fetch all records with relations from model repository.
      * 
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function getIndex() 
     {
@@ -71,7 +69,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) 
     {
@@ -89,8 +87,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) 
     {
@@ -107,8 +105,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) 
     {
@@ -124,7 +122,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) 
     {
@@ -140,8 +138,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) 
     {
@@ -159,8 +157,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) 
     {
@@ -175,7 +173,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) 
     {
@@ -208,7 +206,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/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/Interfaces/RepositoryInterface.php 1 patch

Doc Comments +5 added lines, -6 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
      */
@@ -101,7 +101,6 @@  discard block
 block discarded – undo
      * condition.
      * 
      * @param  array   $conditions array of conditions
-     * @param  var     $value condition value
      * @param  array   $relations
      * @param  array   $columns
      * @return object

Please login to merge, or discard this patch.

		@@ -54,9 +54,7 @@ discard block
		block discarded – undo
54	54	/**
55	55	* Fetch all records with relations from model repository.
56	56	*
57		- * @param string $sortBy
58		- * @param boolean $desc
59		- * @return \Illuminate\Http\Response
	57	+ * @return \Illuminate\Http\JsonResponse\|null
60	58	*/
61	59	public function getIndex()
62	60	{
		@@ -71,7 +69,7 @@ discard block
		block discarded – undo
71	69	* Fetch the single object with relations from model repository.
72	70	*
73	71	* @param integer $id
74		- * @return \Illuminate\Http\Response
	72	+ * @return \Illuminate\Http\JsonResponse\|null
75	73	*/
76	74	public function getFind($id)
77	75	{
		@@ -89,8 +87,8 @@ discard block
		block discarded – undo
89	87	* @param string $query
90	88	* @param integer $perPage
91	89	* @param string $sortBy
92		- * @param boolean $desc
93		- * @return \Illuminate\Http\Response
	90	+ * @param integer $desc
	91	+ * @return \Illuminate\Http\JsonResponse\|null
94	92	*/
95	93	public function getSearch($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1)
96	94	{
		@@ -107,8 +105,8 @@ discard block
		block discarded – undo
107	105	*
108	106	* @param \Illuminate\Http\Request $request
109	107	* @param string $sortBy
110		- * @param boolean $desc
111		- * @return \Illuminate\Http\Response
	108	+ * @param integer $desc
	109	+ * @return \Illuminate\Http\JsonResponse\|null
112	110	*/
113	111	public function postFindby(Request $request, $sortBy = 'created_at', $desc = 1)
114	112	{
		@@ -124,7 +122,7 @@ discard block
		block discarded – undo
124	122	* condition.
125	123	*
126	124	* @param \Illuminate\Http\Request $request
127		- * @return \Illuminate\Http\Response
	125	+ * @return \Illuminate\Http\JsonResponse\|null
128	126	*/
129	127	public function postFirst(Request $request)
130	128	{
		@@ -140,8 +138,8 @@ discard block
		block discarded – undo
140	138	*
141	139	* @param integer $perPage
142	140	* @param string $sortBy
143		- * @param boolean $desc
144		- * @return \Illuminate\Http\Response
	141	+ * @param integer $desc
	142	+ * @return \Illuminate\Http\JsonResponse\|null
145	143	*/
146	144	public function getPaginate($perPage = 15, $sortBy = 'created_at', $desc = 1)
147	145	{
		@@ -159,8 +157,8 @@ discard block
		block discarded – undo
159	157	* @param \Illuminate\Http\Request $request
160	158	* @param integer $perPage
161	159	* @param string $sortBy
162		- * @param boolean $desc
163		- * @return \Illuminate\Http\Response
	160	+ * @param integer $desc
	161	+ * @return \Illuminate\Http\JsonResponse\|null
164	162	*/
165	163	public function postPaginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1)
166	164	{
		@@ -175,7 +173,7 @@ discard block
		block discarded – undo
175	173	* Save the given model to repository.
176	174	*
177	175	* @param \Illuminate\Http\Request $request
178		- * @return \Illuminate\Http\Response
	176	+ * @return \Illuminate\Http\JsonResponse\|null
179	177	*/
180	178	public function postSave(Request $request)
181	179	{
		@@ -208,7 +206,7 @@ discard block
		block discarded – undo
208	206	* Delete by the given id from model repository.
209	207	*
210	208	* @param integer $id
211		- * @return \Illuminate\Http\Response
	209	+ * @return \Illuminate\Http\JsonResponse\|null
212	210	*/
213	211	public function getDelete($id)
214	212	{

		@@ -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('*'))

		@@ -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	{

		@@ -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	*/

		@@ -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	*/
		@@ -101,7 +101,6 @@ discard block
		block discarded – undo
101	101	* condition.
102	102	*
103	103	* @param array $conditions array of conditions
104		- * @param var $value condition value
105	104	* @param array $relations
106	105	* @param array $columns
107	106	* @return object

SherifElfadaly / Laravel-Api-Skeleton

Push — master ( 262a61...e9fbf8 )

Status

Category

Doc Comments +13 added lines, -15 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 +5 added lines, -6 removed lines patch added patch discarded remove patch