laravel-normalizer
This package helps you normalize your data in order to save them into the database. The Goal is to having separate classes that handle the data normalization, and thus can be tested independently.
Install
Via Composer
$ composer require nwidart/laravel-normalizer
Usage
1. Adding trait
Add the Nwidart\LaravelNormalizer\Traits\CanNormalizeData trait on the model(s) you wish data to be normalized.
2. Create Normalizer classes
Your normalizers classes need to implement the Nwidart\LaravelNormalizer\Contracts\Normalizer interface. This interface will add the normalize(array $data) method.
Example:
use Nwidart\LaravelNormalizer\Contracts\Normalizer;
final class CustomNormalizer implements Normalizer
{
/**
* Normalize the given data
* @param array $data
* @return array
*/
public function normalize(array $data)
{
if (array_key_exists('name', $data)) {
$data['name'] = strtoupper($data['name']);
}
return $data;
}
}
This method needs to return the $data array. In here you can change the received data as you please.
3. Add normalizers class property
On that same model, add a protected $normalizers property. This is where you list your normalizers, in an array.
Example:
use Illuminate\Database\Eloquent\Model;
use Nwidart\LaravelNormalizer\Traits\CanNormalizeData;
class Product extends Model
{
use CanNormalizeData;
protected $normalizers = [CustomNormalizer::class];
}
4. Normalize your data on save/update
Now you can start normalizing your data. This can for instance be done in your repository class.
Example:
public function create($data)
{
$data = $this->model->normalize($data);
return $this->model->create($data);
}
Change log
Please see CHANGELOG for more information what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CONDUCT for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
776 Dec 25, 2022
51 Sep 21, 2022
15 Dec 29, 2022
13 May 16, 2022
9 Jul 5, 2022
4 Aug 31, 2022
30 Oct 19, 2022
572 Aug 6, 2022
500 Jan 5, 2023
53 Jan 4, 2023
2 Oct 11, 2022
33 Nov 6, 2022
2 Jul 27, 2022
437 Nov 17, 2022
9 Dec 21, 2022
27 Mar 2, 2022
15 Aug 11, 2022
16 Jul 7, 2022
87 Nov 26, 2022