aquarium.urlscheme.QueryParameters.QueryParameters

Package aquarium :: Package urlscheme :: Module QueryParameters :: Class QueryParameters

[show private | hide private]

Class QueryParameters

AquariumClass --+
                |
               QueryParameters

Known Subclasses:: PathInfo, ScriptName

This URL scheme is based on query parameters.

I.e. the name of the screen is set via a GET or POST variable named screen. Furthermore, there is only entry point to the site usually named index.py which is in the root directory of the site. This is appropriate for CGI situations, etc.

See aquarium.urlscheme.UrlSchemeAPI.

Method Summary
	`__init__(self, ctx)` Extend `__init__` to handle proxying.
	`addSid(self, vars)` Add the sid to a given dictionary of `vars`, if appropriate.
	`addVars(self, url, vars)` Add the given vars to the url and return it.
	`getDefaultScheme(self)` Return the default scheme, either `http://` or `https://`.
	`getPort(self, scheme)` Given a scheme, return the port string, as appropriate.
	`getRootUrl(self, secure)` Figure out the URL for the root of this site.
	`getScheme(self, secure)` Return `http://` or `https://`.
	`hiddenFormFields(self, screen, vars)` Return necessary hidden form fields.
	`img(self, img, secure)` Return an URL to an image.
	`screen(self, screen, vars, secure)` Return a dynamic URL for the given screen.
	`static(self, file, secure)` Return an URL for something relative to the root URL.
	`whichScreen(self)` Which screen does the user want to view?

Method Details

init(self, ctx)
(Constructor)

Extend __init__ to handle proxying.

If present, use the X_FORWARDED_HOST header (i.e. cgiEnv["HTTP_X_FORWARDED_HOST"]) in order to override ``cgiEnv["SERVER_NAME"] and cgiEnv["SERVER_PORT"].

Overrides:: aquarium.util.AquariumClass.AquariumClass.__init__

addSid(self, vars)

Add the sid to a given dictionary of vars, if appropriate.

addVars(self, url, vars)

Add the given vars to the url and return it.

This will also take care of calling addSid.

getDefaultScheme(self)

Return the default scheme, either http:// or https://.

The default scheme is the scheme currently in use.

getPort(self, scheme)

Given a scheme, return the port string, as appropriate.

Naturally, the string is not necessary for HTTP or HTTPS when they're on the canonical ports.

If scheme given is the same as the current scheme, make use of cgiEnv["SERVER_PORT"]. If it isn't, then I don't know what port to use. If properties.HTTP_PORT or properties.HTTPS_PORT exists, I'll use those as appropriate. Otherwise, I'll have to fall back to their canonical values.

getRootUrl(self, secure=-1)

Figure out the URL for the root of this site.

getScheme(self, secure=-1)

Return http:// or https://.

Interpret secure like aquarium.urlscheme.UrlSchemeAPI.getRootUrl.

hiddenFormFields(self, screen, vars=None)

Return necessary hidden form fields.

img(self, img, secure=-1)

Return an URL to an image.

screen(self, screen, vars=None, secure=-1)

Return a dynamic URL for the given screen.

static(self, file, secure=-1)

Return an URL for something relative to the root URL.

whichScreen(self)

Which screen does the user want to view?

Generated by Epydoc 2.1 on Mon Jan 1 16:34:19 2007

http://epydoc.sf.net