SherifElfadaly / Laravel-Api-Skeleton

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

Indentation +24 added lines, -24 removed lines

@@ -7,30 +7,30 @@
 
 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) 
-    {
-        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) 
+	{
+		return \Response::json($this->repo->getReport($reportName, $request->all(), $perPage), 200);
+	}
 }

src/Modules/V1/Acl/Http/Controllers/UsersController.php

Indentation +278 added lines, -278 removed lines

@@ -8,282 +8,282 @@
 
 class UsersController 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               = 'users';
-
-    /**
-     * List of all route actions that the base api controller
-     * will skip permissions check for them.
-     * @var array
-     */
-    protected $skipPermissionCheck = ['account', 'logout', 'changePassword', 'saveProfile', 'account'];
-
-    /**
-     * List of all route actions that the base api controller
-     * will skip login check for them.
-     * @var array
-     */
-    protected $skipLoginCheck      = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken', 'confirmEmail', 'resendEmailConfirmation'];
-
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules     = [
-        'name'     => 'nullable|string', 
-        'email'    => 'required|email|unique:users,email,{id}', 
-        'password' => 'nullable|min:6'
-    ];
-
-    /**
-     * The loginProxy implementation.
-     * 
-     * @var \App\Modules\V1\Acl\Proxy\LoginProxy
-     */
-    protected $loginProxy;
-
-    public function __construct(LoginProxy $loginProxy)
-    {        
-        $this->loginProxy = $loginProxy;
-        parent::__construct();
-    }
-
-    /**
-     * Return the logged in user account.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function account()
-    {
-        return \Response::json($this->repo->account($this->relations), 200);
-    }
-
-    /**
-     * Block the user.
-     *
-     * @param  integer  $id Id of the user.
-     * @return \Illuminate\Http\Response
-     */
-    public function block($id)
-    {
-        return \Response::json($this->repo->block($id), 200);
-    }
-
-    /**
-     * Unblock the user.
-     *
-     * @param  integer  $id Id of the user.
-     * @return \Illuminate\Http\Response
-     */
-    public function unblock($id)
-    {
-        return \Response::json($this->repo->unblock($id), 200);
-    }
-
-    /**
-     * Logout the user.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function logout()
-    {
-        return \Response::json($this->loginProxy->logout(), 200);
-    }
-
-    /**
-     * Handle a registration request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function register(Request $request)
-    {
-        $this->validate($request, [
-            'name'     => 'nullable|string', 
-            'email'    => 'required|email|unique:users,email,{id}', 
-            'password' => 'required|min:6'
-            ]);
-
-        return \Response::json($this->repo->register($request->only('name', 'email', 'password')), 200);
-    }
-
-    /**
-     * Handle a login request to the application.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function login(Request $request)
-    {
-        $this->validate($request, [
-            'email'    => 'required|email', 
-            'password' => 'required|min:6', 
-            'admin'    => 'nullable|boolean'
-            ]);
-
-        return \Response::json($this->loginProxy->login($request->only('email', 'password'), $request->get('admin')), 200);
-    }
-
-    /**
-     * Handle a social login request of the none admin to the application.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function loginSocial(Request $request)
-    {
-        $this->validate($request, [
-            'auth_code'    => 'required_without:access_token',
-            'access_token' => 'required_without:auth_code',
-            'type'         => 'required|in:facebook,google'
-            ]);
-
-        return \Response::json($this->repo->loginSocial($request->only('auth_code', 'access_token', 'type')), 200);
-    }
-
-    /**
-     * Assign the given groups to the given user.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function assigngroups(Request $request)
-    {
-        $this->validate($request, [
-            'group_ids' => 'required|exists:groups,id', 
-            'user_id'   => 'required|exists:users,id'
-            ]);
-
-        return \Response::json($this->repo->assignGroups($request->get('user_id'), $request->get('group_ids')), 200);
-    }
-
-    /**
-     * Send a reset link to the given user.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function sendreset(Request $request)
-    {
-        $this->validate($request, ['email' => 'required|email']);
-
-        return \Response::json($this->repo->sendReset($request->only('email')), 200);
-    }
-
-    /**
-     * Reset the given user's password.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function resetpassword(Request $request)
-    {
-        $this->validate($request, [
-            'token'                 => 'required',
-            'email'                 => 'required|email',
-            'password'              => 'required|confirmed|min:6',
-            'password_confirmation' => 'required',
-        ]);
-
-        return \Response::json($this->repo->resetPassword($request->only('email', 'password', 'password_confirmation', 'token')), 200);
-    }
-
-    /**
-     * Change the logged in user password.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function changePassword(Request $request)
-    {
-        $this->validate($request, [
-            'old_password'          => 'required',
-            'password'              => 'required|confirmed|min:6',
-            'password_confirmation' => 'required',
-        ]);
-
-        return \Response::json($this->repo->changePassword($request->only('old_password', 'password', 'password_confirmation')), 200);
-    }
-
-    /**
-     * Confirm email using the confirmation code.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function confirmEmail(Request $request)
-    {
-        $this->validate($request, [
-            'confirmation_code' => 'required|string|exists:users,confirmation_code'
-        ]);
-
-        return \Response::json($this->repo->confirmEmail($request->only('confirmation_code')), 200);
-    }
-
-    /**
-     * Resend the email confirmation mail.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function resendEmailConfirmation(Request $request)
-    {
-        $this->validate($request, [
-            'email' => 'required|exists:users,email'
-        ]);
-
-        return \Response::json($this->repo->sendConfirmationEmail($request->only('email')), 200);
-    }
-
-    /**
-     * Refresh the expired login token.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function refreshtoken(Request $request)
-    {
-        $this->validate($request, [
-            'refreshtoken' => 'required',
-        ]);
-
-        return \Response::json($this->loginProxy->refreshtoken($request->get('refreshtoken')), 200);
-    }
-
-    /**
-     * Paginate all users with in the given group.
-     * 
-     * @param  \Illuminate\Http\Request  $request
-     * @param  string $groupName The name of the requested group.
-     * @param  integer $perPage  Number of rows per page default 15.
-     * @param  string  $sortBy   The name of the column to sort by.
-     * @param  boolean $desc     Sort ascending or descinding (1: desc, 0: asc).
-     * @return \Illuminate\Http\Response
-     */
-    public function group(Request $request, $groupName, $perPage = false, $sortBy = 'created_at', $desc = 1)
-    {
-        return \Response::json($this->repo->group($request->all(), $groupName, $this->relations, $perPage, $sortBy, $desc), 200);
-    }
-
-    /**
-     * Save the given data to the logged in user.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function saveProfile(Request $request) 
-    {
-        $this->validate($request, [
-            'profile_picture' => 'nullable|base64image',
-            'name'            => 'nullable|string', 
-            'email'           => 'required|email|unique:users,email,' . \Auth::id()
-        ]);
-
-        return \Response::json($this->repo->saveProfile($request->only('name', 'email', 'profile_picture')), 200);
-    }
+	/**
+	 * The name of the model that is used by the base api controller 
+	 * to preform actions like (add, edit ... etc).
+	 * @var string
+	 */
+	protected $model               = 'users';
+
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip permissions check for them.
+	 * @var array
+	 */
+	protected $skipPermissionCheck = ['account', 'logout', 'changePassword', 'saveProfile', 'account'];
+
+	/**
+	 * List of all route actions that the base api controller
+	 * will skip login check for them.
+	 * @var array
+	 */
+	protected $skipLoginCheck      = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken', 'confirmEmail', 'resendEmailConfirmation'];
+
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules     = [
+		'name'     => 'nullable|string', 
+		'email'    => 'required|email|unique:users,email,{id}', 
+		'password' => 'nullable|min:6'
+	];
+
+	/**
+	 * The loginProxy implementation.
+	 * 
+	 * @var \App\Modules\V1\Acl\Proxy\LoginProxy
+	 */
+	protected $loginProxy;
+
+	public function __construct(LoginProxy $loginProxy)
+	{        
+		$this->loginProxy = $loginProxy;
+		parent::__construct();
+	}
+
+	/**
+	 * Return the logged in user account.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function account()
+	{
+		return \Response::json($this->repo->account($this->relations), 200);
+	}
+
+	/**
+	 * Block the user.
+	 *
+	 * @param  integer  $id Id of the user.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function block($id)
+	{
+		return \Response::json($this->repo->block($id), 200);
+	}
+
+	/**
+	 * Unblock the user.
+	 *
+	 * @param  integer  $id Id of the user.
+	 * @return \Illuminate\Http\Response
+	 */
+	public function unblock($id)
+	{
+		return \Response::json($this->repo->unblock($id), 200);
+	}
+
+	/**
+	 * Logout the user.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function logout()
+	{
+		return \Response::json($this->loginProxy->logout(), 200);
+	}
+
+	/**
+	 * Handle a registration request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function register(Request $request)
+	{
+		$this->validate($request, [
+			'name'     => 'nullable|string', 
+			'email'    => 'required|email|unique:users,email,{id}', 
+			'password' => 'required|min:6'
+			]);
+
+		return \Response::json($this->repo->register($request->only('name', 'email', 'password')), 200);
+	}
+
+	/**
+	 * Handle a login request to the application.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function login(Request $request)
+	{
+		$this->validate($request, [
+			'email'    => 'required|email', 
+			'password' => 'required|min:6', 
+			'admin'    => 'nullable|boolean'
+			]);
+
+		return \Response::json($this->loginProxy->login($request->only('email', 'password'), $request->get('admin')), 200);
+	}
+
+	/**
+	 * Handle a social login request of the none admin to the application.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function loginSocial(Request $request)
+	{
+		$this->validate($request, [
+			'auth_code'    => 'required_without:access_token',
+			'access_token' => 'required_without:auth_code',
+			'type'         => 'required|in:facebook,google'
+			]);
+
+		return \Response::json($this->repo->loginSocial($request->only('auth_code', 'access_token', 'type')), 200);
+	}
+
+	/**
+	 * Assign the given groups to the given user.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function assigngroups(Request $request)
+	{
+		$this->validate($request, [
+			'group_ids' => 'required|exists:groups,id', 
+			'user_id'   => 'required|exists:users,id'
+			]);
+
+		return \Response::json($this->repo->assignGroups($request->get('user_id'), $request->get('group_ids')), 200);
+	}
+
+	/**
+	 * Send a reset link to the given user.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function sendreset(Request $request)
+	{
+		$this->validate($request, ['email' => 'required|email']);
+
+		return \Response::json($this->repo->sendReset($request->only('email')), 200);
+	}
+
+	/**
+	 * Reset the given user's password.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function resetpassword(Request $request)
+	{
+		$this->validate($request, [
+			'token'                 => 'required',
+			'email'                 => 'required|email',
+			'password'              => 'required|confirmed|min:6',
+			'password_confirmation' => 'required',
+		]);
+
+		return \Response::json($this->repo->resetPassword($request->only('email', 'password', 'password_confirmation', 'token')), 200);
+	}
+
+	/**
+	 * Change the logged in user password.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function changePassword(Request $request)
+	{
+		$this->validate($request, [
+			'old_password'          => 'required',
+			'password'              => 'required|confirmed|min:6',
+			'password_confirmation' => 'required',
+		]);
+
+		return \Response::json($this->repo->changePassword($request->only('old_password', 'password', 'password_confirmation')), 200);
+	}
+
+	/**
+	 * Confirm email using the confirmation code.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function confirmEmail(Request $request)
+	{
+		$this->validate($request, [
+			'confirmation_code' => 'required|string|exists:users,confirmation_code'
+		]);
+
+		return \Response::json($this->repo->confirmEmail($request->only('confirmation_code')), 200);
+	}
+
+	/**
+	 * Resend the email confirmation mail.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function resendEmailConfirmation(Request $request)
+	{
+		$this->validate($request, [
+			'email' => 'required|exists:users,email'
+		]);
+
+		return \Response::json($this->repo->sendConfirmationEmail($request->only('email')), 200);
+	}
+
+	/**
+	 * Refresh the expired login token.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function refreshtoken(Request $request)
+	{
+		$this->validate($request, [
+			'refreshtoken' => 'required',
+		]);
+
+		return \Response::json($this->loginProxy->refreshtoken($request->get('refreshtoken')), 200);
+	}
+
+	/**
+	 * Paginate all users with in the given group.
+	 * 
+	 * @param  \Illuminate\Http\Request  $request
+	 * @param  string $groupName The name of the requested group.
+	 * @param  integer $perPage  Number of rows per page default 15.
+	 * @param  string  $sortBy   The name of the column to sort by.
+	 * @param  boolean $desc     Sort ascending or descinding (1: desc, 0: asc).
+	 * @return \Illuminate\Http\Response
+	 */
+	public function group(Request $request, $groupName, $perPage = false, $sortBy = 'created_at', $desc = 1)
+	{
+		return \Response::json($this->repo->group($request->all(), $groupName, $this->relations, $perPage, $sortBy, $desc), 200);
+	}
+
+	/**
+	 * Save the given data to the logged in user.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function saveProfile(Request $request) 
+	{
+		$this->validate($request, [
+			'profile_picture' => 'nullable|base64image',
+			'name'            => 'nullable|string', 
+			'email'           => 'required|email|unique:users,email,' . \Auth::id()
+		]);
+
+		return \Response::json($this->repo->saveProfile($request->only('name', 'email', 'profile_picture')), 200);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -13,7 +13,7 @@ 
      * to preform actions like (add, edit ... etc).
      * @var string
      */
-    protected $model               = 'users';
+    protected $model = 'users';
 
     /**
      * List of all route actions that the base api controller
@@ -27,14 +27,14 @@ 
      * will skip login check for them.
      * @var array
      */
-    protected $skipLoginCheck      = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken', 'confirmEmail', 'resendEmailConfirmation'];
+    protected $skipLoginCheck = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword', 'refreshtoken', 'confirmEmail', 'resendEmailConfirmation'];
 
     /**
      * The validations rules used by the base api controller
      * to check before add.
      * @var array
      */
-    protected $validationRules     = [
+    protected $validationRules = [
         'name'     => 'nullable|string', 
         'email'    => 'required|email|unique:users,email,{id}', 
         'password' => 'nullable|min:6'
@@ -281,7 +281,7 @@ 
         $this->validate($request, [
             'profile_picture' => 'nullable|base64image',
             'name'            => 'nullable|string', 
-            'email'           => 'required|email|unique:users,email,' . \Auth::id()
+            'email'           => 'required|email|unique:users,email,'.\Auth::id()
         ]);
 
         return \Response::json($this->repo->saveProfile($request->only('name', 'email', 'profile_picture')), 200);