ColdBox's URL Actions

  1. ColdBox's URL Actions
      1. Quick URL Actions Table
    2. Expanded Descriptions
      1. fwreinit
        1. Examples
      2. fwCache
        1. Examples
      3. debugmode & debugpass
        1. Examples
      4. dumpvar
        1. Examples
      5. debugpanel
        1. Examples

ColdBox has some URL actions that will be very useful when coding and using the framework. Below is a quick table listing and below are the full descriptions

Quick URL Actions Table

URL Action Value Description
fwreinit any Reinitialize the framework and all its variables.
fwCache any Override a cached event so it can be purged and recached. The framework just detects that the URL action exists
debugmode boolean Make your current session go into debugging mode.
debugpass string If DebugPassword setting used, then place here.
dumpvar list A comma delimited list of variables to dump.
debugpanel string The debug panel monitor to render.

Expanded Descriptions

fwreinit

The most useful url action you will ever use. This action will reload the framework to a new state. It will re-initialize the configuration structures, clean the cache, and give you a fresh start. You can also password protect this URL action by filling out the ReinitPassword setting in the config.xml. (Look at Config Guide)

Examples

  • No ReinitPassword setting. 
    index.cfm?fwreinit=1

index.cfm?fwreinit=true
  • UsingReinitPassword setting, lets pretend the password is "yea" 
    index.cfm?fwreinit=yea

fwCache

This flag is used to override a cached event so it can be purged and re-cached by the framework. The framework just detects that the URL action exists, so it can be equals to anything.

Examples

index.cfm?event=blog.dspBlog&fwCache=true

debugmode & debugpass

This url action is used in order for the user to go into or out of ColdBox debug mode. Debug mode, means that a debugging panel will be rendered at the end of the requested page output. This is a very convenient way to test in production environments or while development. You can set the initial debug mode for an application via the config.xml file. (Look at Config Guide) In order for this action to work correctly, it must determine if the application has a DebugPassword attached to it, also via the config.xml. If the DebugPassword is blank, then this action works on its own.

NOTES: I highly recommend setting a password for the debug mode
The debug cookie expires when the user closes the browser, that is, the cookie is "session only

Look at the samples below.

Examples

  • DebugPassword set to blank. 
    index.cfm?debugmode=true

index.cfm?debugmode=1
  • Using DebugPassword setting, lets pretend the password is "yea" 
    index.cfm?debugmode=yea&debugpass=yea

dumpvar

This URL action is used as a utility to dump variables in the debugging panel. Therefore, you need to be in debug mode in order to use it. Look at section above. You can send a single variable name or a list and it will be dumped in the DumpVar section of the debugging panel.

You can also disable this utility action via the config.xml (Look at Config Guide)

Examples

  • Single Variable 
    index.cfm?dumpvar=session

index.cfm?dumpvar=myvariable
  • Variable List 
    index.cfm?dumpvar=session,application,request

debugpanel

The debugpanel url action can ONLY BE used when in debug mode. If you are not in debug mode, then the panel will not be rendered. The only available panels are:

  • cache : This will render the cache panel monitor

More panel monitors will be added as development continues.

Examples

index.cfm?debugpanel=cache

Here is a screenshot of the latest Cache Monitor:

Copyright 2006 ColdBox Framework by Luis Majano