SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Reporting/Http/Resources/View.php

Indentation +10 added lines, -10 removed lines

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

src/Modules/Reporting/Http/Controllers/ReportController.php

Indentation +33 added lines, -33 removed lines

@@ -9,40 +9,40 @@
 
 class ReportController extends BaseApiController
 {
-    /**
-     * Path of the model resource
-     *
-     * @var string
-     */
-    protected $modelResource = 'App\Modules\Reporting\Http\Resources\Report';
+	/**
+	 * Path of the model resource
+	 *
+	 * @var string
+	 */
+	protected $modelResource = 'App\Modules\Reporting\Http\Resources\Report';
 
-    /**
-     * 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'];
 
-    /**
-     * Init new object.
-     *
-     * @param   ReportService $service
-     * @return  void
-     */
-    public function __construct(ReportService $service)
-    {
-        parent::__construct($service);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   ReportService $service
+	 * @return  void
+	 */
+	public function __construct(ReportService $service)
+	{
+		parent::__construct($service);
+	}
 
-    /**
-     * Render the given servicert name with the given conditions.
-     *
-     * @param Request $request
-     * @param  string $reportName Name of the requested servicert
-     * @return \Illuminate\Http\Response
-     */
-    public function getReport(Request $request, $reportName)
-    {
-        return new ViewResource($this->service->getReport($reportName, $request->all(), $request->query('perPage')));
-    }
+	/**
+	 * Render the given servicert name with the given conditions.
+	 *
+	 * @param Request $request
+	 * @param  string $reportName Name of the requested servicert
+	 * @return \Illuminate\Http\Response
+	 */
+	public function getReport(Request $request, $reportName)
+	{
+		return new ViewResource($this->service->getReport($reportName, $request->all(), $request->query('perPage')));
+	}
 }

files/BroadcastServiceProvider.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 

 namespace App\Providers;

 

-use Illuminate\Support\ServiceProvider;

+use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Facades\Broadcast;

 

 class BroadcastServiceProvider extends ServiceProvider

Indentation +10 added lines, -10 removed lines

@@ -7,15 +7,15 @@
 

 class BroadcastServiceProvider extends ServiceProvider

 {

-    /**

-     * Bootstrap any application services.

-     *

-     * @return void

-     */

-    public function boot()

-    {

-        Broadcast::routes(['middleware' => ['auth:api']]);

+	/**

+	 * Bootstrap any application services.

+	 *

+	 * @return void

+	 */

+	public function boot()

+	{

+		Broadcast::routes(['middleware' => ['auth:api']]);

 

-        require base_path('routes/channels.php');

-    }

+		require base_path('routes/channels.php');

+	}

 }

files/Handler.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 

 namespace App\Exceptions;

 

-use Exception;

+use Exception;
 use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;

 

 class Handler extends ExceptionHandler

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
                 return \Response::json(['errors' => [$errors]], $exception->getStatusCode());

             } elseif ($exception instanceof \Illuminate\Validation\ValidationException) {

                 return \Response::json(['errors' => $exception->errors()], 422);

-            } elseif (! $exception instanceof \Symfony\Component\ErrorHandler\Error\FatalError) {

+            } elseif ( ! $exception instanceof \Symfony\Component\ErrorHandler\Error\FatalError) {

                 return parent::render($request, $exception);

             }

         }

Indentation +59 added lines, -59 removed lines

