SherifElfadaly / Laravel-Api-Skeleton

src/Modules/Acl/Repositories/UserRepository.php

Doc Comments +3 added lines, -3 removed lines

@@ -61,7 +61,7 @@ 
     /**
      * Check if the logged in user has the given group.
      * 
-     * @param  array $groups
+     * @param  string[] $groups
      * @param  mixed $user
      * @return boolean
      */
@@ -155,7 +155,7 @@ 
      * 
      * @param  array   $credentials
      * @param  boolean $skipConfirmEmail
-     * @return array
+     * @return boolean
      */
     public function register($credentials, $skipConfirmEmail = false)
     {
@@ -246,7 +246,7 @@ 
      * Reset the given user's password.
      *
      * @param  array  $credentials
-     * @return array
+     * @return string|null
      */
     public function resetPassword($credentials)
     {

Indentation +402 added lines, -402 removed lines

@@ -5,414 +5,414 @@
 
 class UserRepository extends AbstractRepository
 {
-    /**
-     * Return the model full namespace.
-     * 
-     * @return string
-     */
-    protected function getModel()
-    {
-        return 'App\Modules\Acl\AclUser';
-    }
-
-
-    /**
-     * Return the logged in user account.
-     *
-     * @param  array   $relations
-     * @return boolean
-     */
-    public function account($relations = [])
-    {
-        $permissions = [];
-        $user        = \Core::users()->find(\Auth::id(), $relations);
-        foreach ($user->groups()->get() as $group)
-        {
-            $group->permissions->each(function ($permission) use (&$permissions){
-                $permissions[$permission->model][$permission->id] = $permission->name;
-            });
-        }
-        $user->permissions = $permissions;
-
-       return $user;
-    }
-
-    /**
-     * Check if the logged in user or the given user 
-     * has the given permissions on the given model.
-     * 
-     * @param  string $nameOfPermission
-     * @param  string $model            
-     * @param  mixed  $user
-     * @return boolean
-     */
-    public function can($nameOfPermission, $model, $user = false)
-    {      
-        $user        = $user ?: $this->find(\Auth::id(), ['groups.permissions']);
-        $permissions = [];
-
-        $user->groups->pluck('permissions')->each(function ($permission) use (&$permissions, $model){
-            $permissions = array_merge($permissions, $permission->where('model', $model)->pluck('name')->toArray()); 
-        });
+	/**
+	 * Return the model full namespace.
+	 * 
+	 * @return string
+	 */
+	protected function getModel()
+	{
+		return 'App\Modules\Acl\AclUser';
+	}
+
+
+	/**
+	 * Return the logged in user account.
+	 *
+	 * @param  array   $relations
+	 * @return boolean
+	 */
+	public function account($relations = [])
+	{
+		$permissions = [];
+		$user        = \Core::users()->find(\Auth::id(), $relations);
+		foreach ($user->groups()->get() as $group)
+		{
+			$group->permissions->each(function ($permission) use (&$permissions){
+				$permissions[$permission->model][$permission->id] = $permission->name;
+			});
+		}
+		$user->permissions = $permissions;
+
+	   return $user;
+	}
+
+	/**
+	 * Check if the logged in user or the given user 
+	 * has the given permissions on the given model.
+	 * 
+	 * @param  string $nameOfPermission
+	 * @param  string $model            
+	 * @param  mixed  $user
+	 * @return boolean
+	 */
+	public function can($nameOfPermission, $model, $user = false)
+	{      
+		$user        = $user ?: $this->find(\Auth::id(), ['groups.permissions']);
+		$permissions = [];
+
+		$user->groups->pluck('permissions')->each(function ($permission) use (&$permissions, $model){
+			$permissions = array_merge($permissions, $permission->where('model', $model)->pluck('name')->toArray()); 
+		});
         
-        return in_array($nameOfPermission, $permissions);
-    }
-
-    /**
-     * Check if the logged in user has the given group.
-     * 
-     * @param  array $groups
-     * @param  mixed $user
-     * @return boolean
-     */
-    public function hasGroup($groups, $user = false)
-    {
-        $user = $user ?: $this->find(\Auth::id());
-        return $user->groups->whereIn('name', $groups)->count() ? true : false;
-    }
-
-    /**
-     * Assign the given group ids to the given user.
-     * 
-     * @param  integer $userId    
-     * @param  array   $groupIds
-     * @return object
-     */
-    public function assignGroups($userId, $groupIds)
-    {
-        \DB::transaction(function () use ($userId, $groupIds) {
-            $user = $this->find($userId);
-            $user->groups()->detach();
-            $user->groups()->attach($groupIds);
-        });
-
-        return $this->find($userId);
-    }
-
-
-    /**
-     * Handle a login request to the application.
-     * 
-     * @param  array   $credentials    
-     * @param  boolean $adminLogin
-     * @return object
-     */
-    public function login($credentials, $adminLogin = false)
-    {
-        if ( ! $user = $this->first(['email' => $credentials['email']])) 
-        {
-            \ErrorHandler::loginFailed();
-        }
-        else if ($adminLogin && ! $user->groups->whereIn('name', ['Admin'])->count()) 
-        {
-            \ErrorHandler::loginFailed();
-        }
-        else if ( ! $adminLogin && $user->groups->whereIn('name', ['Admin'])->count()) 
-        {
-            \ErrorHandler::loginFailed();
-        }
-        else if ($user->blocked)
-        {
-            \ErrorHandler::userIsBlocked();
-        }
-        else if ( ! config('skeleton.disable_confirm_email') && ! $user->confirmed)
-        {
-            \ErrorHandler::emailNotConfirmed();
-        }
-
-        return $user;
-    }
-
-    /**
-     * Handle a social login request of the none admin to the application.
-     * 
-     * @param  string $authCode
-     * @param  string $accessToken
-     * @param  string $type
-     * @return array
-     */
-    public function loginSocial($authCode, $accessToken, $type)
-    {
-        $access_token = $authCode ? array_get(\Socialite::driver($type)->getAccessTokenResponse($authCode), 'access_token') : $accessToken;
-        $user         = \Socialite::driver($type)->userFromToken($access_token);
-
-        if ( ! $user->email)
-        {
-            \ErrorHandler::noSocialEmail();
-        }
-
-        if ( ! $registeredUser = $this->model->where('email', $user->email)->first()) 
-        {
-            $this->register(['email' => $user->email, 'password' => ''], true);
-        }
-
-        $loginProxy = \App::make('App\Modules\Acl\Proxy\LoginProxy');
-        return $loginProxy->login(['email' => $user->email, 'password' => config('skeleton.social_pass')], 0);
-    }
+		return in_array($nameOfPermission, $permissions);
+	}
+
+	/**
+	 * Check if the logged in user has the given group.
+	 * 
+	 * @param  array $groups
+	 * @param  mixed $user
+	 * @return boolean
+	 */
+	public function hasGroup($groups, $user = false)
+	{
+		$user = $user ?: $this->find(\Auth::id());
+		return $user->groups->whereIn('name', $groups)->count() ? true : false;
+	}
+
+	/**
+	 * Assign the given group ids to the given user.
+	 * 
+	 * @param  integer $userId    
+	 * @param  array   $groupIds
+	 * @return object
+	 */
+	public function assignGroups($userId, $groupIds)
+	{
+		\DB::transaction(function () use ($userId, $groupIds) {
+			$user = $this->find($userId);
+			$user->groups()->detach();
+			$user->groups()->attach($groupIds);
+		});
+
+		return $this->find($userId);
+	}
+
+
+	/**
+	 * Handle a login request to the application.
+	 * 
+	 * @param  array   $credentials    
+	 * @param  boolean $adminLogin
+	 * @return object
+	 */
+	public function login($credentials, $adminLogin = false)
+	{
+		if ( ! $user = $this->first(['email' => $credentials['email']])) 
+		{
+			\ErrorHandler::loginFailed();
+		}
+		else if ($adminLogin && ! $user->groups->whereIn('name', ['Admin'])->count()) 
+		{
+			\ErrorHandler::loginFailed();
+		}
+		else if ( ! $adminLogin && $user->groups->whereIn('name', ['Admin'])->count()) 
+		{
+			\ErrorHandler::loginFailed();
+		}
+		else if ($user->blocked)
+		{
+			\ErrorHandler::userIsBlocked();
+		}
+		else if ( ! config('skeleton.disable_confirm_email') && ! $user->confirmed)
+		{
+			\ErrorHandler::emailNotConfirmed();
+		}
+
+		return $user;
+	}
+
+	/**
+	 * Handle a social login request of the none admin to the application.
+	 * 
+	 * @param  string $authCode
+	 * @param  string $accessToken
+	 * @param  string $type
+	 * @return array
+	 */
+	public function loginSocial($authCode, $accessToken, $type)
+	{
+		$access_token = $authCode ? array_get(\Socialite::driver($type)->getAccessTokenResponse($authCode), 'access_token') : $accessToken;
+		$user         = \Socialite::driver($type)->userFromToken($access_token);
+
+		if ( ! $user->email)
+		{
+			\ErrorHandler::noSocialEmail();
+		}
+
+		if ( ! $registeredUser = $this->model->where('email', $user->email)->first()) 
+		{
+			$this->register(['email' => $user->email, 'password' => ''], true);
+		}
+
+		$loginProxy = \App::make('App\Modules\Acl\Proxy\LoginProxy');
+		return $loginProxy->login(['email' => $user->email, 'password' => config('skeleton.social_pass')], 0);
+	}
     
-    /**
-     * Handle a registration request.
-     * 
-     * @param  array   $credentials
-     * @param  boolean $skipConfirmEmail
-     * @return array
-     */
-    public function register($credentials, $skipConfirmEmail = false)
-    {
-        $user = $this->save($credentials);
-
-        if ($skipConfirmEmail) 
-        {
-            $user->confirmed = 1;
-            $user->save();
-        }
-        else if ( ! config('skeleton.disable_confirm_email'))  
-        {
-            $this->sendConfirmationEmail($user->email);
-        }
-
-        return $user;
-    }
+	/**
+	 * Handle a registration request.
+	 * 
+	 * @param  array   $credentials
+	 * @param  boolean $skipConfirmEmail
+	 * @return array
+	 */
+	public function register($credentials, $skipConfirmEmail = false)
+	{
+		$user = $this->save($credentials);
+
+		if ($skipConfirmEmail) 
+		{
+			$user->confirmed = 1;
+			$user->save();
+		}
+		else if ( ! config('skeleton.disable_confirm_email'))  
+		{
+			$this->sendConfirmationEmail($user->email);
+		}
+
+		return $user;
+	}
     
-    /**
-     * Block the user.
-     *
-     * @param  integer $userId
-     * @return object
-     */
-    public function block($userId)
-    {
-        if ( ! $user = $this->find($userId)) 
-        {
-            \ErrorHandler::notFound('user');
-        }
-        if ( ! $this->hasGroup(['Admin']))
-        {
-            \ErrorHandler::noPermissions();
-        }
-        else if (\Auth::id() == $userId)
-        {
-            \ErrorHandler::noPermissions();
-        }
-        else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
-        {
-            \ErrorHandler::noPermissions();
-        }
-
-        $user->blocked = 1;
-        $user->save();
+	/**
+	 * Block the user.
+	 *
+	 * @param  integer $userId
+	 * @return object
+	 */
+	public function block($userId)
+	{
+		if ( ! $user = $this->find($userId)) 
+		{
+			\ErrorHandler::notFound('user');
+		}
+		if ( ! $this->hasGroup(['Admin']))
+		{
+			\ErrorHandler::noPermissions();
+		}
+		else if (\Auth::id() == $userId)
+		{
+			\ErrorHandler::noPermissions();
+		}
+		else if ($user->groups->pluck('name')->search('Admin', true) !== false) 
+		{
+			\ErrorHandler::noPermissions();
+		}
+
+		$user->blocked = 1;
+		$user->save();
         
-        return $user;
-    }
-
-    /**
-     * Unblock the user.
-     *
-     * @param  integer $userId
-     * @return object
-     */
-    public function unblock($userId)
-    {
-        if ( ! $this->hasGroup(['Admin']))
-        {
-            \ErrorHandler::noPermissions();
-        }
-
-        $user          = $this->find($userId);
-        $user->blocked = 0;
-        $user->save();
-
-        return $user;
-    }
-
-    /**
-     * Send a reset link to the given user.
-     *
-     * @param  string  $email
-     * @return void
-     */
-    public function sendReset($email)
-    {
-        if ( ! $user = $this->model->where('email', $email)->first())
-        {
-            \ErrorHandler::notFound('email');
-        }
-
-        $token = \Password::getRepository()->create($user);
-        \Core::notifications()->notify($user, 'ResetPassword', $token);
-    }
-
-    /**
-     * Reset the given user's password.
-     *
-     * @param  array  $credentials
-     * @return array
-     */
-    public function resetPassword($credentials)
-    {
-        $response = \Password::reset($credentials, function ($user, $password) {
-            $user->password = $password;
-            $user->save();
-        });
-
-        switch ($response) {
-            case \Password::PASSWORD_RESET:
-                return 'success';
+		return $user;
+	}
+
+	/**
+	 * Unblock the user.
+	 *
+	 * @param  integer $userId
+	 * @return object
+	 */
+	public function unblock($userId)
+	{
+		if ( ! $this->hasGroup(['Admin']))
+		{
+			\ErrorHandler::noPermissions();
+		}
+
+		$user          = $this->find($userId);
+		$user->blocked = 0;
+		$user->save();
+
+		return $user;
+	}
+
+	/**
+	 * Send a reset link to the given user.
+	 *
+	 * @param  string  $email
+	 * @return void
+	 */
+	public function sendReset($email)
+	{
+		if ( ! $user = $this->model->where('email', $email)->first())
+		{
+			\ErrorHandler::notFound('email');
+		}
+
+		$token = \Password::getRepository()->create($user);
+		\Core::notifications()->notify($user, 'ResetPassword', $token);
+	}
+
+	/**
+	 * Reset the given user's password.
+	 *
+	 * @param  array  $credentials
+	 * @return array
+	 */
+	public function resetPassword($credentials)
+	{
+		$response = \Password::reset($credentials, function ($user, $password) {
+			$user->password = $password;
+			$user->save();
+		});
+
+		switch ($response) {
+			case \Password::PASSWORD_RESET:
+				return 'success';
                 
-            case \Password::INVALID_TOKEN:
-                \ErrorHandler::invalidResetToken('token');
-
-            case \Password::INVALID_PASSWORD:
-                \ErrorHandler::invalidResetPassword('email');
-
-            case \Password::INVALID_USER:
-                \ErrorHandler::notFound('user');
-
-            default:
-                \ErrorHandler::generalError();
-        }
-    }
-
-    /**
-     * Change the logged in user password.
-     *
-     * @param  array  $credentials
-     * @return void
-     */
-    public function changePassword($credentials)
-    {
-        $user = \Auth::user();
-        if ( ! \Hash::check($credentials['old_password'], $user->password)) 
-        {
-            \ErrorHandler::invalidOldPassword();
-        }
-
-        $user->password = $credentials['password'];
-        $user->save();
-    }
-
-    /**
-     * Confirm email using the confirmation code.
-     *
-     * @param  string $confirmationCode
-     * @return void
-     */
-    public function confirmEmail($confirmationCode)
-    {
-        $user                    = $this->first(['confirmation_code' => $confirmationCode]);
-        $user->confirmed         = 1;
-        $user->confirmation_code = null;
-        $user->save();
-    }
-
-    /**
-     * Send the confirmation mail.
-     *
-     * @param  string $email
-     * @return void
-     */
-    public function sendConfirmationEmail($email)
-    {
-        $user = $this->first(['email' => $email]);
-        if ($user->confirmed) 
-        {
-            \ErrorHandler::emailAlreadyConfirmed();
-        }
-
-        $user->confirmed         = 0;
-        $user->confirmation_code = sha1(microtime());
-        $user->save();
-        \Core::notifications()->notify($user, 'ConfirmEmail');
-    }
-
-    /**
-     * Paginate all users in the given group based on the given conditions.
-     * 
-     * @param  string  $groupName
-     * @param  array   $relations
-     * @param  integer $perPage
-     * @param  string  $sortBy
-     * @param  boolean $desc
-     * @return \Illuminate\Http\Response
-     */
-    public function group($conditions, $groupName, $relations, $perPage, $sortBy, $desc)
-    {   
-        unset($conditions['page']);
-        $conditions = $this->constructConditions($conditions, $this->model);
-        $sort       = $desc ? 'desc' : 'asc';
-        $model      = call_user_func_array("{$this->getModel()}::with", array($relations));
-
-        $model->whereHas('groups', function($q) use ($groupName){
-            $q->where('name', $groupName);
-        });
+			case \Password::INVALID_TOKEN:
+				\ErrorHandler::invalidResetToken('token');
+
+			case \Password::INVALID_PASSWORD:
+				\ErrorHandler::invalidResetPassword('email');
+
+			case \Password::INVALID_USER:
+				\ErrorHandler::notFound('user');
+
+			default:
+				\ErrorHandler::generalError();
+		}
+	}
+
+	/**
+	 * Change the logged in user password.
+	 *
+	 * @param  array  $credentials
+	 * @return void
+	 */
+	public function changePassword($credentials)
+	{
+		$user = \Auth::user();
+		if ( ! \Hash::check($credentials['old_password'], $user->password)) 
+		{
+			\ErrorHandler::invalidOldPassword();
+		}
+
+		$user->password = $credentials['password'];
+		$user->save();
+	}
+
+	/**
+	 * Confirm email using the confirmation code.
+	 *
+	 * @param  string $confirmationCode
+	 * @return void
+	 */
+	public function confirmEmail($confirmationCode)
+	{
+		$user                    = $this->first(['confirmation_code' => $confirmationCode]);
+		$user->confirmed         = 1;
+		$user->confirmation_code = null;
+		$user->save();
+	}
+
+	/**
+	 * Send the confirmation mail.
+	 *
+	 * @param  string $email
+	 * @return void
+	 */
+	public function sendConfirmationEmail($email)
+	{
+		$user = $this->first(['email' => $email]);
+		if ($user->confirmed) 
+		{
+			\ErrorHandler::emailAlreadyConfirmed();
+		}
+
+		$user->confirmed         = 0;
+		$user->confirmation_code = sha1(microtime());
+		$user->save();
+		\Core::notifications()->notify($user, 'ConfirmEmail');
+	}
+
+	/**
+	 * Paginate all users in the given group based on the given conditions.
+	 * 
+	 * @param  string  $groupName
+	 * @param  array   $relations
+	 * @param  integer $perPage
+	 * @param  string  $sortBy
+	 * @param  boolean $desc
+	 * @return \Illuminate\Http\Response
+	 */
+	public function group($conditions, $groupName, $relations, $perPage, $sortBy, $desc)
+	{   
+		unset($conditions['page']);
+		$conditions = $this->constructConditions($conditions, $this->model);
+		$sort       = $desc ? 'desc' : 'asc';
+		$model      = call_user_func_array("{$this->getModel()}::with", array($relations));
+
+		$model->whereHas('groups', function($q) use ($groupName){
+			$q->where('name', $groupName);
+		});
 
         
-        if (count($conditions['conditionValues']))
-        {
-            $model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
-        }
-
-        if ($perPage) 
-        {
-            return $model->orderBy($sortBy, $sort)->paginate($perPage);
-        }
-
-        return $model->orderBy($sortBy, $sort)->get();
-    }
-
-    /**
-     * Save the given data to the logged in user.
-     *
-     * @param  array $data
-     * @return void
-     */
-    public function saveProfile($data) 
-    {
-        if (array_key_exists('profile_picture', $data)) 
-        {
-            $data['profile_picture'] = \Media::uploadImageBas64($data['profile_picture'], 'admins/profile_pictures');
-        }
+		if (count($conditions['conditionValues']))
+		{
+			$model->whereRaw($conditions['conditionString'], $conditions['conditionValues']);
+		}
+
+		if ($perPage) 
+		{
+			return $model->orderBy($sortBy, $sort)->paginate($perPage);
+		}
+
+		return $model->orderBy($sortBy, $sort)->get();
+	}
+
+	/**
+	 * Save the given data to the logged in user.
+	 *
+	 * @param  array $data
+	 * @return void
+	 */
+	public function saveProfile($data) 
+	{
+		if (array_key_exists('profile_picture', $data)) 
+		{
+			$data['profile_picture'] = \Media::uploadImageBas64($data['profile_picture'], 'admins/profile_pictures');
+		}
         
-        $data['id'] = \Auth::id();
-        $this->save($data);
-    }
-
-    /**
-     * Ensure access token hasn't expired or revoked.
-     * 
-     * @param  oject $accessToken
-     * @return boolean
-     */
-    public function accessTokenExpiredOrRevoked($accessToken)
-    {
-
-        $accessTokenRepository = \App::make('League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface');
-        $data                  = new ValidationData();
-        $data->setCurrentTime(time());
-
-        if ($accessToken->validate($data) === false || $accessTokenRepository->isAccessTokenRevoked($accessToken->getClaim('jti'))) 
-        {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Revoke the given access token and all 
-     * associated refresh tokens.
-     *
-     * @param  oject $accessToken
-     * @return void
-     */
-    public function revokeAccessToken($accessToken)
-    {
-        \DB::table('oauth_refresh_tokens')
-            ->where('access_token_id', $accessToken->id)
-            ->update([
-                'revoked' => true
-            ]);
-
-        $accessToken->revoke();
-    }
+		$data['id'] = \Auth::id();
+		$this->save($data);
+	}
+
+	/**
+	 * Ensure access token hasn't expired or revoked.
+	 * 
+	 * @param  oject $accessToken
+	 * @return boolean
+	 */
+	public function accessTokenExpiredOrRevoked($accessToken)
+	{
+
+		$accessTokenRepository = \App::make('League\OAuth2\Server\Repositories\AccessTokenRepositoryInterface');
+		$data                  = new ValidationData();
+		$data->setCurrentTime(time());
+
+		if ($accessToken->validate($data) === false || $accessTokenRepository->isAccessTokenRevoked($accessToken->getClaim('jti'))) 
+		{
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Revoke the given access token and all 
+	 * associated refresh tokens.
+	 *
+	 * @param  oject $accessToken
+	 * @return void
+	 */
+	public function revokeAccessToken($accessToken)
+	{
+		\DB::table('oauth_refresh_tokens')
+			->where('access_token_id', $accessToken->id)
+			->update([
+				'revoked' => true
+			]);
+
+		$accessToken->revoke();
+	}
 }

src/Modules/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\Notifications\PushNotificationDevice';
-    }
-
-    /**
-     * 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();
-        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  array  $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\Notifications\PushNotificationDevice';
+	}
+
+	/**
+	 * 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();
+		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  array  $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/Core/Console/Commands/GenerateDoc.php

Indentation +242 added lines, -242 removed lines

@@ -6,274 +6,274 @@
 
 class GenerateDoc extends Command
 {
-    /**
-     * The name and signature of the console command.
-     *
-     * @var string
-     */
-    protected $signature = 'doc:generate';
+	/**
+	 * The name and signature of the console command.
+	 *
+	 * @var string
+	 */
+	protected $signature = 'doc:generate';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
-    protected $description = 'Generate api documentation';
+	/**
+	 * The console command description.
+	 *
+	 * @var string
+	 */
+	protected $description = 'Generate api documentation';
 
-    /**
-     * Create a new command instance.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	/**
+	 * Create a new command instance.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+	}
 
-    /**
-     * Execute the console command.
-     *
-     * @return mixed
-     */
-    public function handle()
-    {
-        $docData           = [];
-        $docData['models'] = [];
-        $routes            = $this->getRoutes();
-        foreach ($routes as $route) 
-        {
-            if ($route) 
-            {
-                $actoinArray = explode('@', $route['action']);
-                if(array_get($actoinArray, 1, false))
-                {
-                    $controller       = $actoinArray[0];
-                    $method           = $actoinArray[1];
-                    $route['name']    = $method !== 'index' ? $method : 'list';
+	/**
+	 * Execute the console command.
+	 *
+	 * @return mixed
+	 */
+	public function handle()
+	{
+		$docData           = [];
+		$docData['models'] = [];
+		$routes            = $this->getRoutes();
+		foreach ($routes as $route) 
+		{
+			if ($route) 
+			{
+				$actoinArray = explode('@', $route['action']);
+				if(array_get($actoinArray, 1, false))
+				{
+					$controller       = $actoinArray[0];
+					$method           = $actoinArray[1];
+					$route['name']    = $method !== 'index' ? $method : 'list';
                     
-                    $reflectionClass  = new \ReflectionClass($controller);
-                    $reflectionMethod = $reflectionClass->getMethod($method);
-                    $classProperties  = $reflectionClass->getDefaultProperties();
-                    $skipLoginCheck   = array_key_exists('skipLoginCheck', $classProperties) ? $classProperties['skipLoginCheck'] : false;
-                    $validationRules  = array_key_exists('validationRules', $classProperties) ? $classProperties['validationRules'] : false;
+					$reflectionClass  = new \ReflectionClass($controller);
+					$reflectionMethod = $reflectionClass->getMethod($method);
+					$classProperties  = $reflectionClass->getDefaultProperties();
+					$skipLoginCheck   = array_key_exists('skipLoginCheck', $classProperties) ? $classProperties['skipLoginCheck'] : false;
+					$validationRules  = array_key_exists('validationRules', $classProperties) ? $classProperties['validationRules'] : false;
 
-                    $this->processDocBlock($route, $reflectionMethod);
-                    $this->getHeaders($route, $method, $skipLoginCheck);
-                    $this->getPostData($route, $reflectionMethod, $validationRules);
+					$this->processDocBlock($route, $reflectionMethod);
+					$this->getHeaders($route, $method, $skipLoginCheck);
+					$this->getPostData($route, $reflectionMethod, $validationRules);
 
-                    $route['response'] = $this->getResponseObject($classProperties['model'], $route['name'], $route['returnDocBlock']);
+					$route['response'] = $this->getResponseObject($classProperties['model'], $route['name'], $route['returnDocBlock']);
 
-                    preg_match('/api\/([^#]+)\//iU', $route['uri'], $module);
-                    $docData['modules'][$module[1]][substr($route['prefix'], strlen('/api/' . $module[1] . '/') - 1)][] = $route;
+					preg_match('/api\/([^#]+)\//iU', $route['uri'], $module);
+					$docData['modules'][$module[1]][substr($route['prefix'], strlen('/api/' . $module[1] . '/') - 1)][] = $route;
 
-                    $this->getModels($classProperties['model'], $docData);   
-                }
-            }
-        }
+					$this->getModels($classProperties['model'], $docData);   
+				}
+			}
+		}
         
-        $docData['errors']  = $this->getErrors();
-        $docData['reports'] = \Core::reports()->all();
-        \File::put(app_path('Modules/Core/Resources/api.json'), json_encode($docData));
-    }
+		$docData['errors']  = $this->getErrors();
+		$docData['reports'] = \Core::reports()->all();
+		\File::put(app_path('Modules/Core/Resources/api.json'), json_encode($docData));
+	}
 
-    /**
-     * Get list of all registered routes.
-     * 
-     * @return collection
-     */
-    protected function getRoutes()
-    {
-        return collect(\Route::getRoutes())->map(function ($route) {
-            if (strpos($route->uri(), 'api') !== false) 
-            {
-                return [
-                    'method' => $route->methods()[0],
-                    'uri'    => $route->uri(),
-                    'action' => $route->getActionName(),
-                    'prefix' => $route->getPrefix()
-                ];
-            }
-            return false;
-        })->all();
-    }
+	/**
+	 * Get list of all registered routes.
+	 * 
+	 * @return collection
+	 */
+	protected function getRoutes()
+	{
+		return collect(\Route::getRoutes())->map(function ($route) {
+			if (strpos($route->uri(), 'api') !== false) 
+			{
+				return [
+					'method' => $route->methods()[0],
+					'uri'    => $route->uri(),
+					'action' => $route->getActionName(),
+					'prefix' => $route->getPrefix()
+				];
+			}
+			return false;
+		})->all();
+	}
 
-    /**
-     * Generate headers for the given route.
-     * 
-     * @param  array  &$route
-     * @param  string $method
-     * @param  array  $skipLoginCheck
-     * @return void
-     */
-    protected function getHeaders(&$route, $method, $skipLoginCheck)
-    {
-        $route['headers'] = [
-        'Accept'       => 'application/json',
-        'Content-Type' => 'application/json',
-        'locale'       => 'The language of the returned data: ar, en or all.',
-        'time-zone'    => 'Your locale time zone',
-        ];
+	/**
+	 * Generate headers for the given route.
+	 * 
+	 * @param  array  &$route
+	 * @param  string $method
+	 * @param  array  $skipLoginCheck
+	 * @return void
+	 */
+	protected function getHeaders(&$route, $method, $skipLoginCheck)
+	{
+		$route['headers'] = [
+		'Accept'       => 'application/json',
+		'Content-Type' => 'application/json',
+		'locale'       => 'The language of the returned data: ar, en or all.',
+		'time-zone'    => 'Your locale time zone',
+		];
 
 
-        if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) 
-        {
-            $route['headers']['Authorization'] = 'Bearer {token}';
-        }
-    }
+		if (! $skipLoginCheck || ! in_array($method, $skipLoginCheck)) 
+		{
+			$route['headers']['Authorization'] = 'Bearer {token}';
+		}
+	}
 
-    /**
-     * Generate description and params for the given route
-     * based on the docblock.
-     * 
-     * @param  array  &$route
-     * @param  object $reflectionMethod
-     * @return void
-     */
-    protected function processDocBlock(&$route, $reflectionMethod)
-    {
-        $factory                 = \phpDocumentor\Reflection\DocBlockFactory::createInstance();
-        $docblock                = $factory->create($reflectionMethod->getDocComment());
-        $route['description']    = trim(preg_replace('/\s+/', ' ', $docblock->getSummary()));
-        $params                  = $docblock->getTagsByName('param');
-        $route['returnDocBlock'] = $docblock->getTagsByName('return')[0]->getType()->getFqsen()->getName();
-        foreach ($params as $param) 
-        {
-            $name = $param->getVariableName();
-            if ($name !== 'request') 
-            {
-                $route['parametars'][$param->getVariableName()] = $param->getDescription()->render();
-            }
-        }
-    }
+	/**
+	 * Generate description and params for the given route
+	 * based on the docblock.
+	 * 
+	 * @param  array  &$route
+	 * @param  object $reflectionMethod
+	 * @return void
+	 */
+	protected function processDocBlock(&$route, $reflectionMethod)
+	{
+		$factory                 = \phpDocumentor\Reflection\DocBlockFactory::createInstance();
+		$docblock                = $factory->create($reflectionMethod->getDocComment());
+		$route['description']    = trim(preg_replace('/\s+/', ' ', $docblock->getSummary()));
+		$params                  = $docblock->getTagsByName('param');
+		$route['returnDocBlock'] = $docblock->getTagsByName('return')[0]->getType()->getFqsen()->getName();
+		foreach ($params as $param) 
+		{
+			$name = $param->getVariableName();
+			if ($name !== 'request') 
+			{
+				$route['parametars'][$param->getVariableName()] = $param->getDescription()->render();
+			}
+		}
+	}
 
-    /**
-     * Generate post body for the given route.
-     * 
-     * @param  array  &$route
-     * @param  object $reflectionMethod
-     * @param  array  $validationRules
-     * @return void
-     */
-    protected function getPostData(&$route, $reflectionMethod, $validationRules)
-    {
-        if ($route['method'] == 'POST') 
-        {
-            $body = $this->getMethodBody($reflectionMethod);
+	/**
+	 * Generate post body for the given route.
+	 * 
+	 * @param  array  &$route
+	 * @param  object $reflectionMethod
+	 * @param  array  $validationRules
+	 * @return void
+	 */
+	protected function getPostData(&$route, $reflectionMethod, $validationRules)
+	{
+		if ($route['method'] == 'POST') 
+		{
+			$body = $this->getMethodBody($reflectionMethod);
 
-            preg_match('/\$this->validate\(\$request,([^#]+)\);/iU', $body, $match);
-            if (count($match)) 
-            {
-                if ($match[1] == '$this->validationRules')
-                {
-                    $route['body'] = $validationRules;
-                }
-                else
-                {
-                    $route['body'] = eval('return ' . str_replace(',\'.$request->get(\'id\')', ',{id}\'', $match[1]) . ';');
-                }
+			preg_match('/\$this->validate\(\$request,([^#]+)\);/iU', $body, $match);
+			if (count($match)) 
+			{
+				if ($match[1] == '$this->validationRules')
+				{
+					$route['body'] = $validationRules;
+				}
+				else
+				{
+					$route['body'] = eval('return ' . str_replace(',\'.$request->get(\'id\')', ',{id}\'', $match[1]) . ';');
+				}
 
-                foreach ($route['body'] as &$rule) 
-                {
-                    if(strpos($rule, 'unique'))
-                    {
-                        $rule = substr($rule, 0, strpos($rule, 'unique') + 6);
-                    }
-                    elseif(strpos($rule, 'exists'))
-                    {
-                        $rule = substr($rule, 0, strpos($rule, 'exists') - 1);
-                    }
-                }
-            }
-            else
-            {
-                $route['body'] = 'conditions';
-            }
-        }
-    }
+				foreach ($route['body'] as &$rule) 
+				{
+					if(strpos($rule, 'unique'))
+					{
+						$rule = substr($rule, 0, strpos($rule, 'unique') + 6);
+					}
+					elseif(strpos($rule, 'exists'))
+					{
+						$rule = substr($rule, 0, strpos($rule, 'exists') - 1);
+					}
+				}
+			}
+			else
+			{
+				$route['body'] = 'conditions';
+			}
+		}
+	}
 
-    /**
-     * Generate application errors.
-     * 
-     * @return array
-     */
-    protected function getErrors()
-    {
-        $errors          = [];
-        $reflectionClass = new \ReflectionClass('App\Modules\Core\Utl\ErrorHandler');
-        foreach ($reflectionClass->getMethods() as $method) 
-        {
-            $methodName       = $method->name;
-            $reflectionMethod = $reflectionClass->getMethod($methodName);
-            $body             = $this->getMethodBody($reflectionMethod);
+	/**
+	 * Generate application errors.
+	 * 
+	 * @return array
+	 */
+	protected function getErrors()
+	{
+		$errors          = [];
+		$reflectionClass = new \ReflectionClass('App\Modules\Core\Utl\ErrorHandler');
+		foreach ($reflectionClass->getMethods() as $method) 
+		{
+			$methodName       = $method->name;
+			$reflectionMethod = $reflectionClass->getMethod($methodName);
+			$body             = $this->getMethodBody($reflectionMethod);
 
-            preg_match('/\$error=\[\'status\'=>([^#]+)\,/iU', $body, $match);
+			preg_match('/\$error=\[\'status\'=>([^#]+)\,/iU', $body, $match);
 
-            if (count($match)) 
-            {
-                $errors[$match[1]][] = $methodName;
-            }
-        }
+			if (count($match)) 
+			{
+				$errors[$match[1]][] = $methodName;
+			}
+		}
 
-        return $errors;
-    }
+		return $errors;
+	}
 
-    /**
-     * Get the given method body code.
-     * 
-     * @param  object $reflectionMethod
-     * @return string
-     */
-    protected function getMethodBody($reflectionMethod)
-    {
-        $filename   = $reflectionMethod->getFileName();
-        $start_line = $reflectionMethod->getStartLine() - 1;
-        $end_line   = $reflectionMethod->getEndLine();
-        $length     = $end_line - $start_line;         
-        $source     = file($filename);
-        $body       = implode("", array_slice($source, $start_line, $length));
-        $body       = trim(preg_replace('/\s+/', '', $body));
+	/**
+	 * Get the given method body code.
+	 * 
+	 * @param  object $reflectionMethod
+	 * @return string
+	 */
+	protected function getMethodBody($reflectionMethod)
+	{
+		$filename   = $reflectionMethod->getFileName();
+		$start_line = $reflectionMethod->getStartLine() - 1;
+		$end_line   = $reflectionMethod->getEndLine();
+		$length     = $end_line - $start_line;         
+		$source     = file($filename);
+		$body       = implode("", array_slice($source, $start_line, $length));
+		$body       = trim(preg_replace('/\s+/', '', $body));
 
-        return $body;
-    }
+		return $body;
+	}
 
-    /**
-     * Get example object of all availble models.
-     * 
-     * @param  string $modelName
-     * @param  array  $docData
-     * @return string
-     */
-    protected function getModels($modelName, &$docData)
-    {
-        if ($modelName && ! array_key_exists($modelName, $docData['models'])) 
-        {
-            $modelClass = call_user_func_array("\Core::{$modelName}", [])->modelClass;
-            $model      = factory($modelClass)->make();
-            $modelArr   = $model->toArray();
+	/**
+	 * Get example object of all availble models.
+	 * 
+	 * @param  string $modelName
+	 * @param  array  $docData
+	 * @return string
+	 */
+	protected function getModels($modelName, &$docData)
+	{
+		if ($modelName && ! array_key_exists($modelName, $docData['models'])) 
+		{
+			$modelClass = call_user_func_array("\Core::{$modelName}", [])->modelClass;
+			$model      = factory($modelClass)->make();
+			$modelArr   = $model->toArray();
 
-            if ( $model->trans && ! $model->trans->count()) 
-            {
-                $modelArr['trans'] = [
-                    'en' => factory($modelClass . 'Translation')->make()->toArray()
-                ];
-            }
+			if ( $model->trans && ! $model->trans->count()) 
+			{
+				$modelArr['trans'] = [
+					'en' => factory($modelClass . 'Translation')->make()->toArray()
+				];
+			}
 
-            $docData['models'][$modelName] = json_encode($modelArr, JSON_PRETTY_PRINT);
-        }
-    }
+			$docData['models'][$modelName] = json_encode($modelArr, JSON_PRETTY_PRINT);
+		}
+	}
 
-    /**
-     * Get the route response object type.
-     * 
-     * @param  string $modelName
-     * @param  string $method
-     * @param  string $returnDocBlock
-     * @return array
-     */
-    protected function getResponseObject($modelName, $method, $returnDocBlock)
-    {
-        $config    = \CoreConfig::getConfig();
-        $relations = array_key_exists($modelName, $config['relations']) ? array_key_exists($method, $config['relations'][$modelName]) ? $config['relations'][$modelName] : false : false;
-        $modelName = call_user_func_array("\Core::{$returnDocBlock}", []) ? $returnDocBlock : $modelName;
+	/**
+	 * Get the route response object type.
+	 * 
+	 * @param  string $modelName
+	 * @param  string $method
+	 * @param  string $returnDocBlock
+	 * @return array
+	 */
+	protected function getResponseObject($modelName, $method, $returnDocBlock)
+	{
+		$config    = \CoreConfig::getConfig();
+		$relations = array_key_exists($modelName, $config['relations']) ? array_key_exists($method, $config['relations'][$modelName]) ? $config['relations'][$modelName] : false : false;
+		$modelName = call_user_func_array("\Core::{$returnDocBlock}", []) ? $returnDocBlock : $modelName;
 
-        return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false;
-    }
+		return $relations ? [$modelName => $relations && $relations[$method] ? $relations[$method] : []] : false;
+	}
 }

src/Modules/Core/Interfaces/RepositoryInterface.php

Indentation +105 added lines, -105 removed lines

@@ -2,118 +2,118 @@
 
 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
-     * @return mixed
-     */
-    public function save(array $data);
+	 /**
+	  * Save the given model/models to the storage.
+	  * 
+	  * @param  array $data
+	  * @return mixed
+	  */
+	public function save(array $data);
 
-    /**
-     * 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