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 rigSampleFunction or _rigSampleFunction. Besides those listed below, global variables use gRig and constants rig as prefix. Furthermore flash is a reserved 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, gRig or flash.

Note: revIgniter (as of version 1.3.15b) no longer supports former names (those without prefix). All users are asked to replace those names by prefixing them with rig before upgrading to version 1.3.15b or higher. So for example convert loadHelper to rigLoadHelper, fetchConfigItem() to rigFetchConfigItem() etc.

 

Reserved Names

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

Functions

  • fetchValidationConf

Variables

  • gAdvancedUnicode
  • g_ElapsedTime_
  • gActiveRecord
  • gApplicationFolder
  • gAPPPATH
  • gAutoload
  • gBASEPATH
  • gConfig
  • gController
  • gControllerHandlers
  • gCOOKIE
  • gData
  • gDatabaseID
  • gDocTypes
  • gErrorData
  • gEXT
  • gFCPATH
  • gHandler
  • gHooks
  • gLang
  • gRoute
  • gRSegments
  • gSegments
  • gSELF
  • gSystemFolder

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