SherifElfadaly / Laravel-Api-Skeleton

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

Doc Comments +6 added lines, -7 removed lines

@@ -32,7 +32,7 @@ 
      *
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -50,7 +50,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -139,7 +139,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -157,7 +157,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -496,7 +496,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -528,7 +528,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -551,7 +551,6 @@ 
      * Restore the deleted model.
      * 
      * @param  integer $id
-     * @param  string  $attribute condition column name
      * @return void
      */
     public function restore($id)

Spacing +26 added lines, -26 removed lines

@@ -63,14 +63,14 @@ 
         /**
          * Construct the select conditions for the model.
          */
-        $model->where(function ($q) use ($query, $conditionColumns, $relations){
+        $model->where(function($q) use ($query, $conditionColumns, $relations){
 
             if (count($conditionColumns)) 
             {
                 /**
                  * Use the first element in the model columns to construct the first condition.
                  */
-                $q->where(\DB::raw('LOWER(' . array_shift($conditionColumns) . ')'), 'LIKE', '%' . strtolower($query) . '%');
+                $q->where(\DB::raw('LOWER('.array_shift($conditionColumns).')'), 'LIKE', '%'.strtolower($query).'%');
             }
 
             /**
@@ -78,7 +78,7 @@ 
              */
             foreach ($conditionColumns as $column) 
             {
-                $q->orWhere(\DB::raw('LOWER(' . $column . ')'), 'LIKE', '%' . strtolower($query) . '%');
+                $q->orWhere(\DB::raw('LOWER('.$column.')'), 'LIKE', '%'.strtolower($query).'%');
             }
 
             /**
@@ -99,9 +99,9 @@ 
                     /**
                      * Construct the relation condition.
                      */
-                    $q->orWhereHas($relation, function ($subModel) use ($query, $relation){
+                    $q->orWhereHas($relation, function($subModel) use ($query, $relation){
 
-                        $subModel->where(function ($q) use ($query, $relation){
+                        $subModel->where(function($q) use ($query, $relation){
 
                             /**
                              * Get columns of the relation.
@@ -113,7 +113,7 @@ 
                                 /**
                                 * Use the first element in the relation model columns to construct the first condition.
                                  */
-                                $q->where(\DB::raw('LOWER(' . array_shift($subConditionColumns) . ')'), 'LIKE', '%' . strtolower($query) . '%');
+                                $q->where(\DB::raw('LOWER('.array_shift($subConditionColumns).')'), 'LIKE', '%'.strtolower($query).'%');
                             }
 
                             /**
@@ -121,7 +121,7 @@ 
                              */
                             foreach ($subConditionColumns as $subConditionColumn)
                             {
-                                $q->orWhere(\DB::raw('LOWER(' . $subConditionColumn . ')'), 'LIKE', '%' . strtolower($query) . '%');
+                                $q->orWhere(\DB::raw('LOWER('.$subConditionColumn.')'), 'LIKE', '%'.strtolower($query).'%');
                             } 
                         });
 
@@ -182,7 +182,7 @@ 
         $modelClass = $this->model;
         $relations  = [];
 
-        \DB::transaction(function () use (&$model, &$relations, $data, $saveLog, $modelClass) {
+        \DB::transaction(function() use (&$model, &$relations, $data, $saveLog, $modelClass) {
             /**
              * If the id is present in the data then select the model for updating,
              * else create new model.
@@ -191,7 +191,7 @@ 
             $model = array_key_exists('id', $data) ? $modelClass->lockForUpdate()->find($data['id']) : new $modelClass;
             if ( ! $model) 
             {
-                \ErrorHandler::notFound(class_basename($modelClass) . ' with id : ' . $data['id']);
+                \ErrorHandler::notFound(class_basename($modelClass).' with id : '.$data['id']);
             }
 
             /**
@@ -249,7 +249,7 @@ 
                                  */
                                 if ( ! $relationModel) 
                                 {
-                                    \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $val['id']);
+                                    \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
                                 }
 
                                 /**
@@ -260,7 +260,7 @@ 
                                     /**
                                      * Prevent the sub relations or attributes not in the fillable.
                                      */
-                                    if (gettype($val) !== 'object' && gettype($val) !== 'array' &&  array_search($attr, $relationModel->getFillable(), true) !== false)
+                                    if (gettype($val) !== 'object' && gettype($val) !== 'array' && array_search($attr, $relationModel->getFillable(), true) !== false)
                                     {
                                         $relationModel->$attr = $val;
                                     }
@@ -290,7 +290,7 @@ 
                                      */
                                     if ( ! $relationModel) 
                                     {
-                                        \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $value['id']);
+                                        \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$value['id']);
                                     }
 
                                     foreach ($value as $relationAttribute => $relationValue) 
@@ -434,7 +434,7 @@ 
         }
         else
         {
-            call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($data, $saveLog){
+            call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function($model) use ($data, $saveLog){
                 $model->update($data);
                 $saveLog ? \Logging::saveLog('update', class_basename($this->model), $this->getModel(), $model->id, $model) : false;
             });
@@ -453,11 +453,11 @@ 
     {
         if ($attribute == 'id') 
         {
-            \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) {
+            \DB::transaction(function() use ($value, $attribute, &$result, $saveLog) {
                 $model = $this->model->lockForUpdate()->find($value);
                 if ( ! $model) 
                 {
-                    \ErrorHandler::notFound(class_basename($this->model) . ' with id : ' . $value);
+                    \ErrorHandler::notFound(class_basename($this->model).' with id : '.$value);
                 }
                 
                 $model->delete();
@@ -466,8 +466,8 @@ 
         }
         else
         {
-            \DB::transaction(function () use ($value, $attribute, &$result, $saveLog) {
-                call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model){
+            \DB::transaction(function() use ($value, $attribute, &$result, $saveLog) {
+                call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function($model) {
                     $model->delete();
                     $saveLog ? \Logging::saveLog('delete', class_basename($this->model), $this->getModel(), $model->id, $model) : false;
                 });
@@ -504,7 +504,7 @@ 
     {
         $conditions = $this->constructConditions($conditions);
         $sort       = $desc ? 'desc' : 'asc';
-        return call_user_func_array("{$this->getModel()}::with",  array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns);
+        return call_user_func_array("{$this->getModel()}::with", array($relations))->whereRaw($conditions['conditionString'], $conditions['conditionValues'])->orderBy($sortBy, $sort)->get($columns);
     }
 
     /**
@@ -544,7 +544,7 @@ 
             $model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
         }
 
-        return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);;
+        return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns); ;
     }
 
     /**
@@ -560,7 +560,7 @@ 
 
         if ( ! $model) 
         {
-            \ErrorHandler::notFound(class_basename($this->model) . ' with id : ' . $id);
+            \ErrorHandler::notFound(class_basename($this->model).' with id : '.$id);
         }
 
         $model->restore();
@@ -579,12 +579,12 @@ 
         {
             if ($key == 'and') 
             {
-                $conditionString  .= str_replace('{op}', 'and', $this->constructConditions($value)['conditionString']) . ' {op} ';
+                $conditionString  .= str_replace('{op}', 'and', $this->constructConditions($value)['conditionString']).' {op} ';
                 $conditionValues   = array_merge($conditionValues, $this->constructConditions($value)['conditionValues']);
             }
             else if ($key == 'or')
             {
-                $conditionString  .= str_replace('{op}', 'or', $this->constructConditions($value)['conditionString']) . ' {op} ';
+                $conditionString  .= str_replace('{op}', 'or', $this->constructConditions($value)['conditionString']).' {op} ';
                 $conditionValues   = array_merge($conditionValues, $this->constructConditions($value)['conditionValues']);
             }
             else
@@ -609,20 +609,20 @@ 
                 
                 if (strtolower($operator) == 'between') 
                 {
-                    $conditionString  .= $key . ' >= ? and ';
+                    $conditionString  .= $key.' >= ? and ';
                     $conditionValues[] = $value1;
 
-                    $conditionString  .= $key . ' <= ? {op} ';
+                    $conditionString  .= $key.' <= ? {op} ';
                     $conditionValues[] = $value2;
                 }
                 else
                 {
-                    $conditionString  .= $key . ' ' . $operator . ' ? {op} ';
+                    $conditionString  .= $key.' '.$operator.' ? {op} ';
                     $conditionValues[] = $value;
                 }
             }
         }
-        $conditionString = '(' . rtrim($conditionString, '{op} ') . ')';
+        $conditionString = '('.rtrim($conditionString, '{op} ').')';
         return ['conditionString' => $conditionString, 'conditionValues' => $conditionValues];
     }
 

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

Doc Comments +16 added lines, -16 removed lines

@@ -61,7 +61,7 @@ 
     /**
      * Fetch all records with relations from model repository.
      * 
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function index() 
     {
@@ -76,7 +76,7 @@ 
      * Fetch the single object with relations from model repository.
      * 
      * @param  integer $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function find($id) 
     {
@@ -94,8 +94,8 @@ 
      * @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 search($query = '', $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -112,8 +112,8 @@ 
      * 
      * @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 findby(Request $request, $sortBy = 'created_at', $desc = 1) 
     {
@@ -129,7 +129,7 @@ 
      * condition.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function first(Request $request) 
     {
@@ -145,8 +145,8 @@ 
      * 
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
+     * @param  integer $desc
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function paginate($perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -164,8 +164,8 @@ 
      * @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 paginateby(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -180,7 +180,7 @@ 
      * Save the given model to repository.
      * 
      * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function save(Request $request) 
     {
@@ -213,7 +213,7 @@ 
      * Delete by the given id from model repository.
      * 
      * @param  integer  $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function delete($id) 
     {
@@ -229,8 +229,8 @@ 
      * @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
      */
     public function deleted(Request $request, $perPage = 15, $sortBy = 'created_at', $desc = 1) 
     {
@@ -241,7 +241,7 @@ 
      * Restore the deleted model.
      * 
      * @param  integer  $id
-     * @return \Illuminate\Http\Response
+     * @return \Illuminate\Http\JsonResponse|null
      */
     public function restore($id) 
     {

src/Modules/V1/Reporting/Database/Migrations/2016_01_19_112603_sampel_report.php

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
 	 */
 	public function up()
 	{
-		DB::statement( "CREATE VIEW admin_count AS  
+		DB::statement("CREATE VIEW admin_count AS  
 			select count(u.id)
 			from users u, groups g ,users_groups ug
 			where
@@ -39,6 +39,6 @@ 
 	 */
 	public function down()
 	{
-		DB::statement( "DROP VIEW IF EXISTS admin_count");
+		DB::statement("DROP VIEW IF EXISTS admin_count");
 	}
 }
\ No newline at end of file