Download the PHP package maize-tech/laravel-prunable-fields without Composer

Laravel Prunable Fields

[](https://packagist.org/packages/maize-tech/laravel-prunable-fields) [](https://github.com/maize-tech/laravel-prunable-fields/actions?query=workflow%3Arun-tests+branch%3Amain) [](https://github.com/maize-tech/laravel-prunable-fields/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain) [](https://packagist.org/packages/maize-tech/laravel-prunable-fields) This package allows you to clean model fields with an easy command. The feature is highly inspired by Laravel's Prunable core feature, and allows you to easily adapt all your existing models. ## Installation You can install the package via composer: You can publish the config file with: This is the contents of the published config file: ## Usage ### Prunable models To use the package, simply add the `Maize\PrunableFields\PrunableFields` trait to all models you want to clean. Once done, you can define the list of attributes who should be cleaned up by implementing the `$prunable` class property. The array key should be the attribute name, whereas the array value should be the value you want the attribute to be updated to. After that, implement the `prunableFields` method which should return an Eloquent query builder that resolves the models that should be cleaned up. If needed, you can also override the `pruningFields` and `prunedFields` methods (which are empty by default) to execute some actions before and after the model is being updated. Here's an example model including the `PrunableFields` trait: All you have to do now is including the model's class name in `models` attribute under `config/prunable-fields.php`: That's it! From now on, the `model:prune-fields` command will do all the magic. In our example, all users created before the current day will be updated with a null value for both `first_name` and `last_name` attributes. ### Mass prunable models When using the `MassPrunableFields` trait all models will be updated with a raw database query. In this case, `pruningFields` and `prunedFields` methods will not be invoked, and models will not fire the `updating` or `updated` events. This way there is no need to retrieve all models before updating them, making the command execution way faster when working with a large number of entries. ### Scheduling models cleanup The package is pretty useful when you automatize the execution of the `model:prune-fields` command, using Laravel's scheduling. All you have to do is add the following instruction to the `schedule` method of the console kernel (usually located under the `App\Console` directory): By default, when executing the `model:prune-fields` command the package will take all prunable models specified in `models` attribute under `config/prunable-fields.php`. If you want to restrict the model list you want to automatically clean up, you can pass the `--model` option to the command: Alternatively, you can clean up all models listed in your config and exclude some of them with the `--execpt` command option: ## Testing ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Contributing Please see [CONTRIBUTING](https://github.com/maize-tech/.github/blob/main/CONTRIBUTING.md) for details. ## Security Vulnerabilities Please review [our security policy](https://github.com/maize-tech/.github/security/policy) on how to report security vulnerabilities. ## Credits - [Riccardo Dalla Via](https://github.com/riccardodallavia) - [All Contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.