PET::Dispatcher

sub new

Constructor method.

Parameters: %p, which currently only holds ‘basedir’.  Calls _init, and sets $BASEPATH.

sub _init

Inits some default stuff.  Actually lots of default stuff... very expensive, only called at init time.  This: set $DOCROOT, calls _fetchGlobals, sets <$FILTERS>, creates $TEMPLATE, creates $UTIL, creates $SESSION, calls <_startCache>, and inits the API (if any)

sub _fetchGlobals

sub _globalPostprocess

sub _initAPI

Instanteniates the chosen (global.conf) actionmapper.  This mapper in turn inits the API (calls the mapper’s “init” method).

sub _fileUnchanged

sub _start

sub _fillQuery

sub setHeader

Sets header(s).  Overrides key with value if already present.

sub addHeader

Adds header to output HTTP header.  Makes scalar => array if multiple values should be set (e.g. for cookies).

sub self_url

Calls the same method of CGI::Simple if ‘full’ is given, otherwise uses REQUEST_URI (default).  If ‘encode’ is true, then makes it URLEncode-d.

sub setRC

sub setContentType

sub setAttr

sub getAttr

sub doRequest

sub compilePetAndRun

sub logPerf

sub preprocessTemplate

We run the template preprocess phase here. general/template/filters stores the list of modules (defined by their name) here.  They are initied at _init().  The order is important!  We check for .pet chanes -- if they change, we re-run the filter, otherwise they are considered unchanged.

Returns: a filename (name of the new, generated file).

This mechanism is used to change .pet files “on the fly”.  This is used for example by multilingual modules to generate the localized version of the given template.

sub getDefaultSubsts

sub _startCookie

sub getCookie

sub cookieOnce

Set a cookie.  Returns 1 if it was already set.  Should move this to something like UTIL::HTML or something.

sub setCookie

A method to create (and “emit’) a cookie.  Often called from external modules, or from the template directly.  Uses CGI::Simple::Cookie almost directly, so most parameters are identical to the parameters passed to the new() method of the above module.

The cookie string is added to the headers, and are set when the page is emitted (even if it is a redirect).

Mandatory parameters

Optional parameters

Note that we do not do any real syntax/semantic checking here.

sub deleteCookie

Deletes the name cookie.

sub _initcache

If there is a cache/class, then we init it!

sub apck

Auto Page Cache Key.  See documentation for explanation!

sub toCache

sub fromCache

sub getRealUrl

sub getGconf

sub getConf

Get a config value from global.conf.  The <pages> part overrides all default settings!  (FIXME) This is always a VALUE, never a NODE, as NODE-s are not MERGE-d!!!!

sub setConf

sub _getLastMod

Returns the “last modification time” (mtime) of the given file.  Returns undef if there is no such file...

sub getSession

Shortcut to return a given Session value (if sessions are enabled).  This just calls the Session object (set in global.conf).

sub setSession

Shortcut to access the setter method of the implementing Session object.

sub getSessionId

sub invalidateSession

sub getSessionObject

Returns the Session object, if any.

sub getBASEPATH

This is an accessor, that returns the $BASEPATH value.

sub getLog

This is an accessor, that returns the $LOG value, which is a PET::Log

Returns the already instanteniated PET::Dispatcher object.

sub getUtil

sub getUtilHash

sub getPageKey

Returns the current key for this page (generated from the URL).  This is something like “index” or “foo/bar”.

sub reloadModule

(Re)loads a (Perl) module using “require”.

We use this to load modules at runtime (so BEGIN blocks are not run).  The module name is passed as a string.  When in debug mode, reloadModule actually reloads the named module (first deleting it from %INC).  Returns: 1 -> (re)loaded, 0 -> already loaded, -1 -> compilation error Compilation error is only logged at the error_log.  The return value basically shows if we have to re-init the module or not.

sub getCACHE

sub get500

sub skipOn

Cache-control, skipon tag.  This string is used to determine if we should skip caching for the named page.  E.g. a main page of a site is cached, except for when a “login” button is pressed.  The format is: “$key.$subkey”, e.g.  ‘form.login’ FIXME : this should DWIM, now it is rather plain...

sub servePetAdmin