ColdBox Platform Version 3.7.0

coldbox.system.mvc.core
Class RequestContext

WEB-INF.cftags.component
        extended by coldbox.system.mvc.core.RequestContext

public class RequestContext
extends WEB-INF.cftags.component

******************************************************************************* 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

init

public init(struct properties, any controller)
*********************************** CONSTRUCTOR ********************************************

Parameters:
properties
controller
Method Detail

buildLink

public any buildLink(any linkTo, [boolean ssl='false'], [any baseURL=''], [any queryString=''])

Parameters:
linkTo
ssl
baseURL
queryString

clearCollection

public any clearCollection([boolean private='false'])

Parameters:
private

collectionAppend

public any collectionAppend([boolean private='false'])

Parameters:
private

getCollection

public any getCollection([boolean deepCopyFlag='false'], [boolean private='false'])

Parameters:
deepCopyFlag
private

getCurrentAction

public any getCurrentAction()


getCurrentEvent

public any getCurrentEvent()


getCurrentHandler

public any getCurrentHandler()


getCurrentLayout

public any getCurrentLayout()


getCurrentView

public any getCurrentView()


getCurrentViewArgs

public any getCurrentViewArgs()


getDefaultLayout

public any getDefaultLayout()


getEventName

public any getEventName()


getFolderLayouts

public struct getFolderLayouts()


getHTTPBasicCredentials

public struct getHTTPBasicCredentials()


getHTTPContent

public any getHTTPContent()


getHTTPHeader

public any getHTTPHeader(any header, [any defaultValue=''])

Parameters:
header
defaultValue

getHTTPMethod

public any getHTTPMethod()


getMemento

public struct getMemento()
*********************************** COLLECTION METHODS ********************************************


getRegisteredLayouts

public struct getRegisteredLayouts()


getRenderData

public any getRenderData()


getSelf

public any getSelf()
*********************************** URL METHODS ********************************************


getSize

public numeric getSize([boolean private='false'])

Parameters:
private

getTrimValue

public any getTrimValue(any name, [any defaultValue], [boolean private='false'])

Parameters:
name
defaultValue
private

getValue

public any getValue(any name, [any defaultValue], [boolean private='false'])

Parameters:
name
defaultValue
private

getViewLayouts

public struct getViewLayouts()


isAjax

public boolean isAjax()


isNoExecution

public any isNoExecution()


isNoRender

public any isNoRender()


isSSL

public boolean isSSL()


noExecution

public any noExecution()


noLayout

public any noLayout()


noRender

public any noRender([boolean remove='false'])

Parameters:
remove

overrideEvent

public any overrideEvent(any event)
*********************************** EVENT METHODS ********************************************

Parameters:
event

paramValue

public any paramValue(any name, any value, [boolean private='false'])

Parameters:
name
value
private

removeValue

public any removeValue(any name, [boolean private='false'])

Parameters:
name
private

renderData

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=''])
*********************************** RESTFUL ********************************************

Parameters:
type
data
contentType
encoding
statusCode
statusText
location
jsonCallback
jsonQueryFormat
jsonAsText
xmlColumnList
xmlUseCDATA
xmlListDelimiter
xmlRootName
pdfArgs
formats
formatsView

renderWithFormats

private any renderWithFormats()


setDefaultLayout

public any setDefaultLayout(any defaultLayout)

Parameters:
defaultLayout

setHTTPHeader

public any setHTTPHeader([any statusCode], [any statusText=''], [any name], [any value=''])

Parameters:
statusCode
statusText
name
value

setLayout

public any setLayout(any name)

Parameters:
name

setMemento

public any setMemento(struct memento)

Parameters:
memento

setValue

public any setValue(any name, any value, [boolean private='false'])

Parameters:
name
value
private

setView

public any setView([any view], [boolean noLayout='false'], [any layout], [struct args='[runtime expression]'])

Parameters:
view
noLayout
layout
args

valueExists

public any valueExists(any name, [boolean private='false'])

Parameters:
name
private

ColdBox Platform Version 3.7.0