SherifElfadaly / Laravel-Api-Skeleton

src/Modules/V1/Reporting/Http/Controllers/ReportsController.php

Indentation +27 added lines, -27 removed lines

@@ -7,33 +7,33 @@
 
 class ReportsController extends BaseApiController
 {
-    /**
-     * The name of the model that is used by the base api controller 
-     * to preform actions like (add, edit ... etc).
-     * @var string
-     */
-    protected $model               = 'reports';
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model               = 'reports';
 
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = ['getReport'];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = ['getReport'];
 
-    /**
-     * Render the given report name with the given conditions.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  string  $reportName Name of the requested report
-     * @param  integer $perPage    Number of rows per page default all data.
-     * @return \Illuminate\Http\Response
-     */
-    public function getReport(Request $request, $reportName, $perPage = 0) 
-    {
-        if ($this->model) 
-        {
-            return \Response::json($this->repo->getReport($reportName, $request->all(), $perPage), 200);
-        }
-    }
+	/**
+	 * Render the given report name with the given conditions.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  string  $reportName Name of the requested report
+	 * @param  integer $perPage    Number of rows per page default all data.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function getReport(Request $request, $reportName, $perPage = 0) 
+	{
+		if ($this->model) 
+		{
+			return \Response::json($this->repo->getReport($reportName, $request->all(), $perPage), 200);
+		}
+	}
 }

src/Modules/V1/Notifications/PushNotificationDevice.php

Indentation +43 added lines, -43 removed lines

@@ -5,48 +5,48 @@
 
 class PushNotificationDevice extends Model{
 
-    use SoftDeletes;
-    protected $table    = 'push_notifications_devices';
-    protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
-    protected $hidden   = ['deleted_at', 'access_token'];
-    protected $guarded  = ['id'];
-    protected $fillable = ['device_token', 'user_id', 'access_token'];
-    public $searchable  = ['device_token'];
-
-    public function getCreatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
-    }
-
-    public function getUpdatedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
-    }
-
-    public function getDeletedAtAttribute($value)
-    {
-        return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
-    }
+	use SoftDeletes;
+	protected $table    = 'push_notifications_devices';
+	protected $dates    = ['created_at', 'updated_at', 'deleted_at'];
+	protected $hidden   = ['deleted_at', 'access_token'];
+	protected $guarded  = ['id'];
+	protected $fillable = ['device_token', 'user_id', 'access_token'];
+	public $searchable  = ['device_token'];
+
+	public function getCreatedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
+	}
+
+	public function getUpdatedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
+	}
+
+	public function getDeletedAtAttribute($value)
+	{
+		return \Carbon\Carbon::parse($value)->addHours(\Session::get('timeZoneDiff'))->toDateTimeString();
+	}
     
-    public function user()
-    {
-        return $this->belongsTo('App\Modules\V1\Acl\AclUser');
-    }
-
-    /**
-     * Encrypt the access_token attribute before
-     * saving it in the storage.
-     * 
-     * @param string $value 
-     */
-    public function setLoginTokenAttribute($value)
-    {
-        $this->attributes['access_token'] = encrypt($value);
-    }
-
-    public static function boot()
-    {
-        parent::boot();
-        parent::observe(\App::make('App\Modules\V1\Notifications\ModelObservers\PushNotificationDeviceObserver'));
-    }
+	public function user()
+	{
+		return $this->belongsTo('App\Modules\V1\Acl\AclUser');
+	}
+
+	/**
+	 * Encrypt the access_token attribute before
+	 * saving it in the storage.
+	 * 
+	 * @param string $value 
+	 */
+	public function setLoginTokenAttribute($value)
+	{
+		$this->attributes['access_token'] = encrypt($value);
+	}
+
+	public static function boot()
+	{
+		parent::boot();
+		parent::observe(\App::make('App\Modules\V1\Notifications\ModelObservers\PushNotificationDeviceObserver'));
+	}
 }

src/Modules/V1/Notifications/Http/Controllers/PushNotificationsDevicesController.php

Indentation +34 added lines, -34 removed lines

@@ -7,42 +7,42 @@
 
 class PushNotificationsDevicesController extends BaseApiController
 {
-    /**
-     * The name of the model that is used by the base api controller 
-     * to preform actions like (add, edit ... etc).
-     * @var string
-     */
-    protected $model            = 'pushNotificationDevices';
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model            = 'pushNotificationDevices';
 
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = ['registerDevice'];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = ['registerDevice'];
 
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules  = [
-    'device_token' => 'required|string|max:255',
-    'user_id'      => 'required|exists:users,id'
-    ];
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules  = [
+	'device_token' => 'required|string|max:255',
+	'user_id'      => 'required|exists:users,id'
+	];
 
-    /**
-     * Register the given device to the logged in user.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function registerDevice(Request $request)
-    {
-        $this->validate($request, [
-            'device_token' => 'required|string|max:255'
-            ]);
+	/**
+	 * Register the given device to the logged in user.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function registerDevice(Request $request)
+	{
+		$this->validate($request, [
+			'device_token' => 'required|string|max:255'
+			]);
 
-        return \Response::json($this->repo->registerDevice($request->all()), 200);
-    }
+		return \Response::json($this->repo->registerDevice($request->all()), 200);
+	}
 }

src/Modules/V1/Notifications/Repositories/NotificationRepository.php

Indentation +64 added lines, -64 removed lines

@@ -4,73 +4,73 @@
 
 class NotificationRepository extends AbstractRepository
 {
-    /**
-     * Return the model full namespace.
-     * 
-     * @return string
-     */
-    protected function getModel()
-    {
-        return 'App\Modules\V1\Notifications\Notification';
-    }
+	/**
+	 * Return the model full namespace.
+	 * 
+	 * @return string
+	 */
+	protected function getModel()
+	{
+		return 'App\Modules\V1\Notifications\Notification';
+	}
 
-    /**
-     * Retrieve all notifications of the logged in user.
-     * 
-     * @param  integer $perPage
-     * @return Collection
-     */
-    public function list($perPage)
-    {
-        return \Auth::user()->notifications()->paginate($perPage);
-    }
+	/**
+	 * Retrieve all notifications of the logged in user.
+	 * 
+	 * @param  integer $perPage
+	 * @return Collection
+	 */
+	public function list($perPage)
+	{
+		return \Auth::user()->notifications()->paginate($perPage);
+	}
 
-    /**
-     * Retrieve unread notifications of the logged in user.
-     * 
-     * @param  integer $perPage
-     * @return Collection
-     */
-    public function unread($perPage)
-    {
-        return \Auth::user()->unreadNotifications()->paginate($perPage);
-    }
+	/**
+	 * Retrieve unread notifications of the logged in user.
+	 * 
+	 * @param  integer $perPage
+	 * @return Collection
+	 */
+	public function unread($perPage)
+	{
+		return \Auth::user()->unreadNotifications()->paginate($perPage);
+	}
 
-    /**
-     * Mark the notification as read.
-     * 
-     * @param  integer  $id
-     * @return object
-     */
-    public function markAsRead($id)
-    {
-        if ($notification = \Auth::user()->unreadNotifications()->where('id', $id)) 
-        {
-            $notification->first()->markAsRead();
-        }
-    }
+	/**
+	 * Mark the notification as read.
+	 * 
+	 * @param  integer  $id
+	 * @return object
+	 */
+	public function markAsRead($id)
+	{
+		if ($notification = \Auth::user()->unreadNotifications()->where('id', $id)) 
+		{
+			$notification->first()->markAsRead();
+		}
+	}
 
-    /**
-     * Mark all notifications as read.
-     * 
-     * @return void
-     */
-    public function markAllAsRead()
-    {
-        \Auth::user()->unreadNotifications()->update(['read_at' => now()]);
-    }
+	/**
+	 * Mark all notifications as read.
+	 * 
+	 * @return void
+	 */
+	public function markAllAsRead()
+	{
+		\Auth::user()->unreadNotifications()->update(['read_at' => now()]);
+	}
 
-    /**
-     * Notify th given user with the given notification.
-     * 
-     * @param  collection $users
-     * @param  string     $notification
-     * @param  object     $notificationData
-     * @return void
-     */
-    public function notify($users, $notification, $notificationData = false)
-    {
-        $notification = 'App\Modules\V1\Notifications\Notifications\\' . $notification;
-        \Notification::send($users, new $notification($notificationData));
-    }
+	/**
+	 * Notify th given user with the given notification.
+	 * 
+	 * @param  collection $users
+	 * @param  string     $notification
+	 * @param  object     $notificationData
+	 * @return void
+	 */
+	public function notify($users, $notification, $notificationData = false)
+	{
+		$notification = 'App\Modules\V1\Notifications\Notifications\\' . $notification;
+		\Notification::send($users, new $notification($notificationData));
+	}
 }

src/Modules/V1/Notifications/Repositories/PushNotificationDeviceRepository.php

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\V1\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\V1\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');
+	}
 }

src/Modules/V1/Notifications/ModelObservers/NotificationObserver.php

Indentation +49 added lines, -49 removed lines

@@ -5,53 +5,53 @@
  */
 class NotificationObserver {
 
-    public function saving($model)
-    {
-        //
-    }
-
-    public function saved($model)
-    {
-        //
-    }
-
-    public function creating($model)
-    {
-        //
-    }
-
-    public function created($model)
-    {
-        //
-    }
-
-    public function updating($model)
-    {
-        //
-    }
-
-    public function updated($model)
-    {
-        //
-    }
-
-    public function deleting($model)
-    {
-        //
-    }
-
-    public function deleted($model)
-    {
-        //
-    }
-
-    public function restoring($model)
-    {
-        //
-    }
-
-    public function restored($model)
-    {
-        //
-    }
+	public function saving($model)
+	{
+		//
+	}
+
+	public function saved($model)
+	{
+		//
+	}
+
+	public function creating($model)
+	{
+		//
+	}
+
+	public function created($model)
+	{
+		//
+	}
+
+	public function updating($model)
+	{
+		//
+	}
+
+	public function updated($model)
+	{
+		//
+	}
+
+	public function deleting($model)
+	{
+		//
+	}
+
+	public function deleted($model)
+	{
+		//
+	}
+
+	public function restoring($model)
+	{
+		//
+	}
+
+	public function restored($model)
+	{
+		//
+	}
 }
\ No newline at end of file

src/Modules/V1/Notifications/Console/Commands/MakeNotificationsCommand.php

Indentation +60 added lines, -60 removed lines

@@ -4,65 +4,65 @@
 
 class MakeNotificationsCommand extends GeneratorCommand
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
-    protected $signature = 'make:module:notification
+	/**
+	 * The name and signature of the console command.
+	 *
+	 * @var string
+	 */
+	protected $signature = 'make:module:notification
         {name : The name of the notification class.}';
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
-    protected $description = 'Create a new module notification class';
-    /**
-     * String to store the command type.
-     *
-     * @var string
-     */
-    protected $type = 'Module notification';
-    /**
-     * Get the stub file for the generator.
-     *
-     * @return string
-     */
-    protected function getStub()
-    {
-        return __DIR__.'/stubs/notification.stub';
-    }
-    /**
-     * Get the destination class path.
-     *
-     * @param string $name
-     *
-     * @return string
-     */
-    protected function getPath($name)
-    {
-        return module_path('notifications', 'Notifications/'.$name.'.php');
-    }
-    /**
-     * Parse the name and format according to the root namespace.
-     *
-     * @param string $name
-     *
-     * @return string
-     */
-    protected function qualifyClass($name)
-    {
-        return $name;
-    }
-    /**
-     * Replace namespace in notification stub.
-     *
-     * @param string $name
-     *
-     * @return string
-     */
-    protected function getNamespace($name)
-    {
-        return module_class('notifications', 'Notifications');
-    }
+	/**
+	 * The console command description.
+	 *
+	 * @var string
+	 */
+	protected $description = 'Create a new module notification class';
+	/**
+	 * String to store the command type.
+	 *
+	 * @var string
+	 */
+	protected $type = 'Module notification';
+	/**
+	 * Get the stub file for the generator.
+	 *
+	 * @return string
+	 */
+	protected function getStub()
+	{
+		return __DIR__.'/stubs/notification.stub';
+	}
+	/**
+	 * Get the destination class path.
+	 *
+	 * @param string $name
+	 *
+	 * @return string
+	 */
+	protected function getPath($name)
+	{
+		return module_path('notifications', 'Notifications/'.$name.'.php');
+	}
+	/**
+	 * Parse the name and format according to the root namespace.
+	 *
+	 * @param string $name
+	 *
+	 * @return string
+	 */
+	protected function qualifyClass($name)
+	{
+		return $name;
+	}
+	/**
+	 * Replace namespace in notification stub.
+	 *
+	 * @param string $name
+	 *
+	 * @return string
+	 */
+	protected function getNamespace($name)
+	{
+		return module_class('notifications', 'Notifications');
+	}
 }
\ No newline at end of file

src/Modules/V1/Notifications/Database/Seeds/NotificationsTableSeeder.php

Indentation +42 added lines, -42 removed lines

@@ -6,46 +6,46 @@
 
 class NotificationsTableSeeder extends Seeder
 {
-    /**
-     * Run the database seeds.
-     *
-     * @return void
-     */
-    public function run()
-    {
-    	/**
-         * Insert the permissions related to settings table.
-         */
-        \DB::table('permissions')->insert(
-        	[
-        		/**
-        		 * notifications model permissions.
-        		 */
-	        	[
-	        	'name'       => 'all',
-	        	'model'      => 'notifications',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'unread',
-	        	'model'      => 'notifications',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'markAsRead',
-	        	'model'      => 'notifications',
-	        	'created_at' => \DB::raw('NOW()'),
-	        	'updated_at' => \DB::raw('NOW()')
-	        	],
-	        	[
-	        	'name'       => 'markAllAsRead',
-	        	'model'      => 'notifications',
-	        	'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(
+			[
+				/**
+				 * notifications model permissions.
+				 */
+				[
+				'name'       => 'all',
+				'model'      => 'notifications',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'unread',
+				'model'      => 'notifications',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'markAsRead',
+				'model'      => 'notifications',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				],
+				[
+				'name'       => 'markAllAsRead',
+				'model'      => 'notifications',
+				'created_at' => \DB::raw('NOW()'),
+				'updated_at' => \DB::raw('NOW()')
+				]
+			]
+		);
+	}
 }

src/Modules/V1/Notifications/Database/Factories/NotificationFactory.php

Indentation +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 $factory->define(App\Modules\V1\Notifications\Notification::class, function (Faker\Generator $faker) {
-    return [
+	return [
 		'type'            => '',
 		'notifiable_type' => '',
 		'notifiable_id'   => '',
@@ -9,5 +9,5 @@ 
 		'read_at'         => null,
 		'created_at'      => $faker->dateTimeBetween('-1 years', 'now'),
 		'updated_at'      => $faker->dateTimeBetween('-1 years', 'now')
-    ];
+	];
 });
\ No newline at end of file