Package =On this page:
package TWiki::EngineThe engine class is a singleton that implements details about TWiki's execution mode. This is the base class and implements basic behavior. Each engine should inherits from this and overload methods necessary to achieve correct behavior.ObjectMethod CRLF () -> $crflUtility constant. Defined as sub thus can be used from children objects.ClassMethod new () -> $engineConstructs an engine object.ObjectMethod run ()Start point to TWiki Runtime Engines.ObjectMethod prepare () -> $reqInitialize a TWiki::Request object by calling many preparation methods and returns it, or a status code in case of error.ObjectMethod *prepareConnection ($req)Abstract method, must be defined by inherited classes.
$req object.
ObjectMethod *prepareQueryParameters ($req,$queryString)Should fill $req's query parameters field. This method populates $req as it should if given $queryString parameter. Subclasses may redefine this method and call SUPER with query string obtained.ObjectMethod prepareHeaders ($req)Abstract method, must be defined by inherited classes.
ObjectMethod preparePath ($req)Abstract method, must be defined by inherited classes.
ObjectMethod prepareCookies ($req)
ObjectMethod prepareBody ($req)Abstract method, must be defined by inherited classes.
ObjectMethod *prepareBodyParameters ($req)Abstract method, must be defined by inherited classes.
ObjectMethod prepareUploads ($req)Abstract method, must be defined by inherited classes.
ObjectMethod finalize ($res,$req)Finalizes the request by calling many methods to send response to client and take any appropriate finalize actions, such as delete temporary files.
ObjectMethod finalizeUploads ($res,$req)Abstract method, must be defined by inherited classes.
ObjectMethod finalizeError ($res)Called if some engine especific error happens.
ObjectMethod finalizeHeaders ($res,$req)Base method, must be redefined by inherited classes. For convenience this method deals with HEAD requests related stuff. Children classes should call SUPER.
ObjectMethod finalizeCookies ($res)
ObjectMethod finalizeBody ($res)
write()
as needed, sou engines should redefine that method insted of this one.
ObjectMethod prepareWrite ($res)Abstract method, must be defined by inherited classes.
ObjectMethod write ($buffer)Abstract method, must be defined by inherited classes.
|