CF_DEBUG Documentation

CF_DEBUG v2.1
formerly CF_GetVariables

I'm going to be brief with the documentation. This tag is pretty straight forward. This tag should be used as a debugging tool. I've decided to release this tag un-encrypted, so feel free to look at the code and see what's going on behind the scenes.

If you do modify the code, please send the your code to me. This way, I can try to keep this tag up-to-date with everyone's modifications. I can't promise I'll include every feature, but I will include the ones I think everyone will benefit from.

Sincerely,
Dan G. Switzer, II
dswitzer@pengoworks.com

Installation:

Copy the file Debug.cfm into your c:\cfusion\CustomTags directory.
That's it. Pretty easy, eh?

Usage:
<CF_DEBUG>

That's it! Well at least in it's simplest form. However, here are some optional attributes that can be used:

ATTRIBUTE	DESCRIPTION
TURNON:	Specify a comma-delimited list of scopes to watch. For example, if you only care about the VARIABLES scope, addding the attribute TURNON="VARIABLES" will only monitor the VARIABLES scope. (Defaults to all scopes.)
VARIABLES:	Specify a comma-delimited list of variables in the VARIABLES scope to watch. This will check to see if the variable exists, if it does, the value will be displayed, otherwise the fact that it's undeclared is displayed.
COOKIE:	Specify a comma-delimited list of variables in the COOKIE scope to watch. This will check to see if the variable exists, if it does, the value will be displayed, otherwise the fact that it's undeclared is displayed.
APPLICATION:	Specify a comma-delimited list of variables in the APPLICATION scope to watch. This will check to see if the variable exists, if it does, the value will be displayed, otherwise the fact that it's undeclared is displayed.
SERVER:	Specify a comma-delimited list of variables in the SERVER scope to watch. This will check to see if the variable exists, if it does, the value will be displayed, otherwise the fact that it's undeclared is displayed.
SESSION:	Specify a comma-delimited list of variables in the SESSION scope to watch. This will check to see if the variable exists, if it does, the value will be displayed, otherwise the fact that it's undeclared is displayed.

Other Hints:

Try placing multiple instances of CF_Debug throughout your templates. A different window will be opened for each occurance. This is a great debugging tool.
CF_Debug intializes a variable called "cfDebug_ExeTime". This variable is used to determine the number of seconds since the last time the variable was set. Use this variable to determine the processing time between lines of code. You can also intialize the variable anywhere in your document to determine the total execution of certain lines of code. Use <CFSET cfDebug_ExeTime = Now()> anytime you want to initialize the variable.
NOTE: As soon as I can find a way to actually convert this time to milliseconds, I will.

Contributers:
Dan G. Switzer, II
James Smith
Jonathan Doklovic