SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Core/Http/Controllers/ApiDocumentController.php

Unused Use Statements -1 removed lines

@@ -2,7 +2,6 @@
 namespace App\Modules\Core\Http\Controllers;
 
 use App\Http\Controllers\Controller;
-use Illuminate\Http\Request;
 
 class ApiDocumentController extends Controller
 {

Spacing +7 added lines, -7 removed lines

@@ -20,27 +20,27 @@ 
 			],
 			[
 				'title'   => 'email equal John@Doe.com and user is blocked:',
-				'content' => ['and' => ['email' => 'John@Doe.com','blocked' => 1]]
+				'content' => ['and' => ['email' => 'John@Doe.com', 'blocked' => 1]]
 			],
 			[
 				'title'   => 'email equal John@Doe.com or user is blocked:',
-				'content' => ['or' => ['email' => 'John@Doe.com','blocked' => 1]]
+				'content' => ['or' => ['email' => 'John@Doe.com', 'blocked' => 1]]
 			],
 			[
 				'title'   => 'email contain John:',
-				'content' => ['email' => ['op' => 'like','val' => '%John%']]
+				'content' => ['email' => ['op' => 'like', 'val' => '%John%']]
 			],
 			[
 				'title'   => 'user created after 2016-10-25:',
-				'content' => ['created_at' => ['op' => '>','val' => '2016-10-25']]
+				'content' => ['created_at' => ['op' => '>', 'val' => '2016-10-25']]
 			],
 			[
 				'title'   => 'user created between 2016-10-20 and 2016-10-25:',
-				'content' => ['created_at' => ['op' => 'between','val1' => '2016-10-20','val2' => '2016-10-25']]
+				'content' => ['created_at' => ['op' => 'between', 'val1' => '2016-10-20', 'val2' => '2016-10-25']]
 			],
 			[
 				'title'   => 'user id in 1,2,3:',
-				'content' => ['id' => ['op' => 'in','val' => [1, 2, 3]]]
+				'content' => ['id' => ['op' => 'in', 'val' => [1, 2, 3]]]
 			],
 			[
 				'title'   => 'user name is null:',
@@ -52,7 +52,7 @@ 
 			],
 			[
 				'title'   => 'user has group admin:',
-				'content' => ['groups' => ['op' => 'has','val' => ['name' => 'Admin']]]
+				'content' => ['groups' => ['op' => 'has', 'val' => ['name' => 'Admin']]]
 			]
 		];
 

src/Modules/Notifications/Notifications/ResetPassword.php

Doc Comments +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
      * Get the notification's delivery channels.
      *
      * @param  mixed  $notifiable
