SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Core/Interfaces/BaseRepositoryInterface.php

Indentation +95 added lines, -95 removed lines

@@ -2,107 +2,107 @@
 
 interface BaseRepositoryInterface
 {
-    /**
-     * Fetch all records with relations from the storage.
-     *
-     * @param  array  $relations
-     * @param  array  $sortBy
-     * @param  array  $desc
-     * @param  array  $columns
-     * @return collection
-     */
-    public function all($relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from the storage.
+	 *
+	 * @param  array  $relations
+	 * @param  array  $sortBy
+	 * @param  array  $desc
+	 * @param  array  $columns
+	 * @return collection
+	 */
+	public function all($relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
     
-    /**
-     * Fetch all records with relations from storage in pages
-     * that matche the given query.
-     *
-     * @param  string  $query
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from storage in pages
+	 * that matche the given query.
+	 *
+	 * @param  string  $query
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-    /**
-     * Fetch all records with relations from storage in pages.
-     *
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from storage in pages.
+	 *
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
     
-    /**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-     /**
-      * Save the given model/models to the storage.
-      *
-      * @param  array $data
-      * @return mixed
-      */
-    public function save(array $data);
+	 /**
+	  * Save the given model/models to the storage.
+	  *
+	  * @param  array $data
+	  * @return mixed
+	  */
+	public function save(array $data);
 
-    /**
-     * Delete record from the storage based on the given
-     * condition.
-     *
-     * @param  var     $value condition value
-     * @param  string  $attribute condition column name
-     * @return integer affected rows
-     */
-    public function delete($value, $attribute = 'id');
+	/**
+	 * Delete record from the storage based on the given
+	 * condition.
+	 *
+	 * @param  var     $value condition value
+	 * @param  string  $attribute condition column name
+	 * @return integer affected rows
+	 */
+	public function delete($value, $attribute = 'id');
     
-    /**
-     * Fetch records from the storage based on the given
-     * id.
-     *
-     * @param  integer $id
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function find($id, $relations = [], $columns = array('*'));
+	/**
+	 * Fetch records from the storage based on the given
+	 * id.
+	 *
+	 * @param  integer $id
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function find($id, $relations = [], $columns = array('*'));
     
-    /**
-     * Fetch records from the storage based on the given
-     * condition.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-    /**
-     * Fetch the first record fro the storage based on the given
-     * condition.
-     *
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function first($conditions, $relations = [], $columns = array('*'));
+	/**
+	 * Fetch the first record fro the storage based on the given
+	 * condition.
+	 *
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function first($conditions, $relations = [], $columns = array('*'));
 }

src/Modules/Core/Http/Resources/General.php

Indentation +10 added lines, -10 removed lines

@@ -6,14 +6,14 @@
 
 class General extends JsonResource
 {
-    /**
-     * Transform the resource into an array.
-     *
-     * @param Request $request
-     * @return array
-     */
-    public function toArray($request)
-    {
-        return ['status' => $this->resource ?? 'success'];
-    }
+	/**
+	 * Transform the resource into an array.
+	 *
+	 * @param Request $request
+	 * @return array
+	 */
+	public function toArray($request)
+	{
+		return ['status' => $this->resource ?? 'success'];
+	}
 }

src/Modules/Core/Http/Requests/UpdateSetting.php

Indentation +21 added lines, -21 removed lines

@@ -6,26 +6,26 @@
 
 class UpdateSetting extends FormRequest
 {
-    /**
-     * Determine if the user is authorized to make this request.
-     *
-     * @return bool
-     */
-    public function authorize()
-    {
-        return true;
-    }
+	/**
+	 * Determine if the user is authorized to make this request.
+	 *
+	 * @return bool
+	 */
+	public function authorize()
+	{
+		return true;
+	}
 
-    /**
-     * Get the validation rules that apply to the request.
-     *
-     * @return array
-     */
-    public function rules()
-    {
-        return [
-            'id'    => 'required|exists:settings,id',
-            'value' => 'required|string'
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		return [
+			'id'    => 'required|exists:settings,id',
+			'value' => 'required|string'
+		];
+	}
 }

src/Modules/Core/Database/Seeds/AssignRelationsSeeder.php

Indentation +22 added lines, -22 removed lines

@@ -6,27 +6,27 @@
 
 class AssignRelationsSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-        $adminGroupId = \DB::table('groups')->where('name', 'admin')->select('id')->first()->id;
+	/**
+	 * Run the database seeds.
+	 *
+	 * @return void
+	 */
+	public function run()
+	{
+		$adminGroupId = \DB::table('groups')->where('name', 'admin')->select('id')->first()->id;
 
-        /**
-         * Assign the permissions to the admin group.
-         */
-        \DB::table('permissions')->orderBy('created_at', 'asc')->whereIn('model', ['setting'])->each(function ($permission) use ($adminGroupId) {
-            \DB::table('groups_permissions')->insert(
-                [
-                'permission_id' => $permission->id,
-                'group_id'      => $adminGroupId,
-                'created_at'    => \DB::raw('NOW()'),
-                'updated_at'    => \DB::raw('NOW()')
-                ]
-            );
-        });
-    }
+		/**
+		 * Assign the permissions to the admin group.
+		 */
+		\DB::table('permissions')->orderBy('created_at', 'asc')->whereIn('model', ['setting'])->each(function ($permission) use ($adminGroupId) {
+			\DB::table('groups_permissions')->insert(
+				[
+				'permission_id' => $permission->id,
+				'group_id'      => $adminGroupId,
+				'created_at'    => \DB::raw('NOW()'),
+				'updated_at'    => \DB::raw('NOW()')
+				]
+			);
+		});
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
         /**
          * Assign the permissions to the admin group.
          */
-        \DB::table('permissions')->orderBy('created_at', 'asc')->whereIn('model', ['setting'])->each(function ($permission) use ($adminGroupId) {
+        \DB::table('permissions')->orderBy('created_at', 'asc')->whereIn('model', ['setting'])->each(function($permission) use ($adminGroupId) {
             \DB::table('groups_permissions')->insert(
                 [
                 'permission_id' => $permission->id,

src/Modules/Core/Database/Seeds/ClearDataSeeder.php

Indentation +11 added lines, -11 removed lines

@@ -6,15 +6,15 @@
 
 class ClearDataSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-        $permissions = \DB::table('permissions')->whereIn('model', ['setting']);
-        \DB::table('groups_permissions')->whereIn('permission_id', $permissions->pluck('id'))->delete();
-        $permissions->delete();
-    }
+	/**
+	 * Run the database seeds.
+	 *
+	 * @return void
+	 */
+	public function run()
+	{
+		$permissions = \DB::table('permissions')->whereIn('model', ['setting']);
+		\DB::table('groups_permissions')->whereIn('permission_id', $permissions->pluck('id'))->delete();
+		$permissions->delete();
+	}
 }

src/Modules/Core/Database/Seeds/SettingsTableSeeder.php

Indentation +48 added lines, -48 removed lines

@@ -6,52 +6,52 @@
 
 class SettingsTableSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-        /**
-         * Insert the permissions related to settings table.
-         */
-        \DB::table('permissions')->insert(
-            [
-                /**
-                 * Settings model permissions.
-                 */
-                [
-                'name'       => 'index',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'find',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'update',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'delete',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'saveMany',
-                'model'      => 'setting',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ]
-            ]
-        );
-    }
+	/**
+	 * Run the database seeds.
+	 *
+	 * @return void
+	 */
+	public function run()
+	{
+		/**
+		 * Insert the permissions related to settings table.
+		 */
+		\DB::table('permissions')->insert(
+			[
+				/**
+				 * Settings model permissions.
+				 */
+				[
+				'name'       => 'index',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'find',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'update',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'delete',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'saveMany',
+				'model'      => 'setting',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				]
+			]
+		);
+	}
 }

src/Modules/Groups/Routes/api.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use Illuminate\Http\Request;
-
 /*
 |--------------------------------------------------------------------------
 | API Routes

Spacing +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
 |
 */
 
-Route::group(['prefix' => 'groups'], function () {
+Route::group(['prefix' => 'groups'], function() {
 
     Route::get('/', 'GroupController@index');
     Route::get('/{id}', 'GroupController@find');

Indentation +8 added lines, -8 removed lines

@@ -15,12 +15,12 @@
 
 Route::group(['prefix' => 'groups'], function () {
 
-    Route::get('/', 'GroupController@index');
-    Route::get('/{id}', 'GroupController@find');
-    Route::post('/', 'GroupController@insert');
-    Route::put('/', 'GroupController@update');
-    Route::delete('/{id}', 'GroupController@delete');
-    Route::get('list/deleted', 'GroupController@deleted');
-    Route::patch('restore/{id}', 'GroupController@restore');
-    Route::post('assign/permissions', 'GroupController@assignPermissions');
+	Route::get('/', 'GroupController@index');
+	Route::get('/{id}', 'GroupController@find');
+	Route::post('/', 'GroupController@insert');
+	Route::put('/', 'GroupController@update');
+	Route::delete('/{id}', 'GroupController@delete');
+	Route::get('list/deleted', 'GroupController@deleted');
+	Route::patch('restore/{id}', 'GroupController@restore');
+	Route::post('assign/permissions', 'GroupController@assignPermissions');
 });

src/Modules/Permissions/Routes/api.php

Unused Use Statements -2 removed lines

@@ -1,7 +1,5 @@
 <?php
 
-use Illuminate\Http\Request;
-
 /*
 |--------------------------------------------------------------------------
 | API Routes

Spacing +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
 |
 */
 
-Route::group(['prefix' => 'permissions'], function () {
+Route::group(['prefix' => 'permissions'], function() {
         
     Route::get('/', 'PermissionController@index');
     Route::get('/{id}', 'PermissionController@find');

Indentation +2 added lines, -2 removed lines

@@ -15,6 +15,6 @@
 
 Route::group(['prefix' => 'permissions'], function () {
         
-    Route::get('/', 'PermissionController@index');
-    Route::get('/{id}', 'PermissionController@find');
+	Route::get('/', 'PermissionController@index');
+	Route::get('/{id}', 'PermissionController@find');
 });

src/Modules/PushNotificationDevices/Repositories/PushNotificationDeviceRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
      * Register the given device to the logged in user.
      *
      * @param  array $data
-     * @return void
+     * @return boolean
      */
     public function registerDevice($data)
     {

Indentation +49 added lines, -49 removed lines

@@ -8,60 +8,60 @@
 
 class PushNotificationDeviceRepository extends BaseRepository
 {
-    /**
-     * Init new object.
-     *
-     * @param   PushNotificationDevice $model
-     * @return  void
-     */
-    public function __construct(PushNotificationDevice $model)
-    {
-        parent::__construct($model);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   PushNotificationDevice $model
+	 * @return  void
+	 */
+	public function __construct(PushNotificationDevice $model)
+	{
+		parent::__construct($model);
+	}
 
-    /**
-     * Register the given device to the logged in user.
-     *
-     * @param  array $data
-     * @return void
-     */
-    public function registerDevice($data)
-    {
-        $data['access_token'] = \Auth::user()->token();
-        $data['user_id']      = \Auth::id();
-        $device               = $this->model->where('device_token', $data['device_token'])->
-                                              where('user_id', $data['user_id'])->
-                                              first();
+	/**
+	 * Register the given device to the logged in user.
+	 *
+	 * @param  array $data
+	 * @return void
+	 */
+	public function registerDevice($data)
+	{
+		$data['access_token'] = \Auth::user()->token();
+		$data['user_id']      = \Auth::id();
+		$device               = $this->model->where('device_token', $data['device_token'])->
+											  where('user_id', $data['user_id'])->
+											  first();
 
-        if ($device) {
-            $data['id'] = $device->id;
-        }
+		if ($device) {
+			$data['id'] = $device->id;
+		}
 
-        return $this->save($data);
-    }
+		return $this->save($data);
+	}
 
-    /**
-     * Generate the given message data.
-     *
-     * @param  string $title
-     * @param  string $message
-     * @param  array  $data
-     * @return void
-     */
-    public function generateMessageData($title, $message, $data = [])
-    {
-        $optionBuilder       = new OptionsBuilder();
-        $notificationBuilder = new PayloadNotificationBuilder($title);
-        $dataBuilder         = new PayloadDataBuilder();
+	/**
+	 * Generate the given message data.
+	 *
+	 * @param  string $title
+	 * @param  string $message
+	 * @param  array  $data
+	 * @return void
+	 */
+	public function generateMessageData($title, $message, $data = [])
+	{
+		$optionBuilder       = new OptionsBuilder();
+		$notificationBuilder = new PayloadNotificationBuilder($title);
+		$dataBuilder         = new PayloadDataBuilder();
 
-        $optionBuilder->setTimeToLive(60 * 20);
-        $notificationBuilder->setBody($message);
-        $dataBuilder->addData($data);
+		$optionBuilder->setTimeToLive(60 * 20);
+		$notificationBuilder->setBody($message);
+		$dataBuilder->addData($data);
 
-        $options             = $optionBuilder->build();
-        $notification        = $notificationBuilder->build();
-        $data                = $dataBuilder->build();
+		$options             = $optionBuilder->build();
+		$notification        = $notificationBuilder->build();
+		$data                = $dataBuilder->build();
 
-        return compact('options', 'notification', 'data');
-    }
+		return compact('options', 'notification', 'data');
+	}
 }