CacheClear Snippet Tutorial

I could tell you how many hours it takes to develop a MODX extra Transport Package complete with a build script, properties, multiple MODX elements, internationalized strings, error checks, and then fully test it, but you wouldn't believe me. If you use this extra and like it, please consider donating. The suggested donation for this extra is $5.00, but any amount you want to give is fine (really). For a one-time donation of $50.00 you can use all of my non-commercial extras with a clear conscience.


PayPal

CacheClear is an extra for MODX Revolution that deletes all files in the MODX core/cache directory. It is for people who may not have shell or FTP access to a site or who want a fast and convenient way to completely empty the cache in the MODX Manager. I use it often while developing extras.

Installing CacheClear

Go to System | Package Management on the main menu in the MODX Manager and click on the "Download Extras" button. That will take you to the Revolution Repository (AKA Web Transport Facility). Put CacheClear in the search box and press Enter. Click on the "Download" button, and when it changes to "Downloaded," click on the "Finish" button. That should bring you back to your Package Management grid. Click on the "Install" button next to CacheClear in the grid. The CacheClear package should now be installed.

Usage

To use CacheClear, just view the CacheClear Resource. You should see a progress report indicating the cache subdirectories that are being removed.

Note that if you look at the cache on the Files tab in the Manager, it will appear that the files have not been deleted because MODX regenerates the directories almost immediately. ClearCache tests for the removal of each directory and will report any failures. If you don't see any failure messages when CacheClear runs, you can assume that it deleted all the directories and files in the cache.

 

My book, MODX: The Official Guide - Digital Edition is now available here. The paper version of the book is available from Amazon.

If you have the book and would like to download the code, you can find it here.

If you have the book and would like to see the updates and corrections page, you can find it here.

MODX: The Official Guide is 772 pages long and goes far beyond this web site in explaining beginning and advanced MODX techniques. It includes detailed information on:

  • Installing MODX
  • How MODX Works
  • Working with MODX resources and Elements
  • Using Git with MODX
  • Using common MODX add-on components like SPForm, Login, getResources, and FormIt
  • MODX security Permissions
  • Customizing the MODX Manager
  • Using Form Customization
  • Creating Transport Packages
  • MODX and xPDO object methods
  • MODX System Events
  • Using PHP with MODX

Go here for more information about the book.

Thank you for visiting BobsGuides.com

  —  Bob Ray