| public |
| buildLink | Public Function buildLink
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Builds links to events or URL Routes | | arguments | | label | name | required | type | default | hint | | to | false | any | null | The event or route path you want to create the link to | | queryString | false | any | | The query string to append which can be a regular query string string, or a struct of name-value pairs | | translate | false | boolean | true | Translate between . to / depending on the SES mode on to and queryString arguments. Defaults to true. | | ssl | false | boolean | null | Turn SSl on/off on URL creation, by default is SSL is enabled, we will use it. | | baseURL | false | any | | If not using SES, you can use this argument to create your own base url apart from the default of index.cfm. Example: https://mysample.com/index.cfm |
| | return type | string |
|
| clearCollection | Public Function clearCollection
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Clears the entire collection | | arguments | | label | name | required | type | default | hint | | private | false | boolean | false | Use public or private request collection |
| | return type | any |
|
| clearPrivateCollection | Public Function clearPrivateCollection
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Clears the private collection | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| collectionAppend | Public Function collectionAppend
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Append a structure to the collection, with overwrite or not. Overwrite = false by default | | arguments | | label | name | required | type | default | hint | | collection | true | struct | null | The collection to incorporate | | overwrite | false | boolean | false | Overwrite elements, defaults to false | | private | false | boolean | false | Private or public, defaults public. |
| | return type | any |
|
| getCollection | Public Function getCollection
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
I Get a reference or deep copy of the public or private request Collection | | arguments | | label | name | required | type | default | hint | | deepCopy | false | boolean | false | Default is false, gives a reference to the collection. True, creates a deep copy of the collection. | | private | false | boolean | false | Use public or private request collection |
| | return type | struct |
|
| getContext | Public Function getContext (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getController | Public Function getController (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| getCurrentAction | Public Function getCurrentAction
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current action requested in the current event | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentEvent | Public Function getCurrentEvent
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current incoming event | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentHandler | Public Function getCurrentHandler
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current handler requested in the current event | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentLayout | Public Function getCurrentLayout
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current set layout for rendering | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentLayoutModule | Public Function getCurrentLayoutModule
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current set layout's module for rendering | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentModule | Public Function getCurrentModule
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current module name, else returns empty string | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentRoute | Public Function getCurrentRoute
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the current request's route pattern that matched | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentRoutedModule | Public Function getCurrentRoutedModule
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the current routed module that matched the route, if any | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentRoutedNamespace | Public Function getCurrentRoutedNamespace
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the current routed namespace that matched the route, if any | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentRoutedURL | Public Function getCurrentRoutedURL
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the current routed URL that matched the route pattern | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentRouteMeta | Public Function getCurrentRouteMeta
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current routed route's metadata struct, if any
Returns an empty struct if no record was found. | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getCurrentRouteName | Public Function getCurrentRouteName
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the current request's routed name | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentRouteRecord | Public Function getCurrentRouteRecord
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the current routed route record in all of its raw glory
Returns an empty struct if no record was found. | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getCurrentView | Public Function getCurrentView
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current set view the framework will try to render for this request | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getCurrentViewArgs | Public Function getCurrentViewArgs
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current set view the framework will try to render for this request | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getCurrentViewModule | Public Function getCurrentViewModule
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Gets the current set views's module for rendering | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getDefaultLayout | Public Function getDefaultLayout (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| getDefaultView | Public Function getDefaultView (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| getEventCacheableEntry | Public Function getEventCacheableEntry
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the event cacheable entry | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getEventName | Public Function getEventName (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| getExcept | Public Function getExcept
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Filters the collection or private collection down to all keys except the provided keys. | | arguments | | label | name | required | type | default | hint | | keys | true | any | null | A list or array of keys to exclude from the results of the collection or private collection. | | private | false | boolean | false | Private or public, defaults public request collection |
| | return type | struct |
|
| getFolderLayouts | Public Function getFolderLayouts (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getFullPath | Public Function getFullPath
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Returns the full relative path to the requested event: does not include protocol and host | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getFullURL | Public Function getFullURL
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Returns the full url including the protocol, host, mapping, path info, and query string.
Handles SES urls gracefully. | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getHTMLBaseURL | Public Function getHTMLBaseURL
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the HTML base URL that is used for the HTML <base> tag. This also accounts for SSL or not. | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getHTTPBasicCredentials | Public Function getHTTPBasicCredentials
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Returns the username and password sent via HTTP basic authentication | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getHTTPContent | Public Function getHTTPContent
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the raw HTTP body content with conversions if needed | | arguments | | label | name | required | type | default | hint | | json | false | boolean | false | Try to return the content as deserialized json | | xml | false | boolean | false | Try to return the content as an XML object |
| | return type | any |
|
| getHTTPHeader | Public Function getHTTPHeader
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get an HTTP header. If the header doesn't exist the default value of empty string is returned. | | arguments | | label | name | required | type | default | hint | | header | true | any | null | The header to get | | defaultValue | false | any | | The default value, if not found |
| | return type | any |
|
| getHTTPMethod | Public Function getHTTPMethod
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the HTTP Request Method Type | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getIsNoExecution | Public Function getIsNoExecution (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| getMemento | Public Function getMemento
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get a representation of this instance | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getModuleEntryPoint | Public Function getModuleEntryPoint
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Convenience method to get a module's inherited entry point URL, blank if not found | | arguments | | label | name | required | type | default | hint | | module | false | any | | Optional name of the module you want the root for, defaults to the current running module |
| | return type | string |
|
| getModuleRoot | Public Function getModuleRoot
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Convenience method to get the current request's module root path. If no module, then returns empty path. You can also get this from the modules settings | | arguments | | label | name | required | type | default | hint | | module | false | any | | Optional name of the module you want the root for, defaults to the current running module |
| | return type | string |
|
| getOnly | Public Function getOnly
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Filters the collection or private collection down to only the provided keys. | | arguments | | label | name | required | type | default | hint | | keys | true | any | null | A list or array of keys to bring back from the collection or private collection. | | private | false | boolean | false | Private or public, defaults public request collection |
| | return type | struct |
|
| getPrivateCollection | Public Function getPrivateCollection
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
I get a private collection | | arguments | | label | name | required | type | default | hint | | deepCopy | false | boolean | false | Default is false, gives a reference to the collection. True, creates a deep copy of the collection. |
| | return type | struct |
|
| getPrivateContext | Public Function getPrivateContext (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getPrivateExcept | Public Function getPrivateExcept
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Filters the private collection down to all keys except the provided keys. | | arguments | | label | name | required | type | default | hint | | keys | true | any | null | A list or array of keys to exclude from the results of the private collection. |
| | return type | struct |
|
| getPrivateOnly | Public Function getPrivateOnly
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Filters the private collection down to only the provided keys. | | arguments | | label | name | required | type | default | hint | | keys | true | any | null | A list or array of keys to bring back from the private collection. |
| | return type | struct |
|
| getPrivateSize | Public Function getPrivateSize
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the private collection Size | | arguments | | label | name | required | type | default | hint |
| | return type | numeric |
|
| getPrivateTrimValue | Public Function getPrivateTrimValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get a trim value from the private request collection. | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | defaultValue | false | any | null | default value |
| | return type | any |
|
| getPrivateValue | Public Function getPrivateValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get a value from the private request collection. | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | defaultValue | false | any | null | default value |
| | return type | any |
|
| getProperties | Public Function getProperties (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getRegisteredLayouts | Public Function getRegisteredLayouts (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getRenderData | Public Function getRenderData
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the renderData structure | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getRenderingRegions | Public Function getRenderingRegions (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getResponse | Public Function getResponse
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the response object for the current request. If there is none, then return a new one
The response object lives in `prc.response` | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| getResponseHeaders | Public Function getResponseHeaders (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getRoutedStruct | Public Function getRoutedStruct (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getSelf | Public Function getSelf
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Returns index.cfm?{eventName}= | | arguments | | label | name | required | type | default | hint |
| | return type | string |
|
| getSESBaseURL | Public Function getSESBaseURL (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| getSESEnabled | Public Function getSESEnabled (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| getSize | Public Function getSize
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the collection Size | | arguments | | label | name | required | type | default | hint | | private | false | boolean | false | Private or public, defaults public. |
| | return type | numeric |
|
| getTrimValue | Public Function getTrimValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get a value from the request collection and if simple value, I will trim it. | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | defaultValue | false | any | null | default value | | private | false | boolean | false | Private or public, defaults public. |
| | return type | any |
|
| getValue | Public Function getValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get a value from the public or private request collection. | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | defaultValue | false | any | null | default value | | private | false | boolean | false | Private or public, defaults public. |
| | return type | any |
|
| getViewCacheableEntry | Public Function getViewCacheableEntry
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the event cacheable entry | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| getViewLayouts | Public Function getViewLayouts (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint |
| | return type | struct |
|
| init | Public Function init
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Constructor | | arguments | | label | name | required | type | default | hint | | properties | true | struct | | The ColdBox application settings | | controller | true | any | null | Acess to the system controller |
| | return type | any |
|
| isAjax | Public Function isAjax
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Determines if in an Ajax call or not by looking at the request headers | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| isEventCacheable | Public Function isEventCacheable
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Check wether the incoming event has been flagged for caching | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| isInvalidHTTPMethod | Public Function isInvalidHTTPMethod
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Check if the request was made with an invalid HTTP Method | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| isNoRender | Public Function isNoRender
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Is this a no render request | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| isProxyRequest | Public Function isProxyRequest
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Is this a coldbox proxy request | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| isSES | Public Function isSES
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Verify if SES is enabled or not in the request | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| isSSL | Public Function isSSL
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Are we in SSL or not? This method looks at CGI.SERVER_PORT_SECURE for indication | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| isViewCacheable | Public Function isViewCacheable
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Check wether the incoming view has been flagged for caching | | arguments | | label | name | required | type | default | hint |
| | return type | boolean |
|
| METHODS | | Struct | | DELETE | | | GET | | | HEAD | | | PATCH | | | POST | | | PUT | |
|
| noExecution | Public Function noExecution
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set that the request will not execute an incoming event. Most likely simulating a servlet call | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| noLayout | Public Function noLayout
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Mark this request to not use a layout for rendering | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| noRender | Public Function noRender
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set the flag that tells the framework not to render, just execute | | arguments | | label | name | required | type | default | hint | | remove | false | boolean | false | Remove the flag completely |
| | return type | any |
|
| overrideEvent | Public Function overrideEvent
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Override the current event in the request collection. This method does not execute the event, it just replaces the event to be executed by the framework's RunEvent() method. This method is usually called from an onRequestStart or onApplicationStart method | | arguments | | label | name | required | type | default | hint | | event | true | any | null | The event to override with |
| | return type | any |
|
| paramPrivateValue | Public Function paramPrivateValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Just like cfparam, but for the private request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | value | true | any | null | The value |
| | return type | any |
|
| paramValue | Public Function paramValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Just like cfparam, but for the request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | value | true | any | null | The value | | private | false | boolean | false | Private or public, defaults public. |
| | return type | any |
|
| privateCollectionAppend | Public Function privateCollectionAppend
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Append a structure to the collection, with overwrite or not. Overwrite = false by default | | arguments | | label | name | required | type | default | hint | | collection | true | struct | null | The collection to incorporate | | overwrite | false | boolean | false | Overwrite elements, defaults to false |
| | return type | any |
|
| privateValueExists | Public Function privateValueExists
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Check if a value exists in the private request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name |
| | return type | boolean |
|
| removeEventCacheableEntry | Public Function removeEventCacheableEntry
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Check wether the incoming event has been flagged for caching | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| removePrivateValue | Public Function removePrivateValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
remove a value in the private request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | private | false | boolean | false | |
| | return type | any |
|
| removeValue | Public Function removeValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
remove a value in the request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | private | false | boolean | false | Private or public, defaults public. |
| | return type | any |
|
| renderData | Public Function renderData
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Use this method to tell the framework to render data for you. The framework will take care of marshalling the data for you | | arguments | | label | name | required | type | default | hint | | type | false | any | HTML | The type of data to render. Valid types are JSON, JSONP, JSONT, XML, WDDX, PLAIN/HTML, TEXT, PDF. The deafult is HTML or PLAIN. If an invalid type is sent in, this method will throw an error | | data | true | any | null | The data you would like to marshall and return by the framework | | contentType | false | any | | The content type of the data. This will be used in the cfcontent tag: text/html, text/plain, text/xml, text/json, etc. The default value is text/html. However, if you choose JSON this method will choose application/json, if you choose WDDX or XML this method will choose text/xml for you. | | encoding | false | any | utf-8 | The default character encoding to use. The default encoding is utf-8 | | statusCode | false | numeric | 200 | The HTTP status code to send to the browser. Defaults to 200 | | statusText | false | any | | Explains the HTTP status code sent to the browser. | | location | false | any | | Optional argument used to set the HTTP Location header | | jsonCallback | false | any | | Only needed when using JSONP, this is the callback to add to the JSON packet | | jsonQueryFormat | false | any | true | JSON Only: This parameter can be a Boolean value that specifies how to serialize ColdFusion queries or a string with possible values "row", "column", or "struct". | | jsonAsText | false | boolean | false | If set to false, defaults content mime-type to application/json, else will change encoding to plain/text | | xmlColumnList | false | any | | XML Only: Choose which columns to inspect, by default it uses all the columns in the query, if using a query | | xmlUseCDATA | false | boolean | false | XML Only: Use CDATA content for ALL values. The default is false | | xmlListDelimiter | false | any | , | XML Only: The delimiter in the list. Comma by default | | xmlRootName | false | any | | XML Only: The name of the initial root element of the XML packet | | pdfArgs | false | struct | | All the PDF arguments to pass along to the CFDocument tag. | | formats | false | any | | The formats list or array that ColdBox should respond to using the passed in data argument. You can pass any of the valid types (JSON,JSONP,JSONT,XML,WDDX,PLAIN,HTML,TEXT,PDF). For PDF and HTML we will try to render the view by convention based on the incoming event | | formatsView | false | any | | The view that should be used for rendering HTML/PLAIN/PDF. By default ColdBox uses the name of the event as an implicit view | | formatsRedirect | false | any | | The arguments that should be passed to relcoate as part of a redirect for the HTML action. If the format is HTML and this struct is not empty, ColdBox will call relcoate with these arguments. | | isBinary | false | boolean | false | Bit that determines if the data being set for rendering is binary or not. |
| | return type | any |
|
| route | Public Function route
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Builds links to named routes with or without parameters. If the named route is not found, this method will throw an `InvalidArgumentException`.
If you need a route from a module then append the module address: `@moduleName` or prefix it like in run event calls `moduleName:routenName` in order to find the right route. | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The name of the route | | params | false | struct | | The parameters of the route to replace | | ssl | false | boolean | null | Turn SSL on/off or detect it by default |
| | return type | string |
|
| sendFile | Public Function sendFile
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
This method will send a file to the browser or requested HTTP protocol according to arguments.
CF11+ Compatibility | | arguments | | label | name | required | type | default | hint | | file | false | any | | The absolute path to the file or a binary file to send | | name | false | any | | The name to send to the browser via content disposition header. If not provided then the name of the file or a UUID for a binary file will be used | | mimeType | false | any | | A valid mime type to use. If not passed, then we will try to use one according to file type | | disposition | false | any | attachment | The browser content disposition (attachment/inline) header | | abortAtEnd | false | boolean | false | If true, then this method will do a hard abort, we do not recommend this, prefer the event.noRender() for a graceful abort. | | extension | false | any | | Only used for binary files which types are not determined. | | deleteFile | false | boolean | false | Delete the file after it has been streamed to the user. Only used if file is not binary. |
| | return type | any |
|
| setContext | Public Function setContext (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | context | true | struct | null | |
| | return type | any |
|
| setController | Public Function setController (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | controller | true | any | null | |
| | return type | any |
|
| setDefaultLayout | Public Function setDefaultLayout
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Override the default layout for a request | | arguments | | label | name | required | type | default | hint | | defaultLayout | true | any | null | |
| | return type | any |
|
| setDefaultView | Public Function setDefaultView
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Override the default view for a request | | arguments | | label | name | required | type | default | hint | | defaultView | true | any | null | |
| | return type | any |
|
| setEventCacheableEntry | Public Function setEventCacheableEntry
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Check wether the incoming event has been flagged for caching | | arguments | | label | name | required | type | default | hint | | cacheEntry | true | struct | null | The md entry for caching |
| | return type | any |
|
| setEventName | Public Function setEventName (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | eventName | true | any | null | |
| | return type | any |
|
| setFolderLayouts | Public Function setFolderLayouts (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | folderLayouts | true | struct | null | |
| | return type | any |
|
| setHTTPHeader | Public Function setHTTPHeader
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set an HTTP Response Header | | arguments | | label | name | required | type | default | hint | | statusCode | false | any | null | the status code | | statusText | false | any | | the status text | | name | false | any | null | The header name | | value | false | any | | The header value |
| | return type | any |
|
| setIsInvalidHTTPMethod | Public Function setIsInvalidHTTPMethod
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set the invalid http method flag | | arguments | | label | name | required | type | default | hint | | target | false | boolean | true | |
| | return type | RequestContext |
|
| setIsNoExecution | Public Function setIsNoExecution (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | isNoExecution | true | boolean | null | |
| | return type | any |
|
| setLayout | Public Function setLayout
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set the layout to override and render. Layouts are pre-defined in the config file. However I can override these settings if needed. Do not append a the cfm extension. Private Request Collection name | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The name of the layout to set | | module | false | any | | The module to use |
| | return type | any |
|
| setMemento | Public Function setMemento
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Override the instance | | arguments | | label | name | required | type | default | hint | | memento | true | struct | null | |
| | return type | any |
|
| setPrivateContext | Public Function setPrivateContext (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | privateContext | true | struct | null | |
| | return type | any |
|
| setPrivateValue | Public Function setPrivateValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set a value in the private request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | value | true | any | null | The value |
| | return type | any |
|
| setProperties | Public Function setProperties (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | properties | true | struct | null | |
| | return type | any |
|
| setProxyRequest | Public Function setProxyRequest
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set that this is a proxy request | | arguments | | label | name | required | type | default | hint |
| | return type | any |
|
| setRegisteredLayouts | Public Function setRegisteredLayouts (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | registeredLayouts | true | struct | null | |
| | return type | any |
|
| setRenderingRegions | Public Function setRenderingRegions (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | renderingRegions | true | struct | null | |
| | return type | any |
|
| setResponseHeaders | Public Function setResponseHeaders (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | responseHeaders | true | struct | null | |
| | return type | any |
|
| setRoutedStruct | Public Function setRoutedStruct
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Get the routed structure of key-value pairs. What the ses interceptor could match. | | arguments | | label | name | required | type | default | hint | | routedStruct | true | struct | null | |
| | return type | any |
|
| setSESBaseURL | Public Function setSESBaseURL
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set the ses base URL for this request | | arguments | | label | name | required | type | default | hint | | sesBaseURL | true | string | null | |
| | return type | any |
|
| setSESEnabled | Public Function setSESEnabled
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Setter for verifying SES mode | | arguments | | label | name | required | type | default | hint | | flag | true | boolean | null | |
| | return type | any |
|
| setValue | Public Function setValue
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set a value in the request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | value | true | any | null | The value | | private | false | boolean | false | Private or public, defaults public. |
| | return type | any |
|
| setView | Public Function setView
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set the view to render in this request. Private Request Collection Name: currentView, currentLayout | | arguments | | label | name | required | type | default | hint | | view | false | any | null | The name of the view to set. If a layout has been defined it will assign it, else if will assign the default layout. No extension please | | args | false | struct | | An optional set of arguments that will be available when the view is rendered | | layout | false | any | null | You can override the rendering layout of this setView() call if you want to. Else it defaults to implicit resolution or another override. | | module | false | any | | The explicit module view | | noLayout | false | boolean | false | Boolean flag, wether the view sent in will be using a layout or not. Default is false. Uses a pre set layout or the default layout. | | cache | false | boolean | false | True if you want to cache the rendered view. | | cacheTimeout | false | any | | The cache timeout in minutes | | cacheLastAccessTimeout | false | any | | The last access timeout in minutes | | cacheSuffix | false | any | | Add a cache suffix to the view cache entry. Great for multi-domain caching or i18n caching. | | cacheProvider | false | any | template | The cache provider you want to use for storing the rendered view. By default we use the 'template' cache provider | | name | false | any | null | This triggers a rendering region. This will be the unique name in the request for specifying a rendering region, you can then render it by passing the unique name to renderView(); |
| | return type | any |
|
| setViewCacheableEntry | Public Function setViewCacheableEntry
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Set the view cacheable entry | | arguments | | label | name | required | type | default | hint | | cacheEntry | true | struct | null | The md entry for caching |
| | return type | any |
|
| setViewLayouts | Public Function setViewLayouts (generated)
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc | | arguments | | label | name | required | type | default | hint | | viewLayouts | true | struct | null | |
| | return type | any |
|
| STATUS | Struct
Entries: 17 | | ACCEPTED | | | BAD_REQUEST | | | CREATED | | | EXPECTATION_FAILED | | | INTERNAL_ERROR | | | NO_CONTENT | | | NOT_ACCEPTABLE | | | NOT_ALLOWED | | | NOT_AUTHENTICATED | | | NOT_AUTHORIZED | | | NOT_FOUND | | | NOT_IMPLEMENTED | | | PARTIAL_CONTENT | | | RESET | | | SUCCESS | | | TOO_MANY_REQUESTS | | | UNPROCESSABLE_ENTITY | |
|
| STATUS_TEXTS | Struct
Entries: 63 | | 100 | | | 101 | | string | Switching Protocols |
| | 102 | | | 200 | | | 201 | | | 202 | | | 203 | | string | Non-authoritative Information |
| | 204 | | | 205 | | | 206 | | | 207 | | | 208 | | | 226 | | | 300 | | | 301 | | | 302 | | | 303 | | | 304 | | | 305 | | | 307 | | | 308 | | | 400 | | | 401 | | | 402 | | | 403 | | | 404 | | | 405 | | | 406 | | | 407 | | string | Proxy Authentication Required |
| | 408 | | | 409 | | | 410 | | | 411 | | | 412 | | string | Precondition Failed |
| | 413 | | | 414 | | string | Request-URI Too Long |
| | 415 | | string | Unsupported Media Type |
| | 416 | | string | Requested Range Not Satisfiable |
| | 417 | | | 418 | | | 421 | | string | Misdirected Request |
| | 422 | | string | Unprocessable Entity |
| | 423 | | | 424 | | | 426 | | | 428 | | string | Precondition Required |
| | 429 | | | 431 | | string | Request Header Fields Too Large |
| | 444 | | string | Connection Closed Without Response |
| | 451 | | string | Unavailable For Legal Reasons |
| | 499 | | string | Client Closed Request |
| | 500 | | string | Internal Server Error |
| | 501 | | | 502 | | | 503 | | string | Service Unavailable |
| | 504 | | | 505 | | string | HTTP Version Not Supported |
| | 506 | | string | Variant Also Negotiates |
| | 507 | | string | Insufficient Storage |
| | 508 | | | 510 | | | 511 | | string | Network Authentication Required |
| | 599 | | string | Network Connect Timeout Error |
|
|
| urlMatches | Public Function urlMatches
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Tests that a given path exists in the currently routed URL.
If the exact flag is passed, the path must match exactly.
Using the `urlMatchesExact` is preferred. | | arguments | | label | name | required | type | default | hint | | path | true | string | null | The path to match in the currently routed URL. | | exact | false | boolean | false | Flag to do an exact match instead of a partial match |
| | return type | boolean |
|
| urlMatchesExact | Public Function urlMatchesExact
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Tests that a given path matches exactly to the currently routed URL. | | arguments | | label | name | required | type | default | hint | | path | true | string | null | The path to match exactly to the currently routed URL. |
| | return type | boolean |
|
| valueExists | Public Function valueExists
source: /var/www/clients/client1/web46/web/coldbox/system/web/context/RequestContext.cfc
Check if a value exists in the request collection | | arguments | | label | name | required | type | default | hint | | name | true | any | null | The key name | | private | false | boolean | false | Private or public, defaults public. |
| | return type | boolean |
|