@@ -7,67 +7,67 @@
 

 class Handler extends ExceptionHandler

 {

-    /**

-     * A list of the exception types that are not reported.

-     *

-     * @var array

-     */

-    protected $dontReport = [

-        \League\OAuth2\Server\Exception\OAuthServerException::class,

-    ];

+	/**

+	 * A list of the exception types that are not reported.

+	 *

+	 * @var array

+	 */

+	protected $dontReport = [

+		\League\OAuth2\Server\Exception\OAuthServerException::class,

+	];

 

-    /**

-     * A list of the inputs that are never flashed for validation exceptions.

-     *

-     * @var array

-     */

-    protected $dontFlash = [

-        'password',

-        'password_confirmation',

-    ];

+	/**

+	 * A list of the inputs that are never flashed for validation exceptions.

+	 *

+	 * @var array

+	 */

+	protected $dontFlash = [

+		'password',

+		'password_confirmation',

+	];

 

-    /**

-     * Report or log an exception.

-     *

-     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.

-     *

-     * @param  \Exception  $exception

-     * @return void

-     */

-    public function report(Exception $exception)

-    {

-        parent::report($exception);

-    }

+	/**

+	 * Report or log an exception.

+	 *

+	 * This is a great spot to send exceptions to Sentry, Bugsnag, etc.

+	 *

+	 * @param  \Exception  $exception

+	 * @return void

+	 */

+	public function report(Exception $exception)

+	{

+		parent::report($exception);

+	}

 

-    /**

-     * Render an exception into an HTTP response.

-     *

-     * @param  \Illuminate\Http\Request  $request

-     * @param  \Exception  $exception

-     * @return \Illuminate\Http\Response

-     */

-    public function render($request, Exception $exception)

-    {

-        if ($request->wantsJson()) {

-            if ($exception instanceof \Illuminate\Auth\AuthenticationException) {

-                \Errors::unAuthorized();

-            }

-            if ($exception instanceof \Illuminate\Database\QueryException) {

-                \Errors::dbQueryError();

-            } elseif ($exception instanceof \predis\connection\connectionexception) {

-                \Errors::redisNotRunning();

-            } elseif ($exception instanceof \GuzzleHttp\Exception\ClientException) {

-                \Errors::connectionError();

-            } elseif ($exception instanceof \Symfony\Component\HttpKernel\Exception\HttpException) {

-                $errors = $exception->getStatusCode() === 404 ? 'not found' : $exception->getMessage();

-                return \Response::json(['errors' => [$errors]], $exception->getStatusCode());

-            } elseif ($exception instanceof \Illuminate\Validation\ValidationException) {

-                return \Response::json(['errors' => $exception->errors()], 422);

-            } elseif (! $exception instanceof \Symfony\Component\ErrorHandler\Error\FatalError) {

-                return parent::render($request, $exception);

-            }

-        }

+	/**

+	 * Render an exception into an HTTP response.

+	 *

+	 * @param  \Illuminate\Http\Request  $request

+	 * @param  \Exception  $exception

+	 * @return \Illuminate\Http\Response

+	 */

+	public function render($request, Exception $exception)

+	{

+		if ($request->wantsJson()) {

+			if ($exception instanceof \Illuminate\Auth\AuthenticationException) {

+				\Errors::unAuthorized();

+			}

+			if ($exception instanceof \Illuminate\Database\QueryException) {

+				\Errors::dbQueryError();

+			} elseif ($exception instanceof \predis\connection\connectionexception) {

+				\Errors::redisNotRunning();

+			} elseif ($exception instanceof \GuzzleHttp\Exception\ClientException) {

+				\Errors::connectionError();

+			} elseif ($exception instanceof \Symfony\Component\HttpKernel\Exception\HttpException) {

+				$errors = $exception->getStatusCode() === 404 ? 'not found' : $exception->getMessage();

+				return \Response::json(['errors' => [$errors]], $exception->getStatusCode());

+			} elseif ($exception instanceof \Illuminate\Validation\ValidationException) {

+				return \Response::json(['errors' => $exception->errors()], 422);

+			} elseif (! $exception instanceof \Symfony\Component\ErrorHandler\Error\FatalError) {

+				return parent::render($request, $exception);

+			}

+		}

         

-        return parent::render($request, $exception);

-    }

+		return parent::render($request, $exception);

+	}

 }

src/Modules/Core/Console/Commands/Stubs/Module/Http/Controllers/DummyController.php

Unused Use Statements -1 removed lines

@@ -4,7 +4,6 @@
 
 use App\Modules\Core\BaseClasses\BaseApiController;
 use App\Modules\DummyModule\Services\DummyService;
-use App\Modules\Core\Utl\CoreConfig;
 use App\Modules\DummyModule\Http\Requests\InsertDummy;
 use App\Modules\DummyModule\Http\Requests\UpdateDummy;
 

Indentation +48 added lines, -48 removed lines

