Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theriddleofenigma/laravel-model-validation
Laravel model validation validates the data on model events. *Only for laravel applications.
https://github.com/theriddleofenigma/laravel-model-validation
database eloquent eloquent-models laravel laravel-application laravel-framework model model-validation php validation
Last synced: 6 days ago
JSON representation
Laravel model validation validates the data on model events. *Only for laravel applications.
- Host: GitHub
- URL: https://github.com/theriddleofenigma/laravel-model-validation
- Owner: theriddleofenigma
- License: mit
- Created: 2018-07-21T11:28:17.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-05T14:58:57.000Z (6 months ago)
- Last Synced: 2024-09-23T17:02:42.486Z (10 days ago)
- Topics: database, eloquent, eloquent-models, laravel, laravel-application, laravel-framework, model, model-validation, php, validation
- Language: PHP
- Homepage: https://theriddleofenigma.github.io/laravel-model-validation/
- Size: 55.7 KB
- Stars: 32
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
♥ Made with <love/> And I love <code/>
# Laravel Model Validation
[](https://app.fossa.io/projects/git%2Bgithub.com%2Ftheriddleofenigma%2Flaravel-model-validation?ref=badge_shield)
Model validation - Validates the model data. *Only for laravel applications.
An easy validator option for your eloquent models. Also have flexibility for additional codes that might be executed on before and after validation.
### Composer install
```shell
composer require theriddleofenigma/laravel-model-validation
```
## Usage Examples
Here user model is mentioned as an example. You could use this in any model you want.
### User.php model
```php
use Enigma\ValidatorTrait;
class User extends Model
{
use ValidatorTrait;
/**
* Boot method.
*/
public static function boot()
{
parent::boot();
// Add this method for validating the current model on model saving event
static::validateOnSaving();
}
public $validationRules = [
'name' => 'required|max:10',
'email' => 'required|email',
];
public $validationMessages = [
'name.required' => 'Name field is required.',
'email.email' => 'The given email is in invalid format.',
];
public $validationAttributes = [
'name' => 'User Name'
];
/**
* Code to be executed before the validation goes here.
*/
public function beforeValidation()
{
// Some code goes here..
}
/**
* Code to be executed after the validation goes here.
*/
public function afterValidation()
{
// Some code goes here..
}
}
```
### Control the data get validated
You can control the data which gets validated by adding validationData method.
```php
/**
* Validation data to be validated.
*
* @return array
*/
public function validationData(array $data)
{
// Here $data is the value of $this->getAttributes(), feel free to use your own code to produce the data. Ex: $this->toArray(), $this->getOriginal(), etc.,
$data["name"] = strtolower($data["name"]);
// Note: This wouldn't affect your actual model data which is going to persist in DB.
return $data;
}
```
### Other options
You could mention the validation rules, attributes and messages as a property as well as method.
```php
/**
* Validation rules to validate.
*
* @return array
*/
public function validationRules()
{
// You can process your code here and return the rules as however you want.
return [
'name' => 'required|max:10',
'email' => 'required|email',
];
}
/**
* Custom messages to replace the validation messages.
*
* @return array
*/
public function validationMessages()
{
// You can process your code here and return the messages as however you want.
return [
'name.required' => 'Name field is required.',
'email.email' => 'The given email is in invalid format.',
];
}
/**
* Custom attribute names to replace the validation attribute name.
*
* @return array
*/
public function validationAttributes()
{
return [
'name' => 'User Name'
];
}
```
You could mention the validation only for creating itself or on any model event just add `$model->validate()`.
```php
/**
* Boot method.
*/
public static function boot()
{
parent::boot();
// You can mention like this for validating the model on custom events as your wish
self::creating(function($model){
$model->validate();
});
// Or you can make use of the alias `self::validateOnCreating()`.
}
```
Refer the available methods in the ValidationTrait.
## License
Laravel Model Validation is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
[](https://app.fossa.io/projects/git%2Bgithub.com%2Ftheriddleofenigma%2Flaravel-model-validation?ref=badge_large)