landofcoder/module-cleanup

The module archives and removes old files.

1.0.1 2022-12-13 05:27 UTC

Requires

• ext-zlib: *

MIT

README

The module archives and removes old entities. It supports log files, unused product images and quotes.

What it does

For files it basically replaces logrotate. It archives and compresses log files and cleans up the archive folder after a configurable period. For product images it finds unreferenced files in media/catalog/product and moves them to a recycle bin which gets purged after a configurable period. For quotes it simply removes customer and guest quotes after a configurable period.

How it works

The module provides a cron job and a shell command to execute the cleanup jobs. Those jobs are implemented as "handlers" which clean up a specific entity. The set of bundled handlers can be easily extended by custom handlers via di.xml. A resolver will then expose configured handlers to the cron job and the shell command which then can execute the cleanup without additional configuration.

New handlers need to implement the HandlerInterface and be registerdto the handlerPool using di.xml.

How to use

1. Install the module via Composer:

composer require landofcoder/module-cleanup

1. Enable it bin/magento module:enable Lof_Cleanup

2. Install the module and rebuild the DI cache bin/magento setup:upgrade

3. Run all clean up via command bin/magento lof:cleanup:run

4. Run clean up unused product images bin/magento lof:cleanup:clean-images

How to configure

Find the modules configuration in the Landofcoder section of your Magento configuration.