Carwash is a data scrubbing utility for Laravel applications
composer require swisnl/carwash
php artisan vendor:publish
<?php
return [
'users' => [
'first_name' => 'firstName',
'last_name' => 'lastName',
'email' => 'safeEmail'
],
'addresses' => [
'street' => 'streetAddress',
'city' => 'city',
'zip' => 'postcode'
],
'bios' => [
'content' => 'sentences:2'
]
];Carwash uses the fabulous Faker package under the hood to generate replacement data. Please refer to the Faker documentation for a complete list of available formatters.
More generally, the format of the Carwash config file is:
<?php
return [
'[TABLE_NAME]' => [
'[COLUMN_NAME]' => '[Faker Formatter][:argument1,argument2]'
]
];php artisan carwash:scrub
Instead of passing a Faker Formatter as the value for each field in your Carwash config file, alternatively you can set the field value to a Callable that returns the new field value. This closure will receive an instance of Faker and the current value of the attribute being scrubbed.
<?php
return [
'users' => [
'name' => function ($faker, $currentValue) {
return "{$faker->firstName} {$faker->lastName}";
},
'bio' => BioFormatter::class
]
];
class BioFormatter
{
public function __invoke($faker)
{
return $faker->sentences(42);
}
}Callables can also replace entire table configurations allowing full control over what data is scrubbed and how.
<?php
return [
'users' => function ($faker, $user) {
$firstName = $faker->firstName;
$lastName = $faker->lastName;
return [
'first_name' => $firstName,
'last_name' => $lastName,
'email' => $firstName . "." . $lastName. "@" . $faker->safeEmailDomain,
'phone' => substr($user['phone'], 0, 3) . "-555-" . $faker->randomNumber(4)
];
},
];$ composer testIf you discover any security related issues, please email [email protected] instead of using the issue tracker.
This package is a fork of dansoppelsa/carwash with updated Laravel support.
The MIT License (MIT). Please see License File for more information.