SherifElfadaly / Laravel-Api-Skeleton

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

Doc Comments +1 added lines, -1 removed lines

@@ -18,7 +18,7 @@
      * Set the notification notified to true.
      * 
      * @param  integer  $id
-     * @return object
+     * @return boolean
      */
     public function notified($id)
     {

Indentation +18 added lines, -18 removed lines

@@ -15,23 +15,23 @@
 	}
 
 	/**
-     * Set the notification notified to true.
-     * 
-     * @param  integer  $id
-     * @return object
-     */
-    public function notified($id)
-    {
-        return $this->save(['id' => $id, 'notified' => 1]);
-    }
+	 * Set the notification notified to true.
+	 * 
+	 * @param  integer  $id
+	 * @return object
+	 */
+	public function notified($id)
+	{
+		return $this->save(['id' => $id, 'notified' => 1]);
+	}
 
-    /**
-     * Set the notification notified to all.
-     * 
-     * @return void
-     */
-    public function notifyAll()
-    {
-        $this->update(false, ['notified' => 1], 'notified');
-    }
+	/**
+	 * Set the notification notified to all.
+	 * 
+	 * @return void
+	 */
+	public function notifyAll()
+	{
+		$this->update(false, ['notified' => 1], 'notified');
+	}
 }

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

Spacing +3 added lines, -3 removed lines

@@ -12,7 +12,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
@@ -26,14 +26,14 @@ 
      * will skip login check for them.
      * @var array
      */
-    protected $skipLoginCheck      = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword'];
+    protected $skipLoginCheck = ['login', 'loginSocial', 'register', 'sendreset', 'resetpassword'];
 
     /**
      * The validations rules used by the base api controller
      * to check before add.
      * @var array
      */
