Big Sister Web Application Framework
List of all members
BigSWAF::ApplicationStatic Class Reference
Inheritance diagram for BigSWAF::ApplicationStatic:
BigSWAF::Application

Public Member Functions

Public Object Methods
retval request ()
 Handle one request.
- Public Member Functions inherited from BigSWAF::Application
retval new (scalar this, scalar appid)
retval clone ()
 Clone/copy this object.
BigSWAF::AppHandler env (BigSWAF::AppHandler)
 Get/set application handler in charge.
BigSWAF::Configuration config (BigSWAF::Configuration)
 Get/set the configuration of the current application.
retval script (scalar script)
 Get/set the name of the "script" (means the name of the method in the current application) the request was targeted at.
retval skinrequest (scalar path)
 Handles requests to "skin" method.
retval default ()
 This method is invoked if request() was unable to find a more specific implmentation for the current request.
BigSWAF::DispEngine display (BigSWAF::DispEngine)
 Get/set the display engine in charge.
retval getlogin ()
 Get the login name of the user logged on for the current session.
retval getdomain ()
 Get the domain name of the user logged on for the current session.
retval login_identifier ()
 Compute a unique identifier for the configured authentication method and parameters.
list getcredentials ()
 Returns login and password of the user currently logging in.
retval login (scalar realm, scalar domains)
 Sets up a login screen for the current application and its configured authentication method.
retval logout ()
 Removes information about what users have authenticated in the current session.
retval authenticate (scalar realm, scalar domains)
 Returns a document with a login dialog depending on the configured "login_method".
retval login_dialog (scalar realm, scalar domains)
 Returns a login dialog.
retval log (scalar level, scalar message)
 Log a message with the given level and message.
retval getpref (scalar pref)
 Get the value of an option set in the user preferences.
retval setpref (scalar pref, scalar value)
 Set the value of an option in the user preferences.
scalar handle_request_exception (BigSWAF::Exception exception)
 Handle an application exception.
scalar display_request_exception (BigSWAF::Exception exception, scalar text, list arguments)
 Convert an exception with the given text and arguments into an error document.
hash set_flags (scalar flag, scalar value)
 Sets global BigSWAF::DispEngine::setglobal() variable for one or multiple flags.
retval param (list ARGS)
 Get one parameter out of the current request.
retval paramv (list ARGS)
 Get one parameter out of the current request.
retval upload_filehandle (list ARGS)
 If a parameter is associated with an input field of type "file", then param() and paramv() return the uploaded file's name, while upload_filehandle() returns a handle to the actual uploaded file.

Member Function Documentation

retval BigSWAF::ApplicationStatic::request ( )

Handle one request.

Extracts the method requested by the client from the called URI and tries (in this order)

  • to instantiate BigSister::(application)::(method) and invoke its request() method
  • invoke skinrequest() if the method name is "skins"
  • invoke the default() method of the application
Returns
the document to be presented to the client.

Reimplemented from BigSWAF::Application.


The documentation for this class was generated from the following file: