|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.mvc.core.RequestContext
public class RequestContext
******************************************************************************* Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Author : Luis Majano Description : I model a coldbox request. I hold the request's variables, rendering variables, and facade to the request's HTTP request.
Constructor Summary | |
---|---|
init(struct properties, any controller)
*********************************** CONSTRUCTOR ******************************************** |
Method Summary | |
---|---|
any |
buildLink(any linkTo, [boolean ssl='false'], [any baseURL=''], [any queryString=''])
|
any |
clearCollection([boolean private='false'])
|
any |
collectionAppend([boolean private='false'])
|
any |
getCollection([boolean deepCopyFlag='false'], [boolean private='false'])
|
any |
getCurrentAction()
|
any |
getCurrentEvent()
|
any |
getCurrentHandler()
|
any |
getCurrentLayout()
|
any |
getCurrentView()
|
any |
getCurrentViewArgs()
|
any |
getDefaultLayout()
|
any |
getEventName()
|
struct |
getFolderLayouts()
|
struct |
getHTTPBasicCredentials()
|
any |
getHTTPContent()
|
any |
getHTTPHeader(any header, [any defaultValue=''])
|
any |
getHTTPMethod()
|
struct |
getMemento()
*********************************** COLLECTION METHODS ******************************************** |
struct |
getRegisteredLayouts()
|
any |
getRenderData()
|
any |
getSelf()
*********************************** URL METHODS ******************************************** |
numeric |
getSize([boolean private='false'])
|
any |
getTrimValue(any name, [any defaultValue], [boolean private='false'])
|
any |
getValue(any name, [any defaultValue], [boolean private='false'])
|
struct |
getViewLayouts()
|
boolean |
isAjax()
|
any |
isNoExecution()
|
any |
isNoRender()
|
boolean |
isSSL()
|
any |
noExecution()
|
any |
noLayout()
|
any |
noRender([boolean remove='false'])
|
any |
overrideEvent(any event)
*********************************** EVENT METHODS ******************************************** |
any |
paramValue(any name, any value, [boolean private='false'])
|
any |
removeValue(any name, [boolean private='false'])
|
any |
renderData([any type='HTML'], any data, [any contentType=''], [any encoding='utf-8'], [numeric statusCode='200'], [any statusText=''], [any location=''], [any jsonCallback=''], [any jsonQueryFormat='query'], [boolean jsonAsText='false'], [any xmlColumnList=''], [boolean xmlUseCDATA='false'], [any xmlListDelimiter=','], [any xmlRootName=''], [struct pdfArgs='[runtime expression]'], [any formats=''], [any formatsView=''])
*********************************** RESTFUL ******************************************** |
private any |
renderWithFormats()
|
any |
setDefaultLayout(any defaultLayout)
|
any |
setHTTPHeader([any statusCode], [any statusText=''], [any name], [any value=''])
|
any |
setLayout(any name)
|
any |
setMemento(struct memento)
|
any |
setValue(any name, any value, [boolean private='false'])
|
any |
setView([any view], [boolean noLayout='false'], [any layout], [struct args='[runtime expression]'])
|
any |
valueExists(any name, [boolean private='false'])
|
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(struct properties, any controller)
properties
controller
Method Detail |
---|
public any buildLink(any linkTo, [boolean ssl='false'], [any baseURL=''], [any queryString=''])
linkTo
ssl
baseURL
queryString
public any clearCollection([boolean private='false'])
private
public any collectionAppend([boolean private='false'])
private
public any getCollection([boolean deepCopyFlag='false'], [boolean private='false'])
deepCopyFlag
private
public any getCurrentAction()
public any getCurrentEvent()
public any getCurrentHandler()
public any getCurrentLayout()
public any getCurrentView()
public any getCurrentViewArgs()
public any getDefaultLayout()
public any getEventName()
public struct getFolderLayouts()
public struct getHTTPBasicCredentials()
public any getHTTPContent()
public any getHTTPHeader(any header, [any defaultValue=''])
header
defaultValue
public any getHTTPMethod()
public struct getMemento()
public struct getRegisteredLayouts()
public any getRenderData()
public any getSelf()
public numeric getSize([boolean private='false'])
private
public any getTrimValue(any name, [any defaultValue], [boolean private='false'])
name
defaultValue
private
public any getValue(any name, [any defaultValue], [boolean private='false'])
name
defaultValue
private
public struct getViewLayouts()
public boolean isAjax()
public any isNoExecution()
public any isNoRender()
public boolean isSSL()
public any noExecution()
public any noLayout()
public any noRender([boolean remove='false'])
remove
public any overrideEvent(any event)
event
public any paramValue(any name, any value, [boolean private='false'])
name
value
private
public any removeValue(any name, [boolean private='false'])
name
private
public any renderData([any type='HTML'], any data, [any contentType=''], [any encoding='utf-8'], [numeric statusCode='200'], [any statusText=''], [any location=''], [any jsonCallback=''], [any jsonQueryFormat='query'], [boolean jsonAsText='false'], [any xmlColumnList=''], [boolean xmlUseCDATA='false'], [any xmlListDelimiter=','], [any xmlRootName=''], [struct pdfArgs='[runtime expression]'], [any formats=''], [any formatsView=''])
type
data
contentType
encoding
statusCode
statusText
location
jsonCallback
jsonQueryFormat
jsonAsText
xmlColumnList
xmlUseCDATA
xmlListDelimiter
xmlRootName
pdfArgs
formats
formatsView
private any renderWithFormats()
public any setDefaultLayout(any defaultLayout)
defaultLayout
public any setHTTPHeader([any statusCode], [any statusText=''], [any name], [any value=''])
statusCode
statusText
name
value
public any setLayout(any name)
name
public any setMemento(struct memento)
memento
public any setValue(any name, any value, [boolean private='false'])
name
value
private
public any setView([any view], [boolean noLayout='false'], [any layout], [struct args='[runtime expression]'])
view
noLayout
layout
args
public any valueExists(any name, [boolean private='false'])
name
private
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |