README

A simple package to sanitize model data to create/update table records.

Installation

Require the package using composer:

composer require touhidurabir/laravel-model-sanitize

What is does ?

The Sanitize package sanitize the passed attributes to proper model fillables at create or update.

A model has table schema based multiple attributes associated with it. When we try to create a new model record or update an existing model record, we must provide the an array attributes that is propelry mapped to those arrtibute or table columns names . For example

$user = User::create([
    'email' => 'somemail@test.com',
    'password' => Hash::make('password')
]);

The above code will run without any issue as both the email and password column presents in the users table . But for the following code

User::create([
    'email' => 'somemail@test.com', 
    'password' => 'password', 
    'data' => 'some data'
]);

It will throw an \Illuminate\Database\QueryException if the data column not present in the users table.

Illuminate\Database\QueryException: SQLSTATE[HY000]: General error: 1 table users has no column named data (SQL: insert into "users" ("email", "password", "data", "updated_at", "created_at") values (somemail@mail.com, password, data, 2021-11-14 20:11:04, 2021-11-14 20:11:04))

The Sanitize package target to make it easier to handle such case as follow by including the Sanitizable trait in the models

$data = [
    'email' => 'somemail@test.com', 
    'password' => 'password', 
    'data' => 'some data'
];

User::create($data);

The above code will work if the Sanitizable trait is used in the User model class. it will sanitize the passed attributed to model fillables and table columns, thus removing the extra or non useable attributes from it .

How it will be helpful ?

A great use case of this package is where one need to create multiple model instances from validated request data . For example

$validated = $request->validated();

$user = User::create($validated);

$profile = $user->profile->create($validated);

I personally use this appraoch in many of my laravel apps .

Usage

Use the trait Sanitizable in model where uuid needed to attach

use Touhidurabir\ModelSanitize\Sanitizable;
use Illuminate\Database\Eloquent\Model;

class User extends Model {
    
    use Sanitizable;
}

And thats all . it will automatically work for all the following methods

updateOrCreate
firstOrCreate
firstOrNew
create
forceCreate
update

This package also includes some helper methods that can be used to handle the sanitization process manually.

The sanitize static method will sanitize the given attributes list and retuen back the useable and valid attributes as an array

$data = [
    'email' => 'somemail@test.com', 
    'password' => 'password', 
    'data' => 'some data', 
    'name' => 'Test User'
];

User::sanitize($data);

This will return back as such :

[
    'email' => 'somemail@test.com', 
    'password' => 'password', 
    'name' => 'Test User'
]

The gibberish static method will sanitize the given attributes list and retuen back the gibberish/non userbale attributes as an array

$data = [
    'email' => 'somemail@test.com', 
    'password' => 'password', 
    'data' => 'some data', 
    'name' => 'Test User'
];

User::gibberish($data);

This will return back as such :

[
    'data' => 'some data', 
]

The sanitize and gibberish methods can be used to check or manually sanitize and evaluate the in valid data that can be passed to create/update model records.

It is also possible to disable/enable the sanitization process at the runtime using the static methods disableSanitization and enableSanitization . For example,

User::disableSanitization(); // disable the sanitization process
User::enableSanitization();  // enable the sanitization process if previously disabled

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

touhidurabir / laravel-model-sanitize

Maintainers

Details