CaRP: Caching RSS Parser - Manual
Version 3.5.4 (10/7/2004)
Configuration is done by changing the values in the array $carpconf. You may change the defaults by modifying carp.php itsself. You may override the defaults for a particular RSS feed by inserting lines like "CarpConf('cachepath','/my/private/cache/path');" after the line where you "require_once" CaRP, and before calling CarpShow().
Version 3.5.4 (10/7/2004)
NOTE: This version of CaRP is obsolete. This documentation is being left here for those who have not yet upgraded to the current version.
Download | Installation | Configuration | Upgrading from version 2 | Functions | Examples | Donations
Old documentation: Version 2
ConfigurationConfiguration is done by changing the values in the array $carpconf. You may change the defaults by modifying carp.php itsself. You may override the defaults for a particular RSS feed by inserting lines like "CarpConf('cachepath','/my/private/cache/path');" after the line where you "require_once" CaRP, and before calling CarpShow().
The following options are defined in $carpconf, and are color-coded based on the likelihood that you'll want to change them, as follows: usually changed, often changed, sometimes changed, rarely changed
Cache Control |
Content-Based Filtering |
Display Formatting |
Miscellaneous |
Network Connection |
XML Encoding
Cache Control:
- cacheinterval: The number of minutes before the cached file expires and the remote RSS feed is refetched
- cacheerrorwait: The number of minutes to wait before refreshing the cache if an error occurs while attempting to fetch or parse it. Note that when using the cachetime setting below, this could result in the cache not being updated for an entire day.
- cachetime: The time of day after which the cached file expires and the remote RSS feed is refetched. If this is blank (the default), cacheinterval is used instead. If this is set, cacheinterval is ignored. Specify the time as "H:M", where "H" is the hour in 24 hour format, and "M" is the minute. Be sure to specify the time in your server's time zone, which may be different from your time zone.
- cachepath: The path to the directory where your cache directories will be located.
- cacherelative: This setting controls how CaRP interprets the value of cachepath. If cacherelative is "0", then cachepath must either be an absolute path or a path relative to the location of the PHP file being loaded by the web browser. If cacherelative is "1", then cachepath is relative to the location of CaRP itsself.
- autocacheprefix: This is a prefix which is added to the filenames of cache files created by CarpCacheShow and CarpCacheFilter. By default, it is "autocache/", which results in the files being saved in a subdirectory of the rsscache directory. (Removed from version 3.5 when the cache directory structure was modified)