-    protected $validationRules     = [
+    protected $validationRules = [
     'email'    => 'required|email|unique:users,email,{id}',
     'password' => 'min:6'
     ];

Indentation +169 added lines, -169 removed lines

@@ -7,173 +7,173 @@
 
 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', 'sendreset'];
-
-    /**
-     * 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'];
-
-    /**
-     * The validations rules used by the base api controller
-     * to check before add.
-     * @var array
-     */
-    protected $validationRules     = [
-    'email'    => 'required|email|unique:users,email,{id}',
-    'password' => 'min:6'
-    ];
-
-    /**
-     * Return the logged in user account.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function account()
-    {
-       $relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
-       return \Response::json(call_user_func_array("\Core::{$this->model}", [])->find(\JWTAuth::parseToken()->authenticate()->id, $relations), 200);
-    }
-
-    /**
-     * Block the user.
-     *
-     * @param  integer  $id
-     * @return \Illuminate\Http\Response
-     */
-    public function block($id)
-    {
-        return \Response::json(\Core::users()->block($id), 200);
-    }
-
-    /**
-     * Unblock the user.
-     *
-     * @param  integer  $id
-     * @return \Illuminate\Http\Response
-     */
-    public function unblock($id)
-    {
-        return \Response::json(\Core::users()->unblock($id), 200);
-    }
-
-    /**
-     * Logout the user.
-     * 
-     * @return \Illuminate\Http\Response
-     */
-    public function logout()
-    {
-        return \Response::json(\Core::users()->logout(), 200);
-    }
-
-    /**
-     * Handle a registration request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @return \Illuminate\Http\Response
-     */
-    public function register(Request $request)
-    {
-        $this->validate($request, [
-            'email'    => 'required|email|unique:users,email,{id}', 
-            'password' => 'required|min:6'
-            ]);
-
-        return \Response::json(\Core::users()->register($request->only('email', 'password')), 200);
-    }
-
-    /**
-     * Handle a login request of the none admin 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'    => 'boolean'
-            ]);
-
-        return \Response::json(\Core::users()->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, [
-            'access_token' => 'required',
-            'type'         => 'required|in:facebook,google'
-            ]);
-
-        return \Response::json(\Core::users()->loginSocial($request->only('access_token', 'type')), 200);
-    }
-
-    /**
-     * Handle an assign groups to user request.
-     *
-     * @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(\Core::users()->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', 'url' => 'required|url']);
-
-        return \Response::json(\Core::users()->sendReset($request->only('email'), $request->get('url')), 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(\Core::users()->resetPassword($request->only('email', 'password', 'password_confirmation', 'token')), 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', 'sendreset'];
+
+	/**
+	 * 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'];
+
+	/**
+	 * The validations rules used by the base api controller
+	 * to check before add.
+	 * @var array
+	 */
+	protected $validationRules     = [
+	'email'    => 'required|email|unique:users,email,{id}',
+	'password' => 'min:6'
+	];
+
+	/**
+	 * Return the logged in user account.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function account()
+	{
+	   $relations = $this->relations && $this->relations['find'] ? $this->relations['find'] : [];
+	   return \Response::json(call_user_func_array("\Core::{$this->model}", [])->find(\JWTAuth::parseToken()->authenticate()->id, $relations), 200);
+	}
+
+	/**
+	 * Block the user.
+	 *
+	 * @param  integer  $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function block($id)
+	{
+		return \Response::json(\Core::users()->block($id), 200);
+	}
+
+	/**
+	 * Unblock the user.
+	 *
+	 * @param  integer  $id
+	 * @return \Illuminate\Http\Response
+	 */
+	public function unblock($id)
+	{
+		return \Response::json(\Core::users()->unblock($id), 200);
+	}
+
+	/**
+	 * Logout the user.
+	 * 
+	 * @return \Illuminate\Http\Response
+	 */
+	public function logout()
+	{
+		return \Response::json(\Core::users()->logout(), 200);
+	}
+
+	/**
+	 * Handle a registration request.
+	 *
+	 * @param  \Illuminate\Http\Request  $request
+	 * @return \Illuminate\Http\Response
+	 */
+	public function register(Request $request)
+	{
+		$this->validate($request, [
+			'email'    => 'required|email|unique:users,email,{id}', 
+			'password' => 'required|min:6'
+			]);
+
+		return \Response::json(\Core::users()->register($request->only('email', 'password')), 200);
+	}
+
+	/**
+	 * Handle a login request of the none admin 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'    => 'boolean'
+			]);
+
+		return \Response::json(\Core::users()->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, [
+			'access_token' => 'required',
+			'type'         => 'required|in:facebook,google'
+			]);
+
+		return \Response::json(\Core::users()->loginSocial($request->only('access_token', 'type')), 200);
+	}
+
+	/**
+	 * Handle an assign groups to user request.
+	 *
+	 * @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(\Core::users()->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', 'url' => 'required|url']);
+
+		return \Response::json(\Core::users()->sendReset($request->only('email'), $request->get('url')), 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(\Core::users()->resetPassword($request->only('email', 'password', 'password_confirmation', 'token')), 200);
+	}
 }

src/Modules/V1/Core/Interfaces/RepositoryInterface.php

Indentation +106 added lines, -106 removed lines

@@ -2,119 +2,119 @@
 
 interface RepositoryInterface
 {
-    /**
-     * Fetch all records with relations from the storage.
-     * 
-     * @param  array  $relations
-     * @param  array  $sortBy
-     * @param  array  $desc
-     * @param  array  $columns
-     * @return collection
-     */
-    public function all($relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from the storage.
+	 * 
+	 * @param  array  $relations
+	 * @param  array  $sortBy
+	 * @param  array  $desc
+	 * @param  array  $columns
+	 * @return collection
+	 */
+	public function all($relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
     
-    /**
-     * Fetch all records with relations from storage in pages 
-     * that matche the given query.
-     * 
-     * @param  string  $query
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from storage in pages 
+	 * that matche the given query.
+	 * 
+	 * @param  string  $query
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function search($query, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-    /**
-     * Fetch all records with relations from storage in pages.
-     * 
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations from storage in pages.
+	 * 
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginate($perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
     
-    /**
-     * Fetch all records with relations based on
-     * the given condition from storage in pages.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  integer $perPage
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch all records with relations based on
+	 * the given condition from storage in pages.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  integer $perPage
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function paginateBy($conditions, $perPage = 15, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-     /**
-     * Save the given model/models to the storage.
-     * 
-     * @param  array   $data
-     * @param  boolean $saveLog
-     * @return object
-     */
-    public function save(array $data, $saveLog = true);
+	 /**
+	  * Save the given model/models to the storage.
+	  * 
+	  * @param  array   $data
+	  * @param  boolean $saveLog
+	  * @return object
+	  */
+	public function save(array $data, $saveLog = true);
 
-    /**
-     * Update record in the storage based on the given
-     * condition.
-     * 
-     * @param  var     $value condition value
-     * @param  array   $data
-     * @param  string  $attribute condition column name
-     * @return integer affected rows
-     */
-    public function update($value, array $data, $attribute = 'id');
+	/**
+	 * Update record in the storage based on the given
+	 * condition.
+	 * 
+	 * @param  var     $value condition value
+	 * @param  array   $data
+	 * @param  string  $attribute condition column name
+	 * @return integer affected rows
+	 */
+	public function update($value, array $data, $attribute = 'id');
 
-    /**
-     * Delete record from the storage based on the given
-     * condition.
-     * 
-     * @param  var     $value condition value
-     * @param  string  $attribute condition column name
-     * @return integer affected rows
-     */
-    public function delete($value, $attribute = 'id');
+	/**
+	 * Delete record from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  var     $value condition value
+	 * @param  string  $attribute condition column name
+	 * @return integer affected rows
+	 */
+	public function delete($value, $attribute = 'id');
     
-    /**
-     * Fetch records from the storage based on the given
-     * id.
-     * 
-     * @param  integer $id
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function find($id, $relations = [], $columns = array('*'));
+	/**
+	 * Fetch records from the storage based on the given
+	 * id.
+	 * 
+	 * @param  integer $id
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function find($id, $relations = [], $columns = array('*'));
     
-    /**
-     * Fetch records from the storage based on the given
-     * condition.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $sortBy
-     * @param  array   $desc
-     * @param  array   $columns
-     * @return collection
-     */
-    public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
+	/**
+	 * Fetch records from the storage based on the given
+	 * condition.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $sortBy
+	 * @param  array   $desc
+	 * @param  array   $columns
+	 * @return collection
+	 */
+	public function findBy($conditions, $relations = [], $sortBy = 'created_at', $desc = 0, $columns = array('*'));
 
-    /**
-     * Fetch the first record fro the storage based on the given
-     * condition.
-     * 
-     * @param  array   $conditions array of conditions
-     * @param  array   $relations
-     * @param  array   $columns
-     * @return object
-     */
-    public function first($conditions, $relations = [], $columns = array('*'));
+	/**
+	 * Fetch the first record fro the storage based on the given
+	 * condition.
+	 * 
+	 * @param  array   $conditions array of conditions
+	 * @param  array   $relations
+	 * @param  array   $columns
+	 * @return object
+	 */
+	public function first($conditions, $relations = [], $columns = array('*'));
 }
\ No newline at end of file