Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve UserValidator default behavior [4.0 beta] #311

Closed
wants to merge 4 commits into from
Closed

Improve UserValidator default behavior [4.0 beta] #311

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fbcb06a
Corrected password_confirmation Lang message string
gabrielalmeida Jul 15, 2014
b7c4c3a
Changed attachErrorMsg to pass attributes to errors MessageBag
gabrielalmeida Jul 15, 2014
c5699fe
Adjusting indentations
gabrielalmeida Jul 15, 2014
7120dd8
Re-adjusting indentation..
gabrielalmeida Jul 16, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 135 additions & 121 deletions src/Zizaco/Confide/UserValidator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

use Illuminate\Support\Facades\App as App;
use Illuminate\Support\Facades\Lang as Lang;
use Illuminate\Support\MessageBag as MessageBag;
use Illuminate\Support\Contracts\MessageProviderInterface as MessageProviderInterface;


/**
* This is the default validator used by ConfideUser. You may overwrite this
Expand All @@ -28,135 +31,146 @@
*/
class UserValidator implements UserValidatorInterface {

/**
* Confide repository instance
*
* @var \Zizaco\Confide\RepositoryInterface
*/
public $repo;

/**
* Validation rules for this Validator.
*
* @var array
*/
public $rules = [
'create' => [
'username' => 'required|alpha_dash',
'email' => 'required|email',
'password' => 'required|min:4',
],
'update' => [
'username' => 'required|alpha_dash',
'email' => 'required|email',
'password' => 'required|min:4',
]
/**
* Confide repository instance
*
* @var \Zizaco\Confide\RepositoryInterface
*/
public $repo;

/**
* Validation rules for this Validator.
*
* @var array
*/
public $rules = [
'create' => [
'username' => 'required|alpha_dash',
'email' => 'required|email',
'password' => 'required|min:4',
],
'update' => [
'username' => 'required|alpha_dash',
'email' => 'required|email',
'password' => 'required|min:4',
]
];

/**
* Validates the given user. Should check if all the fields are correctly
* @param ConfideUserInterface $user Instance to be tested
* @return boolean True if the $user is valid
*/
public function validate(ConfideUserInterface $user, $ruleset = 'create')
{
// Set the $repo as a ConfideRepository object
$this->repo = App::make('confide.repository');

// Validate object
$result = $this->validatePassword($user) &&
$this->validateIsUnique($user) &&
$this->validateAttributes($user, $ruleset);

return $result;
/**
* Validates the given user. Should check if all the fields are correctly
* @param ConfideUserInterface $user Instance to be tested
* @return boolean True if the $user is valid
*/
public function validate(ConfideUserInterface $user, $ruleset = 'create')
{
// Set the $repo as a ConfideRepository object
$this->repo = App::make('confide.repository');

// Set $user->errors as a MessageBag object
$user->errors = App::make('Illuminate\Support\MessageBag');

// Validate object
$result = $this->validatePassword($user) &&
$this->validateIsUnique($user) &&
$this->validateAttributes($user, $ruleset);

return $result;
}

/**
* Validates the password and password_confirmation of the given
* user
* @param ConfideUserInterface $user
* @return boolean True if password is valid
*/
public function validatePassword(ConfideUserInterface $user)
{
$hash = App::make('hash');

if($user->getOriginal('password') != $user->password) {
if ($user->password == $user->password_confirmation) {

// Hashes password and unset password_confirmation field
$user->password = $hash->make($user->password);
unset($user->password_confirmation);

return true;
} else {
$this->attachErrorMsg($user->errors, 'confide::confide.alerts.wrong_confirmation', 'password_confirmation');
return false;
}
}

/**
* Validates the password and password_confirmation of the given
* user
* @param ConfideUserInterface $user
* @return boolean True if password is valid
*/
public function validatePassword(ConfideUserInterface $user)
{
$hash = App::make('hash');

if($user->getOriginal('password') != $user->password) {
if ($user->password == $user->password_confirmation) {

// Hashes password and unset password_confirmation field
$user->password = $hash->make($user->password);
unset($user->password_confirmation);

return true;
} else {
$this->attachErrorMsg($user, 'validation.confirmed::confide.alerts.wrong_password_reset');
return false;
}
}
return true;
}

/**
* Validates if the given user is unique. If there is another
* user with the same credentials but a different id, this
* method will return false.
* @param ConfideUserInterface $user
* @return boolean True if user is unique
*/
public function validateIsUnique(ConfideUserInterface $user)
{
$identity = [
'username' => $user->username,
'email' => $user->email,
];

foreach($identity as $attribute => $value) {

$similar = $this->repo->getUserByIdentity(array($attribute => $value));

if (!$similar || $similar->getKey() == $user->getKey()) {
return true;
}
}

/**
* Validates if the given user is unique. If there is another
* user with the same credentials but a different id, this
* method will return false.
* @param ConfideUserInterface $user
* @return boolean True if user is unique
*/
public function validateIsUnique(ConfideUserInterface $user)
{
$identity = [
'username' => $user->username,
'email' => $user->email,
];

$similar = $this->repo->getUserByIdentity($identity);

if (!$similar || $similar->getKey() == $user->getKey()) {
return true;
}

$this->attachErrorMsg($user, 'confide::confide.alerts.duplicated_credentials');
return false;
}

/**
* Uses Laravel Validator in order to check if the attributes of the
* $user object are valid for the given $ruleset
* @param ConfideUserInterface $user
* @param string $ruleset The name of the key in the UserValidator->$rules array
* @return boolean True if the attributes are valid
*/
public function validateAttributes(ConfideUserInterface $user, $ruleset = 'create')
{
$attributes = $user->toArray();
$rules = $this->rules[$ruleset];

$validator = App::make('validator')
->make( $attributes, $rules );

// Validate and attach errors
if ($validator->fails()) {
$user->errors = $validator->errors();
return false;
} else {
return true;
}
$this->attachErrorMsg($user->errors, 'confide::confide.alerts.duplicated_credentials', $attribute);
return false;
}

/**
* Creates a \Illuminate\Support\MessageBag object, add the error message
* to it and then set the errors attribute of the user with that bag
* @param ConfideUserInterface $user
* @param string $errorMsg The error messgae
* @return void
*/
public function attachErrorMsg(ConfideUserInterface $user, $errorMsg)
{
$messageBag = App::make('Illuminate\Support\MessageBag');
$messageBag->add('confide', Lang::get($errorMsg));
$user->errors = $messageBag;
}

/**
* Uses Laravel Validator in order to check if the attributes of the
* $user object are valid for the given $ruleset
* @param ConfideUserInterface $user
* @param string $ruleset The name of the key in the UserValidator->$rules array
* @return boolean True if the attributes are valid
*/
public function validateAttributes(ConfideUserInterface $user, $ruleset = 'create')
{
$attributes = $user->toArray();
$rules = $this->rules[$ruleset];

$validator = App::make('validator')
->make( $attributes, $rules );

// Validate and attach errors
if ($validator->fails()) {
$this->attachErrorMsg($user->errors, $validator->errors());
return false;
} else {
return true;
}
}

/**
* Attach errorMsg to a bag accordingly to type and provides key option
* to allow checking of this locally and get correct Lang msg.
* Otherwise works as defaults MessageBag merge method.
* @param \Illuminate\Support\MessageBag $messageBag
* @param mixed $errorMsg The error key and message
* @param string
* @return void
*/
public function attachErrorMsg(MessageBag $messageBag, $errorMsg, $key = 'confide')
{
if( is_array($errorMsg) || $errorMsg instanceof MessageProviderInterface) {
$messageBag->merge($errorMsg);
} else {
$messageBag->add($key, Lang::get($errorMsg));
}
}
}