Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

Whitebeam Template Reference Documentation

System Template

env.get()

The string value of the requested environment variable, or null if that variable is not defined

Syntax

string = rb.page.env.get(realReq)

Parameters

The 'env.get' method takes 1 parameter:

Name Type/Value Range/Length Description
realReqstring  Required. Name of an environment variable to retrieve

Results

The 'env.get' method returns string:

Type/Value Range/Length Description
string  

Remarks

A number of Apache compnents can set environment variables for use by other modules. This method simply provides a means of retrieving the current value of one of those variables. If the variable does not exist then this method returns null, otherwise it returns the string value of the variable.

Note : If you want to read SSL information from environment varibales set by mod_ssl then remember to add SSLOptions +StdEnvVars to you secure virtual server declarations in your Apache configuration file (httpd.conf). The default configuration does not define these variables for Whitebeam files (.rhtm or .whtm files).

Whitebeam release 1.3.36
(loadtime : 85ms)