| ADDTRACE |
| function addTrace |
Arguments:
| Name |
Required |
Type |
Default |
| time |
Optional |
Any |
|
| type |
Optional |
Any |
|
| message |
Optional |
Any |
|
| occurrence |
Optional |
Any |
0
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I add a detailed line to the execution trace log. |
| Description: |
|
|
|
| INIT |
| function init |
Arguments:
| Name |
Required |
Type |
Default |
| appKey |
Required |
string |
|
| attributes |
Required |
struct |
|
| topLevelVariablesScope |
Required |
any |
|
|
| ReturnType: |
myFusebox
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am the constructor. |
| Description: |
|
|
|
| SETMYSELF |
| function setMyself |
Arguments:
| Name |
Required |
Type |
Default |
| myself |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I override the default value of 'myself'. |
| Description: |
|
|
|
| GETORIGINALFUSEACTION |
| function getOriginalFuseaction |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am a convenience method to return the original fuseboxAction (fuseaction) object. |
| Description: |
|
|
|
| ENTERSTACKFRAME |
| function enterStackFrame |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I create a new stack frame (for scoped parameters to do/include). |
| Description: |
|
|
|
| GETAPPLICATIONDATA |
| function getApplicationData |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am a convenience method to return a reference to the application data cache. |
| Description: |
|
|
|
| TRACE |
| function trace |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Optional |
Any |
|
| message |
Optional |
Any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I add a line to the execution trace log. |
| Description: |
|
|
|
| GETORIGINALCIRCUIT |
| function getOriginalCircuit |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am a convenience method to return the original Fusebox circuit object. |
| Description: |
|
|
|
| DO |
| function do |
Arguments:
| Name |
Required |
Type |
Default |
| action |
Required |
string |
|
| contentVariable |
Optional |
string |
[empty string]
|
| returnOutput |
Optional |
boolean |
false
|
| append |
Optional |
boolean |
false
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
I compile and execute a specific fuseaction. |
| Description: |
|
|
|
| VARIABLES |
| function variables |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the top-level variables scope. |
| Description: |
|
|
|
| GETAPPLICATION |
| function getApplication |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am a convenience method to return the fuseboxApplication object without needing to know reference application scope or the FUSEBOX_APPLICATION_KEY variable. |
| Description: |
|
|
|
| GETCURRENTFUSEACTION |
| function getCurrentFuseaction |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am a convenience method to return the current fuseboxAction (fuseaction) object. |
| Description: |
|
|
|
| SETSELF |
| function setSelf |
Arguments:
| Name |
Required |
Type |
Default |
| self |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I override the default value of 'self' and I also reset the value of 'myself'. |
| Description: |
|
|
|
| LEAVESTACKFRAME |
| function leaveStackFrame |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I pop the last stack frame (for scoped parameters to do/include). |
| Description: |
|
|
|
| GETMYSELF |
| function getMyself |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the 'myself' string, e.g., index.cfm?fuseaction=. |
| Description: |
|
|
|
| GETSELF |
| function getSelf |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I return the 'self' string, e.g., index.cfm. |
| Description: |
|
|
|
| RELOCATE |
| function relocate |
Arguments:
| Name |
Required |
Type |
Default |
| url |
Optional |
string |
|
| xfa |
Optional |
string |
|
| addtoken |
Optional |
boolean |
false
|
| type |
Optional |
string |
client
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
true |
| DisplayName: |
|
| Hint: |
I provide the same functionality as the relocate verb. |
| Description: |
|
|
|
| GETCURRENTCIRCUIT |
| function getCurrentCircuit |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I am a convenience method to return the current Fusebox circuit object. |
| Description: |
|
|
|
| RENDERTRACE |
| function renderTrace |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I render the trace log as HTML. |
| Description: |
|
|
|