Skip to content

Latest commit

 

History

History
73 lines (38 loc) · 2.53 KB

readme.textile

File metadata and controls

73 lines (38 loc) · 2.53 KB
Raw

Cache Buster

An ExpressionEngine plugin that adds a simple cache buster to your flat file references

Compatibility

  • ExpressionEngine 1.6.x
  • ExpressionEngine 2.x

Installation

Note: The same file is used for both ExpressionEngine 1 and ExpressionEngine 2.

  • ExpressionEngine 1.6.x: Upload the /system/expressionengine/third_party/cache_buster/pi.cache_buster.php file to the system/plugins directory.
  • ExpressionEngine 2.x: Upload the /system/expressionengine/third_party/cache_buster directory to the system/expressionengine/third_party directory.

Purpose

Using ExpressionEngine’s CSS template provides a nice cache buster string of the most recent time
the template was saved to the database. This is quite handy but still requires EE to process the template.

This plugin will take a file path and use PHP to check the modification time returning a cache busting
string like ExpressionEngine’s. This allows you to server flat files from your server without having
ExpressionEngine’s template parser run through the code first. It is very simple to use.

Usage

There are 3 parameters. One is required and the other two are optional.

{exp:cache_buster file="/css/style.css"}

This will return

/css/style.css?v=1266264101

Where “1266264101” is the UNIX timestamp of the last time /css/style.css was saved to the server.

You can change the separator between the file and the timestamp with the use of separator="" in the tag.

{exp:cache_buster file="/css/style.css" separator="?"}

This will return

/css/style.css?1266264101

Server Root

If your file isn’t being read by the plugin then the server root might not be the right path. The plugin assumes that your file will reside on your server’s DOCUMENT_ROOT variable. If this is not accurate you can manually define the root with the root_path parameter. Do not include a trailing slash.

{exp:cache_buster file="/css/style.css" root_path="/home/mysite/subdirectory/templates"}

Change Log

Feb 17th, 2011: 1.1.1

  • Bug: Fixed bug where root_path wasn’t set correctly

Mar 27th, 2010: 1.1.0

  • Feature: added root_path parameter for manually entering server root
  • Feature: EE2.x compatibility added

Mar 27th, 2010: 1.0.1

Feb 15th, 2010: 1.0.0

  • Initial Release