Install and setup     >     Configuration

cache.xml

yeager features a lazy load caching mechanism, which will cache Pages after they have been accessed.  
 
To turn on caching in general you need to set the CACHE->FRONTEND setting in your configuration file to true. The cache.xml files includes rules which are  considered when writing or invalidating the cache. 
 
yeager will not cache any POST requests.
  
  1. <?xml version="1.0"?>
  2. <!-- <?php die(); ?> -->
  3. <CONFIG>
  4.     <PAGE type="file">
  5.         <URIS>
  6.             <PATTERN URI="/.*closed.+profile.*/" KEY="None" />
  7.             <PATTERN URI="/(.*)/" TTL="86400" KEY="UserGroup" />
  8.         </URIS>
  9.     </PAGE>
  10.     <INVALIDATEON>
  11.         <PAGE_PUBLISH>true</PAGE_PUBLISH>
  12.         <FILE_PUBLISH>true</FILE_PUBLISH>
  13.         <CBLOCK_PUBLISH>true</CBLOCK_PUBLISH>
  14.         <MAILING_PUBLISH>true</MAILING_PUBLISH>
  15.         <PAGE_DELETE>true</PAGE_DELETE>
  16.         <FILE_DELETE>true</FILE_DELETE>
  17.         <CBLOCK_DELETE>true</CBLOCK_DELETE>
  18.         <MAILING_DELETE>true</MAILING_DELETE>
  19.         <TAG_DELETE>true</TAG_DELETE>
  20.         <TAG_RENAME>true</TAG_RENAME>
  21.         <COMMENT_ADD>false</COMMENT_ADD>
  22.         <COMMENT_REMOVE>false</COMMENT_REMOVE>
  23.         <COMMENT_CHANGE>false</COMMENT_CHANGE>
  24.         <COMMENT_SETNOSPAM>false</COMMENT_SETNOSPAM>
  25.         <COMMENT_SETSPAM>false</COMMENT_SETSPAM>
  26.         <COMMENT_APPROVE>false</COMMENT_APPROVE>
  27.         <EXTENSION_INSTALL>true</EXTENSION_INSTALL>
  28.         <EXTENSION_UNINSTALL>true</EXTENSION_UNINSTALL>
  29.         <PERMISSION_CHANGE>true</PERMISSION_CHANGE>
  30.         <PNAME_CHANGE>true</PNAME_CHANGE>
  31.         <PROPERTY_CHANGE>true</PROPERTY_CHANGE>
  32.         <TEMPLATE_CHANGE>true</TEMPLATE_CHANGE>
  33.     </INVALIDATEON>
  34. </CONFIG>

Patterns

Each PATTERN configured in the PAGE->URIS block reflects one cache. It is defined by following attributes:
 
URI
  
  
The URL pattern (regular expression) for which caches will be created. /(.*)/ for instance will consider all requests made to the domain. 
 
TTL

  
Configures the maximum life time of a cache in seconds. After this time the cache will get invalidated regardless if one of the above actions were performed. 
  
KEY
 
  
Configures if yeager will create a cache for this pattern per Usergroup (the combination of Usergroups a User is part of) or per User. If set to None the URL will not be cached.
  

Invalidation

The INVALIDATEON block contains a couple of actions which may be set to true or false. If set to true yeager's cache will get  invalidated when the respective action is performed. 

 
PAGE_PUBLISH
  
Invalidates the cache when a Page gets published
  
FILE_PUBLISH
  
Invalidates the cache when a File gets published (updated) 
  
CBLOCK_PUBLISH
  
Invalidates the cache when a Content Block gets published
  
MAILING_PUBLISH
  
Invalidates the cache when an E-Mailing gets published
  
PAGE_DELETE
  
Invalidates the cache when a Page gets deleted
 
FILE_DELETE
  
Invalidates the cache when a File gets deleted
 
CBLOCK_DELETE
  
Invalidates the cache when a Content Block gets deleted

MAILING_DELETE
  
Invalidates the cache when a Mailing gets deleted
 
TAG_DELETE
  
Invalidates the cache when a Tag gets deleted
  
TAG_RENAME
  
Invalidates the cache when a Tag gets renamed
 
COMMENT_ADD
  
Invalidates the cache when a comment gets added
  
COMMENT_REMOVE
  
Invalidates the cache when a comment gets removed
  
COMMENT_CHANGE
  
Invalidates the cache when a comment gets changed
  
COMMENT_SETNOSPAM
  
Invalidates the cache when a comment gets marked as no spam
  
COMMENT_SETSPAM
  
Invalidates the cache when a comment gets marked as spam
  
COMMENT_APPROVE
  
Invalidates the cache when a comment gets approved
  
EXTENSION_INSTALL
  
Invalidates the cache when an Extension gets installed
  
EXTENSION_UNINSTALL
 
Invalidates the cache when an Extension gets uninstalled
  
PROPERTY_CHANGE
  
Invalidates the cache when a property of any object changes
  
TEMPLATE_CHANGE
  
Invalidates the cache when a Page Template gets changed
  
PNAME_CHANGE
  
Invalidates the cache when the permanent name (URL name) of an object gets changed