SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Core/Console/Commands/Stubs/Module/DummyModel.php

Indentation +11 added lines, -11 removed lines

@@ -8,16 +8,16 @@
 
 class DummyModel extends Model
 {
-    use SoftDeletes;
-    protected $table = 'DummyTableName';
-    protected $dates = ['created_at', 'updated_at', 'deleted_at'];
-    protected $hidden = ['deleted_at'];
-    protected $guarded = ['id'];
-    public $fillable = []; // Add attributes here
+	use SoftDeletes;
+	protected $table = 'DummyTableName';
+	protected $dates = ['created_at', 'updated_at', 'deleted_at'];
+	protected $hidden = ['deleted_at'];
+	protected $guarded = ['id'];
+	public $fillable = []; // Add attributes here
     
-    public static function boot()
-    {
-        parent::boot();
-        DummyModel::observe(DummyObserver::class);
-    }
+	public static function boot()
+	{
+		parent::boot();
+		DummyModel::observe(DummyObserver::class);
+	}
 }

src/Modules/Core/Console/Commands/Stubs/Module/Database/Seeds/DummyTableSeeder.php

Indentation +60 added lines, -60 removed lines

@@ -6,64 +6,64 @@
 
 class DummyTableSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-        /**
-         * Insert the permissions related to DummyModelName table.
-         */
-        \DB::table('permissions')->insert(
-            [
-                /**
-                 * DummyModelName model permissions.
-                 */
-                [
-                'name'       => 'index',
-                'model'      => 'DummyModelName',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'show',
-                'model'      => 'DummyModelName',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'store',
-                'model'      => 'DummyModelName',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'update',
-                'model'      => 'DummyModelName',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'destroy',
-                'model'      => 'DummyModelName',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'deleted',
-                'model'      => 'DummyModelName',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ],
-                [
-                'name'       => 'restore',
-                'model'      => 'DummyModelName',
-                'created_at' => \DB::raw('NOW()'),
-                'updated_at' => \DB::raw('NOW()')
-                ]
-            ]
-        );
-    }
+	/**
+	 * Run the database seeds.
+	 *
+	 * @return void
+	 */
+	public function run()
+	{
+		/**
+		 * Insert the permissions related to DummyModelName table.
+		 */
+		\DB::table('permissions')->insert(
+			[
+				/**
+				 * DummyModelName model permissions.
+				 */
+				[
+				'name'       => 'index',
+				'model'      => 'DummyModelName',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'show',
+				'model'      => 'DummyModelName',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'store',
+				'model'      => 'DummyModelName',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'update',
+				'model'      => 'DummyModelName',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'destroy',
+				'model'      => 'DummyModelName',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'deleted',
+				'model'      => 'DummyModelName',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'restore',
+				'model'      => 'DummyModelName',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				]
+			]
+		);
+	}
 }

src/ApiSkeletonServiceProvider.php

Indentation +35 added lines, -35 removed lines