@@ -10,57 +10,57 @@
 
 class DummyController extends BaseApiController
 {
-    /**
-     * Path of the model resource
-     *
-     * @var string
-     */
-    protected $modelResource = 'App\Modules\DummyModule\Http\Resources\DummyModel';
+	/**
+	 * Path of the model resource
+	 *
+	 * @var string
+	 */
+	protected $modelResource = 'App\Modules\DummyModule\Http\Resources\DummyModel';
 
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = [];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = [];
 
-    /**
-     * List of all route actions that the base api controller
-     * will skip login check for them.
-     * @var array
-     */
-    protected $skipLoginCheck = [];
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip login check for them.
+	 * @var array
+	 */
+	protected $skipLoginCheck = [];
 
-    /**
-     * Init new object.
-     *
-     * @param   DummyService $service
-     * @return  void
-     */
-    public function __construct(DummyService $service)
-    {
-        parent::__construct($service);
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   DummyService $service
+	 * @return  void
+	 */
+	public function __construct(DummyService $service)
+	{
+		parent::__construct($service);
+	}
 
-    /**
-     * Insert the given model to storage.
-     *
-     * @param InsertDummy $request
-     * @return \Illuminate\Http\Response
-     */
-    public function insert(InsertDummy $request)
-    {
-        return new $this->modelResource($this->service->save($request->all()));
-    }
+	/**
+	 * Insert the given model to storage.
+	 *
+	 * @param InsertDummy $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function insert(InsertDummy $request)
+	{
+		return new $this->modelResource($this->service->save($request->all()));
+	}
 
-    /**
-     * Update the given model to storage.
-     *
-     * @param UpdateDummy $request
-     * @return \Illuminate\Http\Response
-     */
-    public function update(UpdateDummy $request)
-    {
-        return new $this->modelResource($this->service->save($request->all()));
-    }
+	/**
+	 * Update the given model to storage.
+	 *
+	 * @param UpdateDummy $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function update(UpdateDummy $request)
+	{
+		return new $this->modelResource($this->service->save($request->all()));
+	}
 }

src/Modules/Core/Http/Middleware/UpdateLocaleAndTimezone.php

Doc Comments -1 removed lines

@@ -16,7 +16,6 @@
      *
      * @param   Session      $session
      * @param   Auth         $auth
-     * @param   Errors       $errors
      *
      * @return  void
      */

Indentation +44 added lines, -44 removed lines

@@ -8,53 +8,53 @@
 
 class UpdateLocaleAndTimezone
 {
-    protected $session;
-    protected $auth;
+	protected $session;
+	protected $auth;
     
-    /**
-     * Init new object.
-     *
-     * @param   Session      $session
-     * @param   Auth         $auth
-     * @param   Errors       $errors
-     *
-     * @return  void
-     */
-    public function __construct(Session $session, Auth $auth)
-    {
-        $this->session = $session;
-        $this->auth = $auth;
-    }
+	/**
+	 * Init new object.
+	 *
+	 * @param   Session      $session
+	 * @param   Auth         $auth
+	 * @param   Errors       $errors
+	 *
+	 * @return  void
+	 */
+	public function __construct(Session $session, Auth $auth)
+	{
+		$this->session = $session;
+		$this->auth = $auth;
+	}
 
-    /**
-     * Handle an incoming request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
-     */
-    public function handle($request, Closure $next)
-    {
-        $update = false;
-        $user   = $this->auth->user();
-        if ($user) {
-            $locale   = $this->session->get('locale');
-            $timezone = $this->session->get('time-zone');
-            if ($locale && $locale !== 'all' && $locale !== $user->locale) {
-                $user->locale = $locale;
-                $update       = true;
-            }
+	/**
+	 * Handle an incoming request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  \Closure  $next
+	 * @return mixed
+	 */
+	public function handle($request, Closure $next)
+	{
+		$update = false;
+		$user   = $this->auth->user();
+		if ($user) {
+			$locale   = $this->session->get('locale');
+			$timezone = $this->session->get('time-zone');
+			if ($locale && $locale !== 'all' && $locale !== $user->locale) {
+				$user->locale = $locale;
+				$update       = true;
+			}
     
-            if ($timezone && $timezone !== $user->timezone) {
-                $user->timezone = $timezone;
-                $update         = true;
-            }
+			if ($timezone && $timezone !== $user->timezone) {
+				$user->timezone = $timezone;
+				$update         = true;
+			}
     
-            if ($update) {
-                $user->save();
-            }
-        }
+			if ($update) {
+				$user->save();
+			}
+		}
 
-        return $next($request);
-    }
+		return $next($request);
+	}
 }

files/Kernel.php

Indentation +31 added lines, -31 removed lines

@@ -10,38 +10,38 @@
 

 class Kernel extends ConsoleKernel

 {

-    /**

-     * The Artisan commands provided by your application.

-     *

-     * @var array

-     */

-    protected $commands = [

-        GenerateDoc::class,

-        MakeNotificationsCommand::class,

-        MakeModuleCommand::class

-    ];

+	/**

+	 * The Artisan commands provided by your application.

+	 *

+	 * @var array

+	 */

+	protected $commands = [

+		GenerateDoc::class,

+		MakeNotificationsCommand::class,

+		MakeModuleCommand::class

+	];

 

-    /**

-     * Define the application's command schedule.

-     *

-     * @param  \Illuminate\Console\Scheduling\Schedule  $schedule

-     * @return void

-     */

-    protected function schedule(Schedule $schedule)

-    {

-        // $schedule->command('inspire')

-        //          ->hourly();

-    }

+	/**

+	 * Define the application's command schedule.

+	 *

+	 * @param  \Illuminate\Console\Scheduling\Schedule  $schedule

+	 * @return void

+	 */

+	protected function schedule(Schedule $schedule)

+	{

+		// $schedule->command('inspire')

+		//          ->hourly();

+	}

 

-    /**

-     * Register the commands for the application.

-     *

-     * @return void

-     */

-    protected function commands()

-    {

-        $this->load(__DIR__.'/Commands');

+	/**

+	 * Register the commands for the application.

+	 *

+	 * @return void

+	 */

+	protected function commands()

+	{

+		$this->load(__DIR__.'/Commands');

 

-        require base_path('routes/console.php');

-    }

+		require base_path('routes/console.php');

+	}

 }

files/HttpKernel.php

Indentation +73 added lines, -73 removed lines

@@ -6,81 +6,81 @@
 

 class Kernel extends HttpKernel

 {

-    /**

-     * The application's global HTTP middleware stack.

-     *

-     * These middleware are run during every request to your application.

-     *

-     * @var array

-     */

-    protected $middleware = [

-        \App\Http\Middleware\TrustProxies::class,

-        \App\Http\Middleware\CheckForMaintenanceMode::class,

-        \Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,

-        \App\Http\Middleware\TrimStrings::class,

-        \Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,

-    ];

+	/**

+	 * The application's global HTTP middleware stack.

+	 *

+	 * These middleware are run during every request to your application.

+	 *

+	 * @var array

+	 */

+	protected $middleware = [

+		\App\Http\Middleware\TrustProxies::class,

+		\App\Http\Middleware\CheckForMaintenanceMode::class,

+		\Illuminate\Foundation\Http\Middleware\ValidatePostSize::class,

+		\App\Http\Middleware\TrimStrings::class,

+		\Illuminate\Foundation\Http\Middleware\ConvertEmptyStringsToNull::class,

+	];

 

-    /**

-     * The application's route middleware groups.

-     *

-     * @var array

-     */

-    protected $middlewareGroups = [

-        'web' => [

-            \App\Http\Middleware\EncryptCookies::class,

-            \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,

-            \Illuminate\Session\Middleware\StartSession::class,

-            // \Illuminate\Session\Middleware\AuthenticateSession::class,

-            \Illuminate\View\Middleware\ShareErrorsFromSession::class,

-            \App\Http\Middleware\VerifyCsrfToken::class,

-            \Illuminate\Routing\Middleware\SubstituteBindings::class,

-        ],

+	/**

+	 * The application's route middleware groups.

+	 *

+	 * @var array

+	 */

+	protected $middlewareGroups = [

+		'web' => [

+			\App\Http\Middleware\EncryptCookies::class,

+			\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,

+			\Illuminate\Session\Middleware\StartSession::class,

+			// \Illuminate\Session\Middleware\AuthenticateSession::class,

+			\Illuminate\View\Middleware\ShareErrorsFromSession::class,

+			\App\Http\Middleware\VerifyCsrfToken::class,

+			\Illuminate\Routing\Middleware\SubstituteBindings::class,

+		],

 

-        'api' => [

-            'throttle:60,1',

-            \Illuminate\Routing\Middleware\SubstituteBindings::class,

-            \App\Modules\Core\Http\Middleware\SetSessions::class,

-            \App\Modules\Core\Http\Middleware\CheckPermissions::class,

-            \App\Modules\Core\Http\Middleware\UpdateLocaleAndTimezone::class,

-            \App\Modules\Core\Http\Middleware\SetRelations::class,

-        ],

-    ];

+		'api' => [

+			'throttle:60,1',

+			\Illuminate\Routing\Middleware\SubstituteBindings::class,

+			\App\Modules\Core\Http\Middleware\SetSessions::class,

+			\App\Modules\Core\Http\Middleware\CheckPermissions::class,

+			\App\Modules\Core\Http\Middleware\UpdateLocaleAndTimezone::class,

+			\App\Modules\Core\Http\Middleware\SetRelations::class,

+		],

+	];

 

-    /**

-     * The application's route middleware.

-     *

-     * These middleware may be assigned to groups or used individually.

-     *

-     * @var array

-     */

-    protected $routeMiddleware = [

-        'auth' => \App\Http\Middleware\Authenticate::class,

-        'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,

-        'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,

-        'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,

-        'can' => \Illuminate\Auth\Middleware\Authorize::class,

-        'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,

-        'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,

-        'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,

-        'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,

-        'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,

-    ];

+	/**

+	 * The application's route middleware.

+	 *

+	 * These middleware may be assigned to groups or used individually.

+	 *

+	 * @var array

+	 */

+	protected $routeMiddleware = [

+		'auth' => \App\Http\Middleware\Authenticate::class,

+		'auth.basic' => \Illuminate\Auth\Middleware\AuthenticateWithBasicAuth::class,

+		'bindings' => \Illuminate\Routing\Middleware\SubstituteBindings::class,

+		'cache.headers' => \Illuminate\Http\Middleware\SetCacheHeaders::class,

+		'can' => \Illuminate\Auth\Middleware\Authorize::class,

+		'guest' => \App\Http\Middleware\RedirectIfAuthenticated::class,

+		'password.confirm' => \Illuminate\Auth\Middleware\RequirePassword::class,

+		'signed' => \Illuminate\Routing\Middleware\ValidateSignature::class,

+		'throttle' => \Illuminate\Routing\Middleware\ThrottleRequests::class,

+		'verified' => \Illuminate\Auth\Middleware\EnsureEmailIsVerified::class,

+	];

 

-    /**

-     * The priority-sorted list of middleware.

-     *

-     * This forces non-global middleware to always be in the given order.

-     *

-     * @var array

-     */

-    protected $middlewarePriority = [

-        \Illuminate\Session\Middleware\StartSession::class,

-        \Illuminate\View\Middleware\ShareErrorsFromSession::class,

-        \App\Http\Middleware\Authenticate::class,

-        \Illuminate\Routing\Middleware\ThrottleRequests::class,

-        \Illuminate\Session\Middleware\AuthenticateSession::class,

-        \Illuminate\Routing\Middleware\SubstituteBindings::class,

-        \Illuminate\Auth\Middleware\Authorize::class,

-    ];

+	/**

+	 * The priority-sorted list of middleware.

+	 *

+	 * This forces non-global middleware to always be in the given order.

+	 *

+	 * @var array

+	 */

+	protected $middlewarePriority = [

+		\Illuminate\Session\Middleware\StartSession::class,

+		\Illuminate\View\Middleware\ShareErrorsFromSession::class,

+		\App\Http\Middleware\Authenticate::class,

+		\Illuminate\Routing\Middleware\ThrottleRequests::class,

+		\Illuminate\Session\Middleware\AuthenticateSession::class,

+		\Illuminate\Routing\Middleware\SubstituteBindings::class,

+		\Illuminate\Auth\Middleware\Authorize::class,

+	];

 }

files/channels.php

Indentation +1 added lines, -1 removed lines

@@ -12,5 +12,5 @@
 */

 

 Broadcast::channel('users.{id}', function ($user, $id) {

-    return (int) $user->id === (int) $id;

+	return (int) $user->id === (int) $id;

 });

Spacing +1 added lines, -1 removed lines

@@ -11,6 +11,6 @@
 |

 */

 

-Broadcast::channel('users.{id}', function ($user, $id) {

+Broadcast::channel('users.{id}', function($user, $id) {

     return (int) $user->id === (int) $id;

 });