SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Acl/AclGroup.php

Spacing +3 added lines, -3 removed lines

@@ -3,7 +3,7 @@ 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-class AclGroup extends Model{
+class AclGroup extends Model {
 
     use SoftDeletes;
     protected $table    = 'groups';
@@ -29,12 +29,12 @@ 
 
     public function users()
     {
-        return $this->belongsToMany('\App\Modules\Acl\AclUser','users_groups','group_id','user_id')->whereNull('users_groups.deleted_at')->withTimestamps();
+        return $this->belongsToMany('\App\Modules\Acl\AclUser', 'users_groups', 'group_id', 'user_id')->whereNull('users_groups.deleted_at')->withTimestamps();
     }
 
     public function permissions()
     {
-        return $this->belongsToMany('\App\Modules\Acl\AclPermission','groups_permissions','group_id','permission_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
+        return $this->belongsToMany('\App\Modules\Acl\AclPermission', 'groups_permissions', 'group_id', 'permission_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
     }
 
     public static function boot()

src/Modules/Acl/Http/Controllers/GroupsController.php

Spacing +2 added lines, -2 removed lines

@@ -13,14 +13,14 @@
      * to preform actions like (add, edit ... etc).
      * @var string
      */
-    protected $model               = 'groups';
+    protected $model = 'groups';
 
     /**
      * The validations rules used by the base api controller
      * to check before add.
      * @var array
      */
-    protected $validationRules  = [
+    protected $validationRules = [
     'name' => 'required|string|max:100|unique:groups,name,{id}'
     ];
 

src/Modules/Acl/Database/Migrations/2016_01_05_130506_permissions.php

Spacing +4 added lines, -4 removed lines

@@ -12,15 +12,15 @@
 	 */
 	public function up()
 	{
-        Schema::create('permissions', function (Blueprint $table) {
+        Schema::create('permissions', function(Blueprint $table) {
             $table->increments('id');
-            $table->string('name',100);
-            $table->string('model',100);
+            $table->string('name', 100);
+            $table->string('model', 100);
             $table->softDeletes();
             $table->timestamps();
             $table->unique(array('name', 'model'));
         });
-        Schema::create('groups_permissions', function (Blueprint $table) {
+        Schema::create('groups_permissions', function(Blueprint $table) {
             $table->increments('id');
             $table->integer('group_id');
             $table->integer('permission_id');

src/Modules/Acl/Database/Migrations/2015_12_22_145819_groups.php

Spacing +3 added lines, -3 removed lines

@@ -12,14 +12,14 @@
 	 */
 	public function up()
 	{
-		Schema::create('groups', function (Blueprint $table) {
+		Schema::create('groups', function(Blueprint $table) {
             $table->increments('id');
-            $table->string('name',100)->unique();
+            $table->string('name', 100)->unique();
             $table->softDeletes();
             $table->timestamps();
         });
         
-        Schema::create('users_groups', function (Blueprint $table) {
+        Schema::create('users_groups', function(Blueprint $table) {
             $table->increments('id');
             $table->integer('user_id');
             $table->integer('group_id');

src/Modules/Acl/AclPermission.php

Spacing +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
     
     public function groups()
     {
-        return $this->belongsToMany('\App\Modules\Acl\AclGroup','groups_permissions','permission_id','group_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
+        return $this->belongsToMany('\App\Modules\Acl\AclGroup', 'groups_permissions', 'permission_id', 'group_id')->whereNull('groups_permissions.deleted_at')->withTimestamps();
     }
 
     public static function boot()

src/Modules/Reporting/Database/Migrations/2016_01_19_112350_reports.php

Spacing +3 added lines, -3 removed lines

@@ -12,10 +12,10 @@
 	 */
 	public function up()
 	{
-		Schema::create('reports', function (Blueprint $table) {
+		Schema::create('reports', function(Blueprint $table) {
 			$table->increments('id');
-			$table->string('report_name',100);
-			$table->string('view_name',100);
+			$table->string('report_name', 100);
+			$table->string('view_name', 100);
 			$table->softDeletes();
 			$table->timestamps();
         });

src/Modules/Acl/Repositories/UserRepository.php

Doc Comments +3 added lines, -4 removed lines

@@ -61,8 +61,8 @@ 
     /**
      * Check if the logged in user has the given group.
      * 
-     * @param  string  $groupName
-     * @param  integer $userId
+     * @param  integer $user
+     * @param string[] $groups
      * @return boolean
      */
     public function hasGroup($groups, $user = false)
@@ -244,7 +244,7 @@ 
      * Reset the given user's password.
      *
      * @param  array  $credentials
-     * @return array
+     * @return string|null
      */
     public function resetPassword($credentials)
     {
@@ -361,7 +361,6 @@ 
     /**
      * Save the given data to the logged in user.
      *
-     * @param  array $credentials
      * @return void
      */
     public function saveProfile($data) 

Spacing +4 added lines, -4 removed lines

@@ -28,7 +28,7 @@ 
         $user        = \Core::users()->find(\Auth::id(), $relations);
         foreach ($user->groups()->get() as $group)
         {
-            $group->permissions->each(function ($permission) use (&$permissions){
+            $group->permissions->each(function($permission) use (&$permissions){
                 $permissions[$permission->model][$permission->id] = $permission->name;
             });
         }
@@ -51,7 +51,7 @@ 
         $user        = $user ?: $this->find(\Auth::id(), ['groups.permissions']);
         $permissions = [];
 
-        $user->groups->pluck('permissions')->each(function ($permission) use (&$permissions, $model){
+        $user->groups->pluck('permissions')->each(function($permission) use (&$permissions, $model){
             $permissions = array_merge($permissions, $permission->where('model', $model)->pluck('name')->toArray()); 
         });
         
@@ -81,7 +81,7 @@ 
      */
     public function assignGroups($user_id, $group_ids)
     {
-        \DB::transaction(function () use ($user_id, $group_ids) {
+        \DB::transaction(function() use ($user_id, $group_ids) {
             $user = $this->find($user_id);
             $user->groups()->detach();
             $user->groups()->attach($group_ids);
@@ -248,7 +248,7 @@ 
      */
     public function resetPassword($credentials)
     {
-        $response = \Password::reset($credentials, function ($user, $password) {
+        $response = \Password::reset($credentials, function($user, $password) {
             $user->password = $password;
             $user->save();
         });

src/Modules/Core/AbstractRepositories/AbstractRepository.php

Doc Comments +8 added lines, -8 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
      */
@@ -164,7 +164,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -182,7 +182,7 @@ 
      * @param  integer $perPage
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -198,7 +198,7 @@ 
      * Save the given model to the storage.
      * 
      * @param  array   $data
-     * @return object
+     * @return boolean
      */
     public function save(array $data)
     {
@@ -516,7 +516,7 @@ 
      * id.
      * 
      * @param  integer $id
-     * @param  array   $relations
+     * @param  string[]   $relations
      * @param  array   $columns
      * @return object
      */
@@ -532,7 +532,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  array   $relations
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */
@@ -564,7 +564,7 @@ 
      * @param  array   $conditions array of conditions
      * @param  integer $perPage
      * @param  string  $sortBy
-     * @param  boolean $desc
+     * @param  integer $desc
      * @param  array   $columns
      * @return collection
      */

Spacing +36 added lines, -36 removed lines

@@ -63,11 +63,11 @@ 
         /**
          * 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)) 
             {
-                $column = 'LOWER(' . array_shift($conditionColumns) . ')';
+                $column = 'LOWER('.array_shift($conditionColumns).')';
                 if (str_contains($column, '->')) 
                 {
                     $column = $this->wrapJsonSelector($column);
@@ -76,7 +76,7 @@ 
                 /**
                  * Use the first element in the model columns to construct the first condition.
                  */
-                $q->where(\DB::raw($column), 'LIKE', '%' . strtolower($query) . '%');
+                $q->where(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
             }
 
             /**
@@ -84,13 +84,13 @@ 
              */
             foreach ($conditionColumns as $column) 
             {
-                $column = 'LOWER(' . $column . ')';
+                $column = 'LOWER('.$column.')';
                 if (str_contains($column, '->')) 
                 {
                     $column = $this->wrapJsonSelector($column);
                 }
 
-                $q->orWhere(\DB::raw($column), 'LIKE', '%' . strtolower($query) . '%');
+                $q->orWhere(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
             }
 
             /**
@@ -111,9 +111,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.
@@ -123,7 +123,7 @@ 
                             if (count($subConditionColumns)) 
                             {
 
-                                $column = 'LOWER(' . array_shift($subConditionColumns) . ')';
+                                $column = 'LOWER('.array_shift($subConditionColumns).')';
                                 if (str_contains($column, '->')) 
                                 {
                                     $column = $this->wrapJsonSelector($column);
@@ -132,7 +132,7 @@ 
                                 /**
                                 * Use the first element in the relation model columns to construct the first condition.
                                  */
-                                $q->where(\DB::raw($column), 'LIKE', '%' . strtolower($query) . '%');
+                                $q->where(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
                             }
 
                             /**
@@ -140,13 +140,13 @@ 
                              */
                             foreach ($subConditionColumns as $subConditionColumn)
                             {
-                                $column = 'LOWER(' . $subConditionColumn . ')';
+                                $column = 'LOWER('.$subConditionColumn.')';
                                 if (str_contains($column, '->')) 
                                 {
                                     $column = $this->wrapJsonSelector($column);
                                 }
                                 
-                                $q->orWhere(\DB::raw($column), 'LIKE', '%' . strtolower($query) . '%');
+                                $q->orWhere(\DB::raw($column), 'LIKE', '%'.strtolower($query).'%');
                             } 
                         });
 
@@ -206,7 +206,7 @@ 
         $modelClass = $this->model;
         $relations  = [];
 
-        \DB::transaction(function () use (&$model, &$relations, $data, $modelClass) {
+        \DB::transaction(function() use (&$model, &$relations, $data, $modelClass) {
             /**
              * If the id is present in the data then select the model for updating,
              * else create new model.
@@ -215,7 +215,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']);
             }
 
             /**
@@ -273,7 +273,7 @@ 
                                  */
                                 if ( ! $relationModel) 
                                 {
-                                    \ErrorHandler::notFound(class_basename($relationBaseModel) . ' with id : ' . $val['id']);
+                                    \ErrorHandler::notFound(class_basename($relationBaseModel).' with id : '.$val['id']);
                                 }
 
                                 /**
@@ -284,7 +284,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;
                                     }
@@ -314,7 +314,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) 
@@ -456,7 +456,7 @@ 
         }
         else
         {
-            call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model) use ($data){
+            call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function($model) use ($data){
                 $model->update($data);
             });
         }
@@ -474,11 +474,11 @@ 
     {
         if ($attribute == 'id') 
         {
-            \DB::transaction(function () use ($value, $attribute, &$result) {
+            \DB::transaction(function() use ($value, $attribute, &$result) {
                 $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();
@@ -486,8 +486,8 @@ 
         }
         else
         {
-            \DB::transaction(function () use ($value, $attribute, &$result) {
-                call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function ($model){
+            \DB::transaction(function() use ($value, $attribute, &$result) {
+                call_user_func_array("{$this->getModel()}::where", array($attribute, '=', $value))->lockForUpdate()->get()->each(function($model) {
                     $model->delete();
                 });
             });   
@@ -523,7 +523,7 @@ 
     {
         $conditions = $this->constructConditions($conditions, $this->model);
         $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);
     }
 
     /**
@@ -563,7 +563,7 @@ 
             $model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
         }
 
-        return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns);;
+        return $model->orderBy($sortBy, $sort)->paginate($perPage, $columns); ;
     }
 
     /**
@@ -578,7 +578,7 @@ 
 
         if ( ! $model) 
         {
-            \ErrorHandler::notFound(class_basename($this->model) . ' with id : ' . $id);
+            \ErrorHandler::notFound(class_basename($this->model).' with id : '.$id);
         }
 
         $model->restore();
@@ -603,13 +603,13 @@ 
             if ($key == 'and') 
             {
                 $conditions       = $this->constructConditions($value, $model);
-                $conditionString .= str_replace('{op}', 'and', $conditions['conditionString']) . ' {op} ';
+                $conditionString .= str_replace('{op}', 'and', $conditions['conditionString']).' {op} ';
                 $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
             }
             else if ($key == 'or')
             {
                 $conditions       = $this->constructConditions($value, $model);
-                $conditionString .= str_replace('{op}', 'or', $conditions['conditionString']) . ' {op} ';
+                $conditionString .= str_replace('{op}', 'or', $conditions['conditionString']).' {op} ';
                 $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
             }
             else
@@ -634,41 +634,41 @@ 
                 
                 if (strtolower($operator) == 'between') 
                 {
-                    $conditionString  .= $key . ' >= ? and ';
+                    $conditionString  .= $key.' >= ? and ';
                     $conditionValues[] = $value1;
 
-                    $conditionString  .= $key . ' <= ? {op} ';
+                    $conditionString  .= $key.' <= ? {op} ';
                     $conditionValues[] = $value2;
                 }
                 elseif (strtolower($operator) == 'in') 
                 {
                     $conditionValues  = array_merge($conditionValues, $value);
                     $inBindingsString = rtrim(str_repeat('?,', count($value)), ',');
-                    $conditionString .= $key . ' in (' . rtrim($inBindingsString, ',') . ') {op} ';
+                    $conditionString .= $key.' in ('.rtrim($inBindingsString, ',').') {op} ';
                 }
                 elseif (strtolower($operator) == 'null') 
                 {
-                    $conditionString .= $key . ' is null {op} ';
+                    $conditionString .= $key.' is null {op} ';
                 }
                 elseif (strtolower($operator) == 'not null') 
                 {
-                    $conditionString .= $key . ' is not null {op} ';
+                    $conditionString .= $key.' is not null {op} ';
                 }
                 elseif (strtolower($operator) == 'has') 
                 {
                     $sql              = $model->withTrashed()->has($key)->toSql();
                     $conditions       = $this->constructConditions($value, $model->$key()->getRelated());
-                    $conditionString .= rtrim(substr($sql, strpos($sql, 'exists')), ')') . ' and ' . $conditions['conditionString'] . ') {op} ';
+                    $conditionString .= rtrim(substr($sql, strpos($sql, 'exists')), ')').' and '.$conditions['conditionString'].') {op} ';
                     $conditionValues  = array_merge($conditionValues, $conditions['conditionValues']);
                 }
                 else
                 {
-                    $conditionString  .= $key . ' ' . $operator . ' ? {op} ';
+                    $conditionString  .= $key.' '.$operator.' ? {op} ';
                     $conditionValues[] = $value;
                 }
             }
         }
-        $conditionString = '(' . rtrim($conditionString, '{op} ') . ')';
+        $conditionString = '('.rtrim($conditionString, '{op} ').')';
         return ['conditionString' => $conditionString, 'conditionValues' => $conditionValues];
     }
 
@@ -684,11 +684,11 @@ 
         $value      = $removeLast === false ? $value : substr($value, 0, $removeLast);
         $path       = explode('->', $value);
         $field      = array_shift($path);
-        $result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function ($part) {
+        $result     = sprintf('%s->\'$.%s\'', $field, collect($path)->map(function($part) {
             return '"'.$part.'"';
         })->implode('.'));
         
-        return $removeLast === false ? $result : $result . ')';
+        return $removeLast === false ? $result : $result.')';
     }
 
     /**

src/Modules/Core/Console/Commands/GenerateDoc.php

Doc Comments +2 added lines, -1 removed lines

@@ -123,6 +123,7 @@ 
      * 
      * @param  array  &$route
      * @param  object $reflectionMethod]
+     * @param \ReflectionMethod $reflectionMethod
      * @return void
      */
     protected function processDocBlock(&$route, $reflectionMethod)
@@ -145,7 +146,7 @@ 
      * Generate post body for the given route.
      * 
      * @param  array  &$route
-     * @param  object $reflectionMethod
+     * @param  \ReflectionMethod $reflectionMethod
      * @param  array  $validationRules
      * @return void
      */

Spacing +9 added lines, -9 removed lines

@@ -45,7 +45,7 @@ 
             if ($route) 
             {
                 $actoinArray = explode('@', $route['action']);
-                if(array_get($actoinArray, 1, false))
+                if (array_get($actoinArray, 1, false))
                 {
                     $controller       = $actoinArray[0];
                     $method           = $actoinArray[1];
@@ -64,7 +64,7 @@ 
                     $route['response'] = $this->getResponseObject($classProperties['model'], $route['name'], $route['returnDocBlock']);
 
                     preg_match('/api\/([^#]+)\//iU', $route['uri'], $module);
-                    $docData['modules'][$module[1]][substr($route['prefix'], strlen('/api/' . $module[1] . '/') - 1)][] = $route;
+                    $docData['modules'][$module[1]][substr($route['prefix'], strlen('/api/'.$module[1].'/') - 1)][] = $route;
 
                     $this->getModels($classProperties['model'], $docData);   
                 }
@@ -82,7 +82,7 @@ 
      */
     protected function getRoutes()
     {
-        return collect(\Route::getRoutes())->map(function ($route) {
+        return collect(\Route::getRoutes())->map(function($route) {
             if (strpos($route->uri(), 'api') !== false) 
             {
                 return [
@@ -114,7 +114,7 @@ 
         ];
 
 
-        if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) 
+        if ( ! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) 
         {
             $route['headers']['Authorization'] = 'Bearer {token}';
         }
@@ -168,16 +168,16 @@ 
                 }
                 else
                 {
-                    $route['body'] = eval('return ' . str_replace(',\'.$request->get(\'id\')', ',{id}\'', $match[1]) . ';');
+                    $route['body'] = eval('return '.str_replace(',\'.$request->get(\'id\')', ',{id}\'', $match[1]).';');
                 }
 
                 foreach ($route['body'] as &$rule) 
                 {
-                    if(strpos($rule, 'unique'))
+                    if (strpos($rule, 'unique'))
                     {
                         $rule = substr($rule, 0, strpos($rule, 'unique') + 6);
                     }
-                    elseif(strpos($rule, 'exists'))
+                    elseif (strpos($rule, 'exists'))
                     {
                         $rule = substr($rule, 0, strpos($rule, 'exists') - 1);
                     }
@@ -250,10 +250,10 @@ 
             $model      = factory($modelClass)->make();
             $modelArr   = $model->toArray();
 
-            if ( $model->trans && ! $model->trans->count()) 
+            if ($model->trans && ! $model->trans->count()) 
             {
                 $modelArr['trans'] = [
-                    'en' => factory($modelClass . 'Translation')->make()->toArray()
+                    'en' => factory($modelClass.'Translation')->make()->toArray()
                 ];
             }