-     * @return array
+     * @return string[]
      */
     public function via($notifiable)
     {

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 use Illuminate\Notifications\Notification;
 use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Notifications\Messages\MailMessage;
-use Illuminate\Notifications\Messages\BroadcastMessage;
 
 class ResetPassword extends Notification implements ShouldQueue
 {

Indentation +35 added lines, -35 removed lines

@@ -10,43 +10,43 @@
 
 class ResetPassword extends Notification implements ShouldQueue
 {
-    use Queueable;
+	use Queueable;
 
-    protected $token;
+	protected $token;
 
-    /**
-     * Create a new notification instance.
-     *
-     * @return void
-     */
-    public function __construct($token)
-    {
-        $this->token = $token;
-    }
+	/**
+	 * Create a new notification instance.
+	 *
+	 * @return void
+	 */
+	public function __construct($token)
+	{
+		$this->token = $token;
+	}
 
-    /**
-     * Get the notification's delivery channels.
-     *
-     * @param  mixed  $notifiable
-     * @return array
-     */
-    public function via($notifiable)
-    {
-        return ['mail'];
-    }
+	/**
+	 * Get the notification's delivery channels.
+	 *
+	 * @param  mixed  $notifiable
+	 * @return array
+	 */
+	public function via($notifiable)
+	{
+		return ['mail'];
+	}
 
-    /**
-     * Get the mail representation of the notification.
-     *
-     * @param  mixed  $notifiable
-     * @return \Illuminate\Notifications\Messages\MailMessage
-     */
-    public function toMail($notifiable)
-    {
-        return (new MailMessage)
-            ->subject('Reset passowrd')
-            ->line('Reset passowrd')
-            ->line('To reset your password click on the button below')
-            ->action('Reset password', config('skeleton.reset_password_url') . '/' . $this->token);
-    }
+	/**
+	 * Get the mail representation of the notification.
+	 *
+	 * @param  mixed  $notifiable
+	 * @return \Illuminate\Notifications\Messages\MailMessage
+	 */
+	public function toMail($notifiable)
+	{
+		return (new MailMessage)
+			->subject('Reset passowrd')
+			->line('Reset passowrd')
+			->line('To reset your password click on the button below')
+			->action('Reset password', config('skeleton.reset_password_url') . '/' . $this->token);
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -47,6 +47,6 @@
             ->subject('Reset passowrd')
             ->line('Reset passowrd')
             ->line('To reset your password click on the button below')
-            ->action('Reset password', config('skeleton.reset_password_url') . '/' . $this->token);
+            ->action('Reset password', config('skeleton.reset_password_url').'/'.$this->token);
     }
 }
\ No newline at end of file

src/Modules/Notifications/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  string $data
-     * @return void
+     * @return boolean
      */
     public function registerDevice($data)
     {

Indentation +52 added lines, -52 removed lines

@@ -7,56 +7,56 @@
 
 class PushNotificationDeviceRepository extends AbstractRepository
 {
-    /**
-    * Return the model full namespace.
-    * 
-    * @return string
-    */
-    protected function getModel()
-    {
-        return 'App\Modules\Notifications\PushNotificationDevice';
-    }
-
-    /**
-     * Register the given device to the logged in user.
-     *
-     * @param  string $data
-     * @return void
-     */
-    public function registerDevice($data)
-    {
-        $data['access_token'] = \Auth::user()->token();
-        $data['user_id']      = \Auth::id();
-        if ($device = $this->model->where('device_token', $data['device_token'])->where('user_id', $data['user_id'])->first()) 
-        {
-            $data['id'] = $device->id;
-        }
-
-        return $this->save($data);
-    }
-
-    /**
-     * Generate the given message data.
-     *
-     * @param  string $title
-     * @param  string $message
-     * @param  string $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);
-
-        $options             = $optionBuilder->build();
-        $notification        = $notificationBuilder->build();
-        $data                = $dataBuilder->build();
-
-        return compact('options', 'notification', 'data');
-    }
+	/**
+	 * Return the model full namespace.
+	 * 
+	 * @return string
+	 */
+	protected function getModel()
+	{
+		return 'App\Modules\Notifications\PushNotificationDevice';
+	}
+
+	/**
+	 * Register the given device to the logged in user.
+	 *
+	 * @param  string $data
+	 * @return void
+	 */
+	public function registerDevice($data)
+	{
+		$data['access_token'] = \Auth::user()->token();
+		$data['user_id']      = \Auth::id();
+		if ($device = $this->model->where('device_token', $data['device_token'])->where('user_id', $data['user_id'])->first()) 
+		{
+			$data['id'] = $device->id;
+		}
+
+		return $this->save($data);
+	}
+
+	/**
+	 * Generate the given message data.
+	 *
+	 * @param  string $title
+	 * @param  string $message
+	 * @param  string $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);
+
+		$options             = $optionBuilder->build();
+		$notification        = $notificationBuilder->build();
+		$data                = $dataBuilder->build();
+
+		return compact('options', 'notification', 'data');
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
         $notificationBuilder = new PayloadNotificationBuilder($title);
         $dataBuilder         = new PayloadDataBuilder();
 
-        $optionBuilder->setTimeToLive(60*20);
+        $optionBuilder->setTimeToLive(60 * 20);
         $notificationBuilder->setBody($message);
         $dataBuilder->addData($data);
 

src/Modules/Reporting/Report.php

Indentation +18 added lines, -18 removed lines

@@ -5,32 +5,32 @@
 
 class Report extends Model{
 
-    use SoftDeletes;
+	use SoftDeletes;
 	protected $table    = 'reports';
 	protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
 	protected $hidden   = ['deleted_at'];
 	protected $guarded  = ['id'];
 	protected $fillable = ['report_name', 'view_name'];
-    public $searchable  = ['report_name', 'view_name'];
+	public $searchable  = ['report_name', 'view_name'];
 
 	public function getCreatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
-    }
+	{
+		return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
+	}
 
-    public function getUpdatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
-    }
+	public function getUpdatedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
+	}
 
-    public function getDeletedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
-    }
+	public function getDeletedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->tz(\Session::get('time-zone'))->toDateTimeString();
+	}
     
-    public static function boot()
-    {
-        parent::boot();
-        parent::observe(\App::make('App\Modules\Reporting\ModelObservers\ReprotObserver'));
-    }
+	public static function boot()
+	{
+		parent::boot();
+		parent::observe(\App::make('App\Modules\Reporting\ModelObservers\ReprotObserver'));
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -3,7 +3,7 @@ 
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
-class Report extends Model{
+class Report extends Model {
 
     use SoftDeletes;
 	protected $table    = 'reports';
@@ -11,7 +11,7 @@ 
 	protected $hidden   = ['deleted_at'];
 	protected $guarded  = ['id'];
 	protected $fillable = ['report_name', 'view_name'];
-    public $searchable  = ['report_name', 'view_name'];
+    public $searchable = ['report_name', 'view_name'];
 
 	public function getCreatedAtAttribute($value)
     {

src/Modules/Reporting/Providers/RouteServiceProvider.php

Indentation +61 added lines, -61 removed lines

@@ -8,72 +8,72 @@
 class RouteServiceProvider extends ServiceProvider
 {
 	/**
-     * This namespace is applied to your controller routes.
-     *
-     * In addition, it is set as the URL generator's root namespace.
-     *
-     * @var string
-     */
-    protected $namespace = 'App\Modules\Reporting\Http\Controllers';
+	 * This namespace is applied to your controller routes.
+	 *
+	 * In addition, it is set as the URL generator's root namespace.
+	 *
+	 * @var string
+	 */
+	protected $namespace = 'App\Modules\Reporting\Http\Controllers';
 
-    /**
-     * Define your route model bindings, pattern filters, etc.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        //
+	/**
+	 * Define your route model bindings, pattern filters, etc.
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		//
 
-        parent::boot();
-    }
+		parent::boot();
+	}
 
-    /**
-     * Define the routes for the module.
-     *
-     * @return void
-     */
-    public function map()
-    {
-        $this->mapWebRoutes();
+	/**
+	 * Define the routes for the module.
+	 *
+	 * @return void
+	 */
+	public function map()
+	{
+		$this->mapWebRoutes();
 
-        $this->mapApiRoutes();
+		$this->mapApiRoutes();
 
-        //
-    }
+		//
+	}
 
-    /**
-     * Define the "web" routes for the module.
-     *
-     * These routes all receive session state, CSRF protection, etc.
-     *
-     * @return void
-     */
-    protected function mapWebRoutes()
-    {
-        Route::group([
-            'middleware' => 'web',
-            'namespace'  => $this->namespace,
-        ], function ($router) {
-            require module_path('reporting', 'Routes/web.php');
-        });
-    }
+	/**
+	 * Define the "web" routes for the module.
+	 *
+	 * These routes all receive session state, CSRF protection, etc.
+	 *
+	 * @return void
+	 */
+	protected function mapWebRoutes()
+	{
+		Route::group([
+			'middleware' => 'web',
+			'namespace'  => $this->namespace,
+		], function ($router) {
+			require module_path('reporting', 'Routes/web.php');
+		});
+	}
 
-    /**
-     * Define the "api" routes for the module.
-     *
-     * These routes are typically stateless.
-     *
-     * @return void
-     */
-    protected function mapApiRoutes()
-    {
-        Route::group([
-            'middleware' => 'api',
-            'namespace'  => $this->namespace,
-            'prefix'     => 'api',
-        ], function ($router) {
-            require module_path('reporting', 'Routes/api.php');
-        });
-    }
+	/**
+	 * Define the "api" routes for the module.
+	 *
+	 * These routes are typically stateless.
+	 *
+	 * @return void
+	 */
+	protected function mapApiRoutes()
+	{
+		Route::group([
+			'middleware' => 'api',
+			'namespace'  => $this->namespace,
+			'prefix'     => 'api',
+		], function ($router) {
+			require module_path('reporting', 'Routes/api.php');
+		});
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -54,7 +54,7 @@ 
         Route::group([
             'middleware' => 'web',
             'namespace'  => $this->namespace,
-        ], function ($router) {
+        ], function($router) {
             require module_path('reporting', 'Routes/web.php');
         });
     }
@@ -72,7 +72,7 @@ 
             'middleware' => 'api',
             'namespace'  => $this->namespace,
             'prefix'     => 'api',
-        ], function ($router) {
+        ], function($router) {
             require module_path('reporting', 'Routes/api.php');
         });
     }

src/Modules/Reporting/Providers/ModuleServiceProvider.php

Indentation +20 added lines, -20 removed lines

@@ -7,26 +7,26 @@
 class ModuleServiceProvider extends ServiceProvider
 {
 	/**
-     * Bootstrap the module services.
-     *
-     * @return void
-     */
-    public function boot()
-    {
-        $this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'reporting');
-        $this->loadViewsFrom(__DIR__.'/../Resources/Views', 'reporting');
+	 * Bootstrap the module services.
+	 *
+	 * @return void
+	 */
+	public function boot()
+	{
+		$this->loadTranslationsFrom(__DIR__.'/../Resources/Lang', 'reporting');
+		$this->loadViewsFrom(__DIR__.'/../Resources/Views', 'reporting');
         
-        $factory = app('Illuminate\Database\Eloquent\Factory');
-        $factory->load(__DIR__.'/../Database/Factories');
-    }
+		$factory = app('Illuminate\Database\Eloquent\Factory');
+		$factory->load(__DIR__.'/../Database/Factories');
+	}
 
-    /**
-     * Register the module services.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        $this->app->register(RouteServiceProvider::class);
-    }
+	/**
+	 * Register the module services.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		$this->app->register(RouteServiceProvider::class);
+	}
 }

src/Modules/Reporting/Database/Seeds/ReportsTableSeeder.php

Indentation +66 added lines, -66 removed lines

@@ -6,70 +6,70 @@
 
 class ReportsTableSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-    	/**
-         * Insert the permissions related to settings table.
-         */
-        \DB::table('permissions')->insert(
-        	[
-        		/**
-        		 * Reporting model permissions.
-        		 */
-	        	[
-	        	'name'       => 'find',
-	        	'model'      => 'reports',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'search',
-	        	'model'      => 'reports',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'list',
-	        	'model'      => 'reports',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'findby',
-	        	'model'      => 'reports',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'first',
-	        	'model'      => 'reports',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'paginate',
-	        	'model'      => 'reports',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'paginateby',
-	        	'model'      => 'reports',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'admin_count',
-	        	'model'      => 'reports',
-	        	'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(
+			[
+				/**
+				 * Reporting model permissions.
+				 */
+				[
+				'name'       => 'find',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'search',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'list',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'findby',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'first',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'paginate',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'paginateby',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'admin_count',
+				'model'      => 'reports',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				]
+			]
+		);
+	}
 }

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

Indentation +15 added lines, -15 removed lines

@@ -6,20 +6,20 @@ 
 
 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', ['reports'])->each(function ($permission) use ($adminGroupId) {
-        	\DB::table('groups_permissions')->insert(
+		/**
+		 * Assign the permissions to the admin group.
+		 */
+		\DB::table('permissions')->orderBy('created_at', 'asc')->whereIn('model', ['reports'])->each(function ($permission) use ($adminGroupId) {
+			\DB::table('groups_permissions')->insert(
 				[
 				'permission_id' => $permission->id,
 				'group_id'      => $adminGroupId,
@@ -27,6 +27,6 @@ 
 				'updated_at'    => \DB::raw('NOW()')
 				]
 			);
-        });
-    }
+		});
+	}
 }

Spacing +1 added lines, -1 removed lines

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

src/Modules/Reporting/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', ['reports']);
-        \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', ['reports']);
+		\DB::table('groups_permissions')->whereIn('permission_id', $permissions->pluck('id'))->delete();
+		$permissions->delete();
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -13,7 +13,7 @@
      */
     public function run()
     {
-        $permissions  = \DB::table('permissions')->whereIn('model', ['reports']);
+        $permissions = \DB::table('permissions')->whereIn('model', ['reports']);
         \DB::table('groups_permissions')->whereIn('permission_id', $permissions->pluck('id'))->delete();
         $permissions->delete();
     }