A set of tools to use within your Laravel Models
Install package
$ composer require igortrinidad/laravel-model-utilitiesPublish de config file: model-utilities.php
$ php artisan vendor:publishSee the full example:
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
use IgorTrinidad\ModelUtilities\Traits\UuidPrimary;
use IgorTrinidad\ModelUtilities\Traits\TitleCase;
use IgorTrinidad\ModelUtilities\Traits\FullName;
use IgorTrinidad\ModelUtilities\Traits\SanitizeEmail;
use IgorTrinidad\ModelUtilities\Traits\FormatDate;
use IgorTrinidad\ModelUtilities\Traits\FormatCurrency;
class Actor extends Model
{
use UuidPrimary, TitleCase, FullName, SanitizeEmail, FormatDate, FormatCurrency;
/**
* Here you can change the primary key of your model to the correspondent primaryKey of your table
*/
protected $primaryKey = 'id';
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [
'name',
'last_name',
'email',
'bday',
'payroll'
];
/**
* The columns that should be applied Title Case
* This trait will format the columns that should be Title Case before saving in db
*
* @var array
*/
protected $titleCases = [
'name',
];
/**
* The attribute of your model to create the fullName firstName . ' ' . lastName * applied title case
* Set the onlyGetter attribute if you dont have a column in your DB of the fullName attribute
* If the onlyGetter is set to true we just create the full_name attribute on model retrieved from db
*
* @var array
*/
protected $fullNames = [
//This key should be the same as attribute or column name
'full_name' => [
'onlyGetter' => false,
'firstName' => 'name',
'lastName' => 'last_name'
]
];
/**
* The columns to apply email sanitization
*
* @var array
*/
protected $emailColumns = [
'email'
];
/**
* The date columns that you want to format for the end user
* The unformatted is the same of your database date format
* The formatted is the way you want to show for your end user
* This will format the date column just after retrieved of the db and unformat before saving in db
*
* @var array
*/
protected $dateColumns = [
'bday' => [
'unformatted' => 'Y-m-d',
'formatted' => 'd/m/Y'
]
];
/**
* The currency columns you want to format
* This will create a model attribute like 'formatted_value'
* 'value' is the name of the column in your dabase
*
* @var array
*/
protected $currencyColumns = [
'payroll' => [
'attr_prefix' => 'formatted_',
'prefix' => 'US$ ',
'decimal' => ',',
'thousand' => '.',
'precision' => 2
]
];
//...
}The key of the array $currencyColumns should be the same name of the column that will be formatted
<?php
use IgorTrinidad\ModelUtilities\Traits\UpperCaseFirst;
use IgorTrinidad\ModelUtilities\Traits\FormatCurrency;
class Product extends Model {
use UpperCaseFirst, FormatCurrency;
/**
* The columns that should be applied Upper Case for the first char
* This trait will format the columns that should be Upper before saving in db
*
* @var array
*/
protected $upperCaseFirst = [
'name',
];
/**
* The currency columns you want to format
* This will create a model attribute like 'formatted_value'
* 'value' is the name of the column in your dabase
*
* @var array
*/
protected $currencyColumns = [
'value' => [
'attr_prefix' => 'formatted_',
'prefix' => 'US$ ',
'decimal' => ',',
'thousand' => '.',
'precision' => 2
],
'discount' => [
'attr_prefix' => 'formatted_',
'prefix' => 'US$ ',
'decimal' => ',',
'thousand' => '.',
'precision' => 2
]
];
/**
*
* Or use with global config settings config/model-utilities.php
* @var array
*/
protected $currencyColumns = [
'value', 'discount
];
}This trait doesn't change the value of the model on saving or updating, just create the attributes 'formatted_value' and 'formatted_discount' for the model after ::retrieved the model from the database
Add trait to the model and set the fields that should be formatted:
<?php
use IgorTrinidad\ModelUtilities\Traits\FormatDate;
class User extends Model {
use FormatDate;
/**
* The currency columns you want to format
* This will create a model attribute like 'formatted_value'
* 'value' is the name of the column in your dabase
*
* @var array
*/
protected $dateColumns = [
'bday' => [
'unformatted' => 'Y-m-d', //Default unformat date format
'formatted' => 'd/m/Y' // Default formatted date format
]
];
/**
*
* Or use with global config settings config/model-utilities.php
* @var array
*/
protected $dateColumns = [
'bday'
];
}Add uuid to the ID column for the model, setting the incrementing to false
<?php
use IgorTrinidad\ModelUtilities\Traits\Uuid;
class User extends Model {
//Just add the trait inside your model
use Uuid;
//The rest of your model
}This trait use Ramsey Uuid::uuid4 the same as Laravel Str::uuid to generate the uuid
/**
* Run the migrations.
*
* @return void
*/
public function up()
{
Schema::create('users', function (Blueprint $table) {
$table->uuid('id');
$table->string('name');
$table->string('email')->unique();
$table->timestamp('email_verified_at')->nullable();
$table->string('password');
$table->rememberToken();
$table->timestamps();
});
}If you wish you could use the functions of ModelUtilities stand-alone too
use IgorTrinidad\ModelUtilities\ModelUtilities;
$value = 1234.32;
$currency = ModelUtilities::formatCurrency($value, 'R$ ', 2, ',', '.');
This output the formatted value: 'R$ 1.234,32';
ModelUtilities::formatCurrency($value, $currencySettings);
ModelUtilities::formatDate($date, $dateSettings);
ModelUtilities::titleCase($string);
ModelUtilities::upperCaseFirst($string);
ModelUtilities::fullName($first_name, $last_name);
ModelUtilities::sanitizeEmail($email);- Igor Trindade - Developer
- github.com/igortrinidad
- https://igortrindade.dev
git clone https://github.com/igortrinidad/laravel-model-utilities.git
cd laravel-model-utilities
composer install
vendor/bin/phpunit --testdox
This project is licensed under the MIT License - see the LICENSE file for details.
- v1.2.4
- Initial release.
- Added config file to code reuse for formatCurrency and formatDate methods
- Added FullName trait and function
- Added UpperCaseFirst trait and tests