Reserved Variables

June 8, 2007

The following variables must be used as described:

  • $module - this variable is to be at the first code line of every module file, it is to contain the common name of the module.
  • $table - defines the primary database table accessed by the module file, this is often the "short" name of the module.
  • $mode - this is used to specifiy the mode within a module file.
  • $modeproper - the full name of the mode with correct casing, in the form of a string of characters. This should be consistent with the function that the end-user believes they are using.