@@ -6,41 +6,41 @@
 

 class ApiSkeletonServiceProvider extends ServiceProvider

 {

-    /**

-     * Perform post-registration booting of services.

-     *

-     * @return void

-     */

-    public function boot()

-    {

-        $this->publishes([

-            __DIR__.'/Modules'                               => app_path('Modules'),

-            __DIR__.'/Modules/Core/Resources/Assets'         => base_path('public/doc/assets'),

-            __DIR__.'/../lang'                               => base_path('resources/lang'),

-            __DIR__.'/../files/Handler.php'                  => app_path('Exceptions/Handler.php'),

-            __DIR__.'/../files/AuthServiceProvider.php'      => app_path('Providers/AuthServiceProvider.php'),

-            __DIR__.'/../files/BroadcastServiceProvider.php' => app_path('Providers/BroadcastServiceProvider.php'),

-            __DIR__.'/../files/Kernel.php'                   => app_path('Console/Kernel.php'),

-            __DIR__.'/../files/HttpKernel.php'               => app_path('Http/Kernel.php'),

-            __DIR__.'/../files/channels.php'                 => base_path('routes/channels.php'),

-            __DIR__.'/../files/Jenkinsfile'                  => base_path('/Jenkinsfile'),

-            __DIR__.'/../files/phpcs.xml'                    => base_path('/phpcs.xml'),

-            __DIR__.'/../files/docker'                       => base_path('/docker'),

-            __DIR__.'/../files/.dockerignore'                => base_path('/.dockerignore'),

-        ]);

+	/**

+	 * Perform post-registration booting of services.

+	 *

+	 * @return void

+	 */

+	public function boot()

+	{

+		$this->publishes([

+			__DIR__.'/Modules'                               => app_path('Modules'),

+			__DIR__.'/Modules/Core/Resources/Assets'         => base_path('public/doc/assets'),

+			__DIR__.'/../lang'                               => base_path('resources/lang'),

+			__DIR__.'/../files/Handler.php'                  => app_path('Exceptions/Handler.php'),

+			__DIR__.'/../files/AuthServiceProvider.php'      => app_path('Providers/AuthServiceProvider.php'),

+			__DIR__.'/../files/BroadcastServiceProvider.php' => app_path('Providers/BroadcastServiceProvider.php'),

+			__DIR__.'/../files/Kernel.php'                   => app_path('Console/Kernel.php'),

+			__DIR__.'/../files/HttpKernel.php'               => app_path('Http/Kernel.php'),

+			__DIR__.'/../files/channels.php'                 => base_path('routes/channels.php'),

+			__DIR__.'/../files/Jenkinsfile'                  => base_path('/Jenkinsfile'),

+			__DIR__.'/../files/phpcs.xml'                    => base_path('/phpcs.xml'),

+			__DIR__.'/../files/docker'                       => base_path('/docker'),

+			__DIR__.'/../files/.dockerignore'                => base_path('/.dockerignore'),

+		]);

 

-        $this->publishes([

-            __DIR__.'/../files/auth.php' => config_path('auth.php'),

-        ], 'config');

-    }

+		$this->publishes([

+			__DIR__.'/../files/auth.php' => config_path('auth.php'),

+		], 'config');

+	}

 

-    /**

-     * Register any package services.

-     *

-     * @return void

-     */

-    public function register()

-    {

-        //

-    }

+	/**

+	 * Register any package services.

+	 *

+	 * @return void

+	 */

+	public function register()

+	{

+		//

+	}

 }

src/Modules/Notifications/Services/NotificationService.php

Doc Comments +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
      *
      * @param  collection $users
      * @param  string     $notification
-     * @param  Variadic   $notificationData
+     * @param  Variadic[]   $notificationData
      * @return void
      */
     public function notify($users, $notification, ...$notificationData)

Indentation +63 added lines, -63 removed lines

@@ -7,72 +7,72 @@
 
 class NotificationService extends BaseService
 {
-    /**
-     * Init new object.
-     *
-     * @param   NotificationRepository $repo
-     * @return  void
-     */
-    public function __construct(NotificationRepository $repo)
-    {
-        parent::__construct($repo);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   NotificationRepository $repo
+	 * @return  void
+	 */
+	public function __construct(NotificationRepository $repo)
+	{
+		parent::__construct($repo);
+	}
 
-    /**
-     * Retrieve all notifications of the logged in user.
-     *
-     * @param  integer $perPage
-     * @return Collection
-     */
-    public function my($perPage)
-    {
-        return $this->repo->my($perPage);
-    }
+	/**
+	 * Retrieve all notifications of the logged in user.
+	 *
+	 * @param  integer $perPage
+	 * @return Collection
+	 */
+	public function my($perPage)
+	{
+		return $this->repo->my($perPage);
+	}
 
-    /**
-     * Retrieve unread notifications of the logged in user.
-     *
-     * @param  integer $perPage
-     * @return Collection
-     */
-    public function unread($perPage)
-    {
-        return $this->repo->unread($perPage);
-    }
+	/**
+	 * Retrieve unread notifications of the logged in user.
+	 *
+	 * @param  integer $perPage
+	 * @return Collection
+	 */
+	public function unread($perPage)
+	{
+		return $this->repo->unread($perPage);
+	}
 
-    /**
-     * Mark the notification as read.
-     *
-     * @param  integer  $id
-     * @return object
-     */
-    public function markAsRead($id)
-    {
-        return $this->repo->markAsRead($id);
-    }
+	/**
+	 * Mark the notification as read.
+	 *
+	 * @param  integer  $id
+	 * @return object
+	 */
+	public function markAsRead($id)
+	{
+		return $this->repo->markAsRead($id);
+	}
 
-    /**
-     * Mark all notifications as read.
-     *
-     * @return void
-     */
-    public function markAllAsRead()
-    {
-        return $this->repo->markAllAsRead();
-    }
+	/**
+	 * Mark all notifications as read.
+	 *
+	 * @return void
+	 */
+	public function markAllAsRead()
+	{
+		return $this->repo->markAllAsRead();
+	}
 
-    /**
-     * Notify th given user with the given notification.
-     *
-     * @param  collection $users
-     * @param  string     $notification
-     * @param  Variadic   $notificationData
-     * @return void
-     */
-    public function notify($users, $notification, ...$notificationData)
-    {
-        $users = is_array($users) ? $this->userRepo->findBy(['id' => ['op' => 'in', 'val' => $users]]) : $users;
-        $notification = 'App\Modules\Notifications\Notifications\\'.$notification;
-        \Notification::send($users, new $notification(...$notificationData));
-    }
+	/**
+	 * Notify th given user with the given notification.
+	 *
+	 * @param  collection $users
+	 * @param  string     $notification
+	 * @param  Variadic   $notificationData
+	 * @return void
+	 */
+	public function notify($users, $notification, ...$notificationData)
+	{
+		$users = is_array($users) ? $this->userRepo->findBy(['id' => ['op' => 'in', 'val' => $users]]) : $users;
+		$notification = 'App\Modules\Notifications\Notifications\\'.$notification;
+		\Notification::send($users, new $notification(...$notificationData));
+	}
 }

src/Modules/PushNotificationDevices/Services/PushNotificationDeviceService.php

Unused Use Statements -3 removed lines

@@ -3,9 +3,6 @@
 namespace App\Modules\PushNotificationDevices\Services;
 
 use App\Modules\Core\BaseClasses\BaseService;
-use LaravelFCM\Message\OptionsBuilder;
-use LaravelFCM\Message\PayloadDataBuilder;
-use LaravelFCM\Message\PayloadNotificationBuilder;
 use App\Modules\PushNotificationDevices\Repositories\PushNotificationDeviceRepository;
 
 class PushNotificationDeviceService extends BaseService

Indentation +31 added lines, -31 removed lines

@@ -10,38 +10,38 @@
 
 class PushNotificationDeviceService extends BaseService
 {
-    /**
-     * Init new object.
-     *
-     * @param   PushNotificationDeviceRepository $repo
-     * @return  void
-     */
-    public function __construct(PushNotificationDeviceRepository $repo)
-    {
-        parent::__construct($repo);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   PushNotificationDeviceRepository $repo
+	 * @return  void
+	 */
+	public function __construct(PushNotificationDeviceRepository $repo)
+	{
+		parent::__construct($repo);
+	}
 
-    /**
-     * 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->repo->first([
-            'and' => [
-                'device_token' => $data['device_token'],
-                'user_id' => $data['user_id']
-                ]
-            ]);
+	/**
+	 * 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->repo->first([
+			'and' => [
+				'device_token' => $data['device_token'],
+				'user_id' => $data['user_id']
+				]
+			]);
 
-        if ($device) {
-            $data['id'] = $device->id;
-        }
+		if ($device) {
+			$data['id'] = $device->id;
+		}
 
-        return $this->repo->save($data);
-    }
+		return $this->repo->save($data);
+	}
 }

src/Modules/Reporting/Repositories/ReportRepository.php

Indentation +40 added lines, -40 removed lines

@@ -7,45 +7,45 @@
 
 class ReportRepository extends BaseRepository
 {
-    /**
-     * Init new object.
-     *
-     * @param   Report $model
-     * @return  void
-     */
-    public function __construct(Report $model)
-    {
-        parent::__construct($model);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   Report $model
+	 * @return  void
+	 */
+	public function __construct(Report $model)
+	{
+		parent::__construct($model);
+	}
 
-    /**
-     * Render the given report db view based on the given
-     * condition.
-     *
-     * @param  mixed   $report
-     * @param  array   $conditions
-     * @param  integer $perPage
-     * @return object
-     */
-    public function renderReport($report, $conditions = [], $perPage = 0)
-    {
-        $report = ! filter_var($report, FILTER_VALIDATE_INT) ? $report : $this->find($report);
-        /**
-         * Fetch data from the report based on the given conditions.
-         */
-        $report = \DB::table($report->view_name);
-        unset($conditions['page']);
-        if (count($conditions)) {
-            $conditions = $this->constructConditions($conditions, $this->model);
-            $report->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
-        }
-        /**
-         * Paginate or all data.
-         */
-        if ($perPage) {
-            return $report->paginate($perPage);
-        } else {
-            return $report->get();
-        }
-    }
+	/**
+	 * Render the given report db view based on the given
+	 * condition.
+	 *
+	 * @param  mixed   $report
+	 * @param  array   $conditions
+	 * @param  integer $perPage
+	 * @return object
+	 */
+	public function renderReport($report, $conditions = [], $perPage = 0)
+	{
+		$report = ! filter_var($report, FILTER_VALIDATE_INT) ? $report : $this->find($report);
+		/**
+		 * Fetch data from the report based on the given conditions.
+		 */
+		$report = \DB::table($report->view_name);
+		unset($conditions['page']);
+		if (count($conditions)) {
+			$conditions = $this->constructConditions($conditions, $this->model);
+			$report->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
+		}
+		/**
+		 * Paginate or all data.
+		 */
+		if ($perPage) {
+			return $report->paginate($perPage);
+		} else {
+			return $report->get();
+		}
+	}
 }

src/Modules/Users/Http/Requests/Register.php

Indentation +22 added lines, -22 removed lines

@@ -6,27 +6,27 @@
 
 class Register 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 [
-            'name'     => 'nullable|string',
-            'email'    => 'required|email|unique:users,email',
-            'password' => 'required|min:6'
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		return [
+			'name'     => 'nullable|string',
+			'email'    => 'required|email|unique:users,email',
+			'password' => 'required|min:6'
+		];
+	}
 }

src/Modules/Users/Http/Requests/AssignRoles.php

Indentation +21 added lines, -21 removed lines

@@ -6,26 +6,26 @@
 
 class AssignRoles 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 [
-            'role_ids' => 'required|array',
-            'role_ids.*' => 'required|exists:roles,id'
-        ];
-    }
+	/**
+	 * Get the validation rules that apply to the request.
+	 *
+	 * @return array
+	 */
+	public function rules()
+	{
+		return [
+			'role_ids' => 'required|array',
+			'role_ids.*' => 'required|exists:roles,id'
+		];
+	}
 }

