revIgniter Naming Convention

revIgniter follows a simple, easy-to-memorize, naming convention to reduce potential name conflicts to a minimum:

All revIgniter functions and commands are prefixed either with rig or _rig for some private handlers; they look something like rigSampleHandler or _rigSampleHandler. Besides those listed below, global variables use gRig and constants rig as prefix. This means, with few exceptions (see below), you can choose arbitrary names for your functions, commands, globals, and constants as long as you don't prefix them with rig, _rig, or gRig.

Reserved Names

Following is a list of reserved names that cannot be used.

Variables

  • gAutoload
  • gConfig
  • gControllerHandlers
  • gData
  • gHooksA
  • gLang
  • gModuleHandlers
  • gModulesHandlersA
  • gRoute
  • gSessionA
  • g_ElapsedTime_
  • g_StyleNonce_
  • g_ScriptNonce_

Constants

  • DIR_READ_MODE
  • DIR_READ_UMASK
  • DIR_WRITE_MODE
  • DIR_WRITE_UMASK
  • FILE_READ_MODE
  • FILE_READ_UMASK
  • FILE_WRITE_MODE
  • FILE_WRITE_UMASK
  • RIVERSION
  • RISTATE

Note: Accessing the permissions constants within script only stacks requires the rigConstant() function. Example: get rigConstant("FILE_READ_UMASK")