API: Page

Filename:
_initMasters.lgc

Released With:
5.0.0

Current Version:
1.0.0

Status: Active

Min Lasso Tested: 8.1.0

Max Lasso Tested: 8.5.3

Related:

_fwpAPI_initVars

fwpPage_init

API Reference

_initMasters (Include)

Description

This file is where most framework environment vars are assigned default values.

It is included by the fwpPage_init page startup process. This file has a couple of functions. First, it contains duplicate declarations of most of the vars initialized in _fwpAPI_initVars. The purpose is to provide an easy-access method to override the values of the vars. During development, these globals may need experimented with or altered to suit testing, debugging, etc. Once an application is stable, the assignments in this file can be commented out, and the values moved to the _fwpAPI_initVars file (though it isn't necessary to do so).

The second purpose of the _initMasters file is to declare the non-global, site-specific environment vars. These vars would be something like $fw_preventCache (boolean) which is used to specify whether pages should be cached or not (the logic for handling that is integral to the fwpPage_init tag). In your site, maybe most pages can be cached, but only those in a certain module should not. You would set the default value to false in _initMasters and override it as necessary further in the config nesting chain. There are several of these page level variables that are defined in _initMasters.