You are here

Home » API reference » Cleaner 5

README.txt in Cleaner 5

Same filename and directory in other branches
  1. 6 README.txt
INTRODUCTION
------------
The Cleaner module allows the admin to set a schedule for clearing caches, watchdog, and old sessions.

There are function in Drupal which will cause "expired" entries in some cache tables to be deleted.
This is vastly improved in Drupal 6. "Minimum_cache_liftime" is a partial solution, but still not
totally complete. 

There are still times and/or cache tables that don't get cleared in any of those scenarios. Many
sites will not be impacted by this, but a few will (just search on drupal.org and you will see many
posts from people having problems).

INSTALLATION
------------
Standard module installation applies.

SETTINGS
--------
The module will do nothing until you enable its clearing functions (for your own protection).

The module settings can be found at Administer >> Site configuration >> Cleaner.

1. Select the frequency (interval) at which it will run. Note that the Cron settings may change
   the actual frequency of execution.
2. Select which clearing functions you desire.

LOGGING
-------
This module will log its actions.

EXTENDING THE MODULE
--------------------
This module can be hooked into to extend its functionality.
I'm not sure why you would want to do this rather than code your own, but it's there.

hook_cleaner_settings()
  Returns the useful part of a settings form as a keyed array, with the key being the module name.
  See cleaner_cleaner_settings().

hook_cleaner_run()
  Called when Cron triggers the site (run-time).
  There are no calling parameters or returns.
  See cleaner_cleaner_run().

File

README.txt
View source 
  1. INTRODUCTION

  2. ------------

  3. The Cleaner module allows the admin to set a schedule for clearing caches, watchdog, and old sessions.

  4. 

  5. There are function in Drupal which will cause "expired" entries in some cache tables to be deleted.

  6. This is vastly improved in Drupal 6. "Minimum_cache_liftime" is a partial solution, but still not

  7. totally complete. 

  8. 

  9. There are still times and/or cache tables that don't get cleared in any of those scenarios. Many

  10. sites will not be impacted by this, but a few will (just search on drupal.org and you will see many

  11. posts from people having problems).

  12. 

  13. INSTALLATION

  14. ------------

  15. Standard module installation applies.

  16. 

  17. SETTINGS

  18. --------

  19. The module will do nothing until you enable its clearing functions (for your own protection).

  20. 

  21. The module settings can be found at Administer >> Site configuration >> Cleaner.

  22. 

  23. 1. Select the frequency (interval) at which it will run. Note that the Cron settings may change

  24.    the actual frequency of execution.

  25. 2. Select which clearing functions you desire.

  26. 

  27. LOGGING

  28. -------

  29. This module will log its actions.

  30. 

  31. EXTENDING THE MODULE

  32. --------------------

  33. This module can be hooked into to extend its functionality.

  34. I'm not sure why you would want to do this rather than code your own, but it's there.

  35. 

  36. hook_cleaner_settings()

  37.   Returns the useful part of a settings form as a keyed array, with the key being the module name.

  38.   See cleaner_cleaner_settings().

  39. 

  40. hook_cleaner_run()

  41.   Called when Cron triggers the site (run-time).

  42.   There are no calling parameters or returns.

  43.   See cleaner_cleaner_run().