This cache module is desiged to cache files generated by various MidCOM code generation system.

This includes:

• DBA Intermediate classes (Namespace midcom.dba)
• Component Manifest (Namespace midcom.componentloader)

The cached scripts are invalidated based on their timestamp. Whenever you load a script from the cache, you have to pass a last modified timestamp to it. This stamp is compared with the modification date of the script file, leading to automatic invalidation in case of outdated script files.

Each cached script must have an identifier, which must be namespaced according to the MidCOM namespacing conventions. Identifiers may consist of any valid filename character, a .php extension is appended automatically on all operations, you should not do that yourself. Namespace and local identifier should be separated by a dash. While adding, you do not need to add the PHP opening / closing tags to the source code, it will be done automatically during cache file creation.

Both the load and add operations will automatically require_once() the script file after successful completion.

Danger, Will Robinson:

You should be aware, that the module in itself has no separation of sites whatsoever, as these scripts are usually valid for an entire installation. In case your application needs to cache scripts per-site or per-content-tree, you need to ensure the uniqueness of the cache identifiers yourself, for example by adding the corresponding GUIDs.