OIL2 Class Standard.HTTPreplacedText

class Standard . HTTPreplacedText {
} inherits from HTTPcachedObject;

DESCRIPTION

The HTTPcachedFile class implements the standard means for caching dynamically generated data that is to be provided via the HTTPdaemon.

METHODS

Standard.HTTPreplacedText:create

HTTPreplacedText:create(oid urlDir, string pageData, string mimeType, assoc substitutions, string name)

Method Description

See initialize.

Standard.HTTPreplacedText:initialize

HTTPreplacedText:initialize(oid urlDir, string pageData, string mimeType, assoc substitutions, string name, optional any validForSeconds)

Method Description

The create method takes a minimum of 4 arguments.

the object Id of the URLdirectory object associated with the site
an string representing the contents of the template document. The data to be cached will be the result obtained after any needed server-side-include processing is performed
a string specifying the MIME type of the document (typically, this will be "text/html" for most documents handled in this fashion).
an associative array of environment variables, typically used for server-side-include processing.

The fifth and any additional arguments are strings. Each represents a name under which the cached object will be registered with the URLdirectory by some external entity.

Notes

A HTTPcachedFile does not actually register itself with the URLdirectory. This must be performed by the application that creates the HTTPcachedFile object. This provides the opportunity to control when a cached object becomes visible. The names are recorded so that when the HTTPcachedFile object is deleted, the appropriate entries can be unregistered with the URLdirectory.