src/Modules/Users/AclUser.php

Indentation +107 added lines, -107 removed lines

@@ -12,112 +12,112 @@
 
 class AclUser extends User
 {
-    use SoftDeletes, HasApiTokens;
-    protected $table = 'users';
-    protected $dates = ['created_at', 'updated_at', 'deleted_at'];
-    protected $hidden = ['password', 'remember_token', 'deleted_at'];
-    protected $guarded = ['id'];
-    public $fillable = ['profile_picture', 'name', 'email', 'password', 'locale', 'timezone', 'blocked', 'confirmed'];
-
-    /**
-     * Encrypt the password attribute before
-     * saving it in the storage.
-     *
-     * @param string $value
-     */
-    public function setPasswordAttribute($value)
-    {
-        $this->attributes['password'] = \Hash::make($value);
-    }
-
-    /**
-     * Get the entity's notifications.
-     */
-    public function notifications()
-    {
-        return $this->morphMany(Notification::class, 'notifiable')->orderBy('created_at', 'desc');
-    }
-
-    /**
-     * Get the entity's read notifications.
-     */
-    public function readNotifications()
-    {
-        return $this->notifications()->whereNotNull('read_at');
-    }
-
-    /**
-     * Get the entity's unread notifications.
-     */
-    public function unreadNotifications()
-    {
-        return $this->notifications()->whereNull('read_at');
-    }
-
-    public function roles()
-    {
-        return $this->belongsToMany(Role::class, 'role_user', 'user_id', 'role_id')->whereNull('role_user.deleted_at')->withTimestamps();
-    }
-
-    public function oauthClients()
-    {
-        return $this->hasMany(OauthClient::class, 'user_id');
-    }
-
-    public function setProfilePictureAttribute($value) {
-        $this->attributes['profile_picture'] = \Media::uploadImageBas64($value, 'users/profile_pictures');
-    }
-
-    /**
-     * Return fcm device tokens that will be used in sending fcm notifications.
-     *
-     * @return array
-     */
-    public function routeNotificationForFCM()
-    {
-        $devices = \Core::pushNotificationDevices()->findBy(['user_id' => $this->id]);
-        $tokens  = [];
-
-        foreach ($devices as $device) {
-            if (\Core::oauthClients()->accessTokenExpiredOrRevoked($device->access_token)) {
-                $device->forceDelete();
-                continue;
-            }
-
-            $tokens[] = $device->device_token;
-        }
-
-        return $tokens;
-    }
-
-    /**
-     * The channels the user receives notification broadcasts on.
-     *
-     * @return string
-     */
-    public function receivesBroadcastNotificationsOn()
-    {
-        return 'users.'.$this->id;
-    }
-
-    /**
-     * Custom password validation.
-     *
-     * @param  string $password
-     * @return boolean
-     */
-    public function validateForPassportPasswordGrant($password)
-    {
-        if ($password == config('user.social_pass')) {
-            return true;
-        }
-
-        return \Hash::check($password, $this->password);
-    }
+	use SoftDeletes, HasApiTokens;
+	protected $table = 'users';
+	protected $dates = ['created_at', 'updated_at', 'deleted_at'];
+	protected $hidden = ['password', 'remember_token', 'deleted_at'];
+	protected $guarded = ['id'];
+	public $fillable = ['profile_picture', 'name', 'email', 'password', 'locale', 'timezone', 'blocked', 'confirmed'];
+
+	/**
+	 * Encrypt the password attribute before
+	 * saving it in the storage.
+	 *
+	 * @param string $value
+	 */
+	public function setPasswordAttribute($value)
+	{
+		$this->attributes['password'] = \Hash::make($value);
+	}
+
+	/**
+	 * Get the entity's notifications.
+	 */
+	public function notifications()
+	{
+		return $this->morphMany(Notification::class, 'notifiable')->orderBy('created_at', 'desc');
+	}
+
+	/**
+	 * Get the entity's read notifications.
+	 */
+	public function readNotifications()
+	{
+		return $this->notifications()->whereNotNull('read_at');
+	}
+
+	/**
+	 * Get the entity's unread notifications.
+	 */
+	public function unreadNotifications()
+	{
+		return $this->notifications()->whereNull('read_at');
+	}
+
+	public function roles()
+	{
+		return $this->belongsToMany(Role::class, 'role_user', 'user_id', 'role_id')->whereNull('role_user.deleted_at')->withTimestamps();
+	}
+
+	public function oauthClients()
+	{
+		return $this->hasMany(OauthClient::class, 'user_id');
+	}
+
+	public function setProfilePictureAttribute($value) {
+		$this->attributes['profile_picture'] = \Media::uploadImageBas64($value, 'users/profile_pictures');
+	}
+
+	/**
+	 * Return fcm device tokens that will be used in sending fcm notifications.
+	 *
+	 * @return array
+	 */
+	public function routeNotificationForFCM()
+	{
+		$devices = \Core::pushNotificationDevices()->findBy(['user_id' => $this->id]);
+		$tokens  = [];
+
+		foreach ($devices as $device) {
+			if (\Core::oauthClients()->accessTokenExpiredOrRevoked($device->access_token)) {
+				$device->forceDelete();
+				continue;
+			}
+
+			$tokens[] = $device->device_token;
+		}
+
+		return $tokens;
+	}
+
+	/**
+	 * The channels the user receives notification broadcasts on.
+	 *
+	 * @return string
+	 */
+	public function receivesBroadcastNotificationsOn()
+	{
+		return 'users.'.$this->id;
+	}
+
+	/**
+	 * Custom password validation.
+	 *
+	 * @param  string $password
+	 * @return boolean
+	 */
+	public function validateForPassportPasswordGrant($password)
+	{
+		if ($password == config('user.social_pass')) {
+			return true;
+		}
+
+		return \Hash::check($password, $this->password);
+	}
     
-    public static function boot()
-    {
-        parent::boot();
-        AclUser::observe(AclUserObserver::class);
-    }
+	public static function boot()
+	{
+		parent::boot();
+		AclUser::observe(AclUserObserver::class);
+	}
 }