Pier Drilling Services

Application Settings

Scope

applicationname

string

PPT_Corp_Web_1.0

FLASHMESSAGES

Struct

PLUGIN

Struct

AUTHOR

string

Matthew Lesko (CFGeek.com)

COMPATIBILITY

string

2.0.0,2.0.1,2.1.0,2.2.0,2.3.0,2.4.0,2.5.0

NAME

string

FlashMessage

VERSION

string

2.2.0

RECAPTCHA

Scope

PLUGIN

Struct

AUTHOR

string

Matthew Lesko (CFGeek.com)

COMPATIBILITY

string

2.0.0,2.0.1,2.1.0,2.2.0,2.3.0,2.4.0,2.5.0

NAME

string

reCaptcha

VERSION

string

1.0.0

WHEELS

Struct
Entries: 144

ACCESSCONTROLALLOWCREDENTIALS

boolean

false

ACCESSCONTROLALLOWHEADERS

string

Origin, Content-Type, X-Auth-Token, X-Requested-By, X-Requested-With

ACCESSCONTROLALLOWMETHODS

string

GET, POST, PATCH, PUT, DELETE, OPTIONS

ACCESSCONTROLALLOWMETHODSBYROUTE

boolean

false

ACCESSCONTROLALLOWORIGIN

string

ALLOWCORSREQUESTS

boolean

false

ALLOWENVIRONMENTSWITCHVIAURL

boolean

true

ALLOWMIGRATIONDOWN

boolean

false

ASSETPATHS

boolean

false

ASSETQUERYSTRING

string

869B839228FED626246132FD12D80EC2

AUTOMATICVALIDATIONS

boolean

true

AUTOMIGRATEDATABASE

boolean

false

BOOLEANATTRIBUTES

string

allowfullscreen,async,autofocus,autoplay,checked,compact,controls,declare,default,defaultchecked,defaultmuted,defaultselected,defer,disabled,draggable,enabled,formnovalidate,hidden,indeterminate,inert,ismap,itemscope,loop,multiple,muted,nohref,noresize,noshade,novalidate,nowrap,open,pauseonexit,readonly,required,reversed,scoped,seamless,selected,sortable,spellcheck,translate,truespeed,typemustmatch,visible

CACHE

Struct

ACTION

Struct

IMAGE

Struct
Entries: 22

0606FCE2DC17F42ECA7AF2B1E692380A

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:58:09'}

VALUE

string

152DCA225A860B77742850D7ED31390F

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 11:17:42'}

VALUE

string

1A563201016BDCC3F7FC1FE3777B6453

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:58:09'}

VALUE

string

1BB1A6A067F8A7F1115F0BFD1D4BCFE7

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 12:08:28'}

VALUE

string

2A1BF6173DB93B8B418FB201D9D1A4A0

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-17 22:58:53'}

VALUE

string

2A3E9A5293BE26907C3AE54CF0E51788

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 11:17:42'}

VALUE

string

2E03E50DBDBC8D3C07D59CFAA3B84FD0

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-17 21:46:47'}

VALUE

string

2E72AAC631E0EBC4E57AE5B8C1ABBBAE

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:58:09'}

VALUE

string

53BC51725E86DD7183E2ABDAB8341A75

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 11:17:42'}

VALUE

string

5B5B49C895CF0CB36055049F6E5E3B64

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:58:09'}

VALUE

string

69E9CCEBF63BB6A315D93FFF7447BD11

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 11:17:42'}

VALUE

string

71CB1A2612B76BC062A6A0771A99FE3C

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 11:17:42'}

VALUE

string

755ADA7217209370AA475CDADCB79CA7

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:58:09'}

VALUE

string

A2B037C5AD8111E685C63C35D7055E43

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 11:17:42'}

VALUE

string

AC907D9C63F4E52F3F35019C3682F326

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:05:51'}

VALUE

string

AD7AEDFD5C53EEDDE6512B92A9F2D946

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 11:17:42'}

VALUE

string

B6F7B68438204F08617351E7EF281155

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 12:20:05'}

VALUE

string

BAB5B2070DBFD48D0F7B024570753275

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:58:09'}

VALUE

string

C2D27F600184AB1E6A7FE0E9E4D0830A

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 12:20:05'}

VALUE

string

C8DFEEAC170C4DE0583595C32F5A43EB

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 10:37:44'}

VALUE

string

CE67253464D7498F627387583B6B28F9

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 10:37:44'}

VALUE

string

FEE4D2650A3B052CEAA54364007FA573

Struct

EXPIRESAT

Date Time (America/Chicago)

{ts '2025-04-24 09:58:09'}

VALUE

string

MAIN

Struct

PAGE

Struct

PARTIAL

Struct

QUERY

Struct

SQL

Struct

CACHEACTIONS

boolean

true

CACHECONTROLLERCONFIG

boolean

true

CACHECULLINTERVAL

number

CACHECULLPERCENTAGE

number

CACHEDATABASESCHEMA

boolean

true

CACHEDATEPART

string

CACHEFILECHECKING

boolean

true

CACHEIMAGES

boolean

true

CACHEKEY

string

11D678F82EF55A2AED278289DDB022C3

CACHELASTCULLEDAT

Date Time (America/Chicago)

{ts '2025-04-16 11:03:37'}

CACHEMODELCONFIG

boolean

true

CACHEPAGES

boolean

true

CACHEPARTIALS

boolean

true

CACHEPLUGINS

boolean

true

CACHEQUERIES

boolean

true

CACHEQUERIESDURINGREQUEST

boolean

true

CLEARQUERYCACHEONRELOAD

boolean

true

CLEARTEMPLATECACHEONRELOAD

boolean

true

CONTROLLERPATH

string

controllers

CONTROLLERS

Struct

Pages

Component (controllers.Pages)
Only the functions and data members that are accessible from your location are displayed

Extends

Controller

this

public

$abortInvalidRequest

Public Function $abortInvalidRequest
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$abortIssued

Public Function $abortIssued
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$acceptableFormats

Public Function $acceptableFormats
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$addCachableAction

Public Function $addCachableAction
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Called from the caches function.

arguments

label	name	required	type	default	hint
	action	true	struct	null

return type

void

$addImageTagToCache

Public Function $addImageTagToCache
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Calls $imageTag and adds the result to the cache.
Called from the imageTag function above if images are set to be cached and the image is not already in the cache.

arguments

label

name

required

type

default

hint

return type

string

$addToCache

Public Function $addToCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	value	true	any	null
	time	false	numeric	60
	category	false	string	main

return type

void

$ampmSelectTag

Public Function $ampmSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	value	true	string	null
	$id	true	string	null
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

$appendQueryString

Public Function $appendQueryString
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Appends a query string to the asset (a new query string is created on each app reload).
Used to force local browser caches to refresh when there is an update to assets (CSS, JavaScript etc).

arguments

label

name

required

type

default

hint

return type

string

$appKey

Public Function $appKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$args

Public Function $args
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	name	true	string	null
	reserved	false	string
	combine	false	string
	required	false	string

return type

void

$argumentsForPartial

Public Function $argumentsForPartial
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$assetDomain

Public Function $assetDomain
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Internal function.

arguments

label	name	required	type	default	hint
	pathToAsset	true	string	null

return type

string

$autoLinkLoop

Public Function $autoLinkLoop
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Called from the autoLink function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	regex	true	string	null
	protocol	false	string

return type

string

$buildReleaseZip

Public Function $buildReleaseZip
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
NB: url rewriting files need to be removed from here.

arguments

label	name	required	type	default	hint
	version	false	string	2.5.0
	directory	false	string	C:\home\pptinc.org\wwwroot\

return type

string

$cachableActions

Public Function $cachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Called when processing a request, and from other functions in this file, to get all cachable actions.

arguments

label

name

required

type

default

hint

return type

array

$cache

Public Function $cache
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$cacheCount

Public Function $cacheCount
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

numeric

$cachedControllerClassExists

Public Function $cachedControllerClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cachedModelClassExists

Public Function $cachedModelClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cacheSettingsForAction

Public Function $cacheSettingsForAction
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Get cache info, only called from the test suite

arguments

label	name	required	type	default	hint
	action	true	string	null

return type

any

$callAction

Public Function $callAction
source: C:\home\pptinc.org\wwwroot\wheels\controller\processing.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	true	string	null

return type

void

$callActionAndAddToCache

Public Function $callActionAndAddToCache
source: C:\home\pptinc.org\wwwroot\wheels\controller\processing.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	true	string	null
	time	true	numeric	null
	key	true	string	null
	category	true	string	null

return type

string

$canonicalize

Public Function $canonicalize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Call CFML's canonicalize() function but set to blank string if the result is null (happens on Lucee 5).

arguments

label	name	required	type	default	hint
	input	true	string	null

return type

string

$cgiScope

Public Function $cgiScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
This copies all the variables CFWheels needs from the CGI scope to the request scope.

arguments

label	name	required	type	default	hint
	keys	false	string	request_method,http_x_requested_with,http_referer,server_name,path_info,script_name,query_string,remote_addr,server_port,server_port_secure,server_protocol,http_host,http_accept,content_type,http_x_rewrite_url,http_x_original_url,request_uri,redirect_url,http_x_forwarded_for,http_x_forwarded_proto
	scope	false	struct

return type

struct

$checkVerificationsVars

Public Function $checkVerificationsVars
source: C:\home\pptinc.org\wwwroot\wheels\controller\verifies.cfm
Internal function.

arguments

label	name	required	type	default	hint
	scope	true	struct	null
	vars	true	string	null
	types	true	string	null

return type

boolean

$cleanInlist

Public Function $cleanInlist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	where	true	string	null

return type

any

$clearCachableActions

Public Function $clearCachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Delete all cache info, only called from the test suite.

arguments

label

name

required

type

default

hint

return type

void

$clearCache

Public Function $clearCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

void

$clearControllerInitializationCache

Public Function $clearControllerInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$clearModelInitializationCache

Public Function $clearModelInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$combineArguments

Public Function $combineArguments
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	combine	true	string	null
	required	true	boolean	false
	extendedInfo	false	string

return type

void

$constructParams

Public Function $constructParams
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	true	string	null
	encode	false	boolean	true
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

$content

Public Function $content
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$contentType

Public Function $contentType
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Gets the value of the content type header (blank string if it doesn't exist) of the response we're about to send.

arguments

label

name

required

type

default

hint

return type

string

$convertToString

Public Function $convertToString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	any	null
	type	false	string

return type

string

$createControllerClass

Public Function $createControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	controllerPaths	false	string
	type	false	string	controller

return type

any

$createControllerObject

Public Function $createControllerObject
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
If the controller file exists we instantiate it, otherwise we instantiate the parent controller.
This is done so that an action's view page can be rendered without having an actual controller file for it.

arguments

label	name	required	type	default	hint
	params	true	struct	null

return type

any

$createLabel

Public Function $createLabel
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	string	null
	prependToLabel	true	string	null
	encode	false	any	false

return type

string

$createModelClass

Public Function $createModelClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	modelPaths	false	string	models
	type	false	string	model

return type

any

$createObjectFromRoot

Public Function $createObjectFromRoot
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null
	fileName	true	string	null
	method	true	string	null

return type

any

$csrfCookieAttributeCollection

Public Function $csrfCookieAttributeCollection
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	string	null

return type

struct

$dateForSelectTags

Public Function $dateForSelectTags
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Internal function.

arguments

label	name	required	type	default	hint
	part	true	string	null
	value	true	numeric	null
	$now	true	date	null

return type

datetime

$dateOrTimeSelect

Public Function $dateOrTimeSelect
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	$functionName	true	string	null
	combine	false	boolean	true
	twelveHour	false	boolean	false

return type

string

$daySelectTag

Public Function $daySelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$dbinfo

Public Function $dbinfo
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$debugPoint

Public Function $debugPoint
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

void

$directory

Public Function $directory
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$dollarify

Public Function $dollarify
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	input	true	struct	null
	on	true	string	null

return type

struct

$doubleCheckedLock

Public Function $doubleCheckedLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	condition	true	string	null
	execute	true	string	null
	conditionArgs	false	struct
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$element

Public Function $element
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Creates an HTML element.

arguments

label	name	required	type	default	hint
	name	true	string	null
	attributes	false	struct
	content	false	string
	skip	false	string
	skipStartingWith	false	string
	encode	false	any	false
	encodeExcept	false	string

return type

string

$file

Public Function $file
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$fileExistsNoCase

Public Function $fileExistsNoCase
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	absolutePath	true	string	null

return type

any

$findRoute

Public Function $findRoute
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$flagRequestAsProtected

Public Function $flagRequestAsProtected
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$flashClear

Public Function $flashClear
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$formAfterElement

Public Function $formAfterElement
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	string	null
	labelPlacement	true	string	null
	prepend	true	string	null
	append	true	string	null
	prependToLabel	true	string	null
	appendToLabel	true	string	null
	errorElement	true	string	null
	encode	false	any	false

return type

string

$formatTemplatePathExists

Public Function $formatTemplatePathExists
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$name	true	string	null

return type

boolean

$formBeforeElement

Public Function $formBeforeElement
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	any	null
	labelPlacement	true	string	null
	prepend	true	string	null
	append	true	string	null
	prependToLabel	true	string	null
	appendToLabel	true	string	null
	errorElement	true	string	null
	errorClass	true	string	null
	encode	false	any	false

return type

string

$formHasError

Public Function $formHasError
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

boolean

$formValue

Public Function $formValue
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

string

$fullCgiDomainString

Public Function $fullCgiDomainString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get full domain string from cgi scope: includes protocol and port
e.g https://www.cfwheels.com:443

arguments

label	name	required	type	default	hint
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

string

$fullDomainString

Public Function $fullDomainString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get full domain string from a passed in string: includes protocol and port
e.g https://www.cfwheels.com -> https://www.cfwheels.com:443
e.g www.cfwheels.com -> http://www.cfwheels.com:80

arguments

label	name	required	type	default	hint
	domain	true	string	null	The string to look at

return type

string

$generateAuthenticityToken

Public Function $generateAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$generateCookieAuthenticityToken

Public Function $generateCookieAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$generateIncludeTemplatePath

Public Function $generateIncludeTemplatePath
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$name	true	any	null
	$type	true	any	null
	$controllerName	false	string
	$baseTemplatePath	false	string
	$prependWithUnderscore	false	boolean	true

return type

string

$generateRenderWithTemplatePath

Public Function $generateRenderWithTemplatePath
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	controller	true	string	null
	action	true	string	null
	template	true	string	null
	contentType	true	string	null

return type

string

$get

Public Function $get
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from get().

arguments

label	name	required	type	default	hint
	name	true	string	null
	functionName	false	string

return type

any

$getControllerClassData

Public Function $getControllerClassData
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
Return the controller data that is on the class level.

arguments

label

name

required

type

default

hint

return type

struct

$getFieldLabel

Public Function $getFieldLabel
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	string	null

return type

string

$getFlashAppend

Public Function $getFlashAppend
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$getFlashStorage

Public Function $getFlashStorage
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$getFromCache

Public Function $getFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

any

$getIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

$getObject

Public Function $getObject
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectname	true	string	null

return type

any

$getRequestTimeout

Public Function $getRequestTimeout
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Returns the request timeout value in seconds

arguments

label

name

required

type

default

hint

return type

numeric

$getStatusCodes

Public Function $getStatusCodes
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Returns a list of HTTP status codes and their response names

arguments

label

name

required

type

default

hint

return type

struct

$hasCachableActions

Public Function $hasCachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Called when processing a request to see if any actions are cachable.

arguments

label

name

required

type

default

hint

return type

boolean

$hashedKey

Public Function $hashedKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Creates a unique string based on any arguments passed in (used as a key for caching mostly).

arguments

label

name

required

type

default

hint

return type

string

$hasManyFormValue

Public Function $hasManyFormValue
source: C:\home\pptinc.org\wwwroot\wheels\view\formsassociation.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	string	null
	association	true	string	null
	property	true	string	null
	keys	true	string	null

return type

string

$header

Public Function $header
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$hourSelectTag

Public Function $hourSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$htmlhead

Public Function $htmlhead
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$image

Public Function $image
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

struct

$imageTag

Public Function $imageTag
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Called from the imageTag function above to do all of the work (create the tag, get width / height using cfimage etc).

arguments

label

name

required

type

default

hint

return type

string

$include

Public Function $include
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndOutput

Public Function $includeAndOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndReturnOutput

Public Function $includeAndReturnOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	$template	true	string	null

return type

string

$includeFile

Public Function $includeFile
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$name	true	any	null
	$template	true	any	null
	$type	true	any	null

return type

string

$includeOrRenderPartial

Public Function $includeOrRenderPartial
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$initControllerClass

Public Function $initControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
Initialize the controller class level object and return it.

arguments

label	name	required	type	default	hint
	name	false	string

return type

any

$initControllerObject

Public Function $initControllerObject
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
Initialize the controller instance level object and return it.

arguments

label	name	required	type	default	hint
	name	true	string	null
	params	true	struct	null

return type

any

$initializeRequestScope

Public Function $initializeRequestScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$innerArgs

Public Function $innerArgs
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	args	true	struct	null

return type

struct

$invoke

Public Function $invoke
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$isAnyAuthenticityTokenValid

Public Function $isAnyAuthenticityTokenValid
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$isCookieAuthenticityTokenValid

Public Function $isCookieAuthenticityTokenValid
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$isRequestProtectedFromForgery

Public Function $isRequestProtectedFromForgery
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$isVerifiedRequest

Public Function $isVerifiedRequest
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$listClean

Public Function $listClean
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Removes whitespace between list elements.
Optional argument to return the list as an array.

arguments

label	name	required	type	default	hint
	list	true	string	null
	delim	false	string	,
	returnAs	false	string	string

return type

any

$listToStruct

Public Function $listToStruct
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Converts a comma delimted list to a struct

arguments

label	name	required	type	default	hint
	list	true	string	null
	value	false	string	1

return type

struct

$loadPlugins

Public Function $loadPlugins
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$loadRoutes

Public Function $loadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$location

Public Function $location
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	delay	false	boolean	false

return type

void

$lockedLoadRoutes

Public Function $lockedLoadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$mail

Public Function $mail
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$maxLength

Public Function $maxLength
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

any

$minuteSelectTag

Public Function $minuteSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	minuteStep	true	numeric	null

return type

string

$monthSelectTag

Public Function $monthSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	monthDisplay	true	string	null
	monthNames	true	string	null
	monthAbbreviations	true	string	null

return type

string

$namedArguments

Public Function $namedArguments
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Creates a struct of the named arguments passed in to a function (i.e. the ones not explicitly defined in the arguments list).

arguments

label	name	required	type	default	hint
	$defined	true	string	null

return type

struct

$objectFileName

Public Function $objectFileName
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	objectPath	true	string	null
	type	true	string	null

return type

string

$objectName

Public Function $objectName
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	association	false	string
	position	false	string

return type

any

$option

Public Function $option
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Creates an HTML "option" element.

arguments

label	name	required	type	default	hint
	objectValue	true	string	null
	optionValue	true	string	null
	optionText	true	string	null
	encode	true	any	null

return type

string

$optionsForSelect

Public Function $optionsForSelect
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Creates multiple HTML "option" elements.

arguments

label	name	required	type	default	hint
	options	true	any	null
	valueField	true	string	null
	textField	true	string	null
	encode	true	any	null

return type

string

$performedRedirect

Public Function $performedRedirect
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$performedRender

Public Function $performedRender
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$performedRenderOrRedirect

Public Function $performedRenderOrRedirect
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$prependUrl

Public Function $prependUrl
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null

return type

string

$query

Public Function $query
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	sql	true	string	null

return type

any

$readAuthenticityTokenFromCookie

Public Function $readAuthenticityTokenFromCookie
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$readFlash

Public Function $readFlash
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$reCacheRequired

Public Function $reCacheRequired
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$removeFromCache

Public Function $removeFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

void

$renderLayout

Public Function $renderLayout
source: C:\home\pptinc.org\wwwroot\wheels\controller\layouts.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$content	true	string	null
	$layout	true	any	null

return type

string

$renderPartial

Public Function $renderPartial
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$renderPartialAndAddToCache

Public Function $renderPartialAndAddToCache
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$renderView

Public Function $renderView
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$renderViewAndAddToCache

Public Function $renderViewAndAddToCache
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$requestContentType

Public Function $requestContentType
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	false	struct
	httpAccept	false	string	/

return type

string

$restoreTestRunnerApplicationScope

Public Function $restoreTestRunnerApplicationScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Restore the application scope modified by the test runner

arguments

label

name

required

type

default

hint

return type

void

$returnStatusCode

Public Function $returnStatusCode
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Returns a response code from the status code list.

arguments

label	name	required	type	default	hint
	status	false	any	200

return type

string

$returnStatusText

Public Function $returnStatusText
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Returns a response text for any status code.

arguments

label	name	required	type	default	hint
	status	false	numeric	200

return type

string

$routeVariables

Public Function $routeVariables
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$runCsrfProtection

Public Function $runCsrfProtection
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	false	string	null

return type

any

$runFilters

Public Function $runFilters
source: C:\home\pptinc.org\wwwroot\wheels\controller\filters.cfm
Called twice when processing a request, first for "before" filters and then for "after" filters.

arguments

label	name	required	type	default	hint
	type	true	string	null
	action	true	string	null

return type

void

$runVerifications

Public Function $runVerifications
source: C:\home\pptinc.org\wwwroot\wheels\controller\verifies.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	true	string	null
	params	true	struct	null
	cgiScope	false	struct
	sessionScope	false	struct
	cookieScope	false	struct

return type

void

$secondSelectTag

Public Function $secondSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	secondStep	true	numeric	null

return type

any

$sentEmails

Public Function $sentEmails
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$sentFiles

Public Function $sentFiles
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$set

Public Function $set
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from set().

arguments

label

name

required

type

default

hint

return type

void

$setAuthenticityToken

Public Function $setAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$setCachableActions

Public Function $setCachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Set cache info, only called from the test suite.

arguments

label	name	required	type	default	hint
	actions	true	array	null

return type

void

$setControllerClassData

Public Function $setControllerClassData
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
Get the class level data from the controller object in the application scope and set it to this controller.
By class level we mean that it's stored in the controller object in the application scope.

arguments

label

name

required

type

default

hint

return type

void

$setCORSHeaders

Public Function $setCORSHeaders
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Set CORS Headers: only triggered if application.wheels.allowCorsRequests = true

arguments

label	name	required	type	default	hint
	allowOrigin	false	string	*
	allowCredentials	false	string	false
	allowHeaders	false	string	Origin, Content-Type, X-Auth-Token, X-Requested-By, X-Requested-With
	allowMethods	false	string	GET, POST, PATCH, PUT, DELETE, OPTIONS
	allowMethodsByRoute	false	boolean	false
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm

return type

void

$setFlashAppend

Public Function $setFlashAppend
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label	name	required	type	default	hint
	append	true	boolean	null

return type

void

$setFlashStorage

Public Function $setFlashStorage
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label	name	required	type	default	hint
	storage	true	string	null

return type

void

$setNamedRoutePositions

Public Function $setNamedRoutePositions
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$setRequestStatusCode

Public Function $setRequestStatusCode
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function. If custom statuscode passed in, then set appropriate header. Status may be a numeric value such as 404, or a text value such as "Forbidden".

arguments

label	name	required	type	default	hint
	status	true	string	null

return type

void

$simpleLock

Public Function $simpleLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	type	true	string	null
	execute	true	string	null
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$singularizeOrPluralize

Public Function $singularizeOrPluralize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	which	true	string	null
	count	false	numeric	-1
	returnCount	false	boolean	true

return type

string

$statusCode

Public Function $statusCode
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get the status code (e.g. 200, 404 etc) of the response we're about to send.

arguments

label

name

required

type

default

hint

return type

string

$storeAuthenticityToken

Public Function $storeAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$structKeysExist

Public Function $structKeysExist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Check to see if all keys in the list exist for the structure and have length.

arguments

label	name	required	type	default	hint
	struct	true	struct	null
	keys	false	string

return type

boolean

$swapArrayPositionsForIds

Public Function $swapArrayPositionsForIds
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null

return type

string

$tag

Public Function $tag
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	attributes	false	struct
	skip	false	string
	skipStartingWith	false	string
	encode	false	boolean	false
	encodeExcept	false	string

return type

string

$tagAttribute

Public Function $tagAttribute
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	value	true	string	null
	encode	true	boolean	null
	encodeExcept	true	string	null

return type

string

$tagId

Public Function $tagId
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	valueToAppend	false	string

return type

string

$tagName

Public Function $tagName
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

string

$throwErrorOrShow404Page

Public Function $throwErrorOrShow404Page
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Throw a developer friendly CFWheels error if set (typically in development mode).
Otherwise show the 404 page for end users (typically in production mode).

arguments

label	name	required	type	default	hint
	type	true	string	null
	message	true	string	null
	extendedInfo	false	string

return type

void

$timeSpanForCache

Public Function $timeSpanForCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	cache	true	any	null
	defaultCacheTime	false	numeric	60
	cacheDatePart	false	string	n

return type

any

$timestamp

Public Function $timestamp
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	timeStampMode	false	string	utc

return type

string

$toXml

Public Function $toXml
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	data	true	any	null

return type

xml

$useLayout

Public Function $useLayout
source: C:\home\pptinc.org\wwwroot\wheels\controller\layouts.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$action	true	string	null

return type

any

$verifyAuthenticityToken

Public Function $verifyAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$wddx

Public Function $wddx
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	input	true	any	null
	action	false	string	cfml2wddx
	useTimeZoneInfo	false	boolean	true

return type

any

$wildcardDomainMatch

Public Function $wildcardDomainMatch
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Wildcard domain match: domain satifies wildcard

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	origin	true	string	null	string to test against e.g bar.foo.com

return type

boolean

$wildcardDomainMatchCGI

Public Function $wildcardDomainMatchCGI
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Wildcard domain match: check if the current cgi.server_name and port satisfies
the passed in domain string whilst checking for wildcards

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

boolean

$writeFlash

Public Function $writeFlash
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label	name	required	type	default	hint
	flash	false	struct

return type

any

$yearMonthHourMinuteSecondSelectTag

Public Function $yearMonthHourMinuteSecondSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	value	true	string	null
	includeBlank	true	any	null
	label	true	string	null
	labelPlacement	true	string	null
	prepend	true	string	null
	append	true	string	null
	prependToLabel	true	string	null
	appendToLabel	true	string	null
	errorElement	false	string
	errorClass	false	string
	$type	true	string	null
	$loopFrom	true	numeric	null
	$loopTo	true	numeric	null
	$id	true	string	null
	$step	true	numeric	null
	$optionNames	false	string
	twelveHour	false	boolean	false
	$now	false	date	{ts '2025-04-24 11:22:35'}
	encode	false	any	false

return type

string

$yearMonthHourMinuteSecondSelectTagContent

Public Function $yearMonthHourMinuteSecondSelectTagContent
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$yearSelectTag

Public Function $yearSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	startYear	true	numeric	null
	endYear	true	numeric	null

return type

string

$zip

Public Function $zip
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

about

Public Function about
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

any

addFormat

Public Function addFormat
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Adds a new MIME type to your CFWheels application for use with responding to multiple formats.
[section: Configuration]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	extension	true	string	null	File extension to add.
	mimeType	true	string	null	Matching MIME type to associate with the file extension.

return type

void

authenticityToken

Public Function authenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Returns the raw CSRF authenticity token
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

string

authenticityTokenField

Public Function authenticityTokenField
source: C:\home\pptinc.org\wwwroot\wheels\view\csrf.cfm
Returns a hidden form field containing a new authenticity token.
[section: View Helpers]
[category: General Form Functions]

arguments

label

name

required

type

default

hint

return type

string

autoLink

Public Function autoLink
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Turns all URLs and email addresses into links.
[section: View Helpers]
[category: Link Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to create links in.
	link	false	string	null	Whether to link URLs, email addresses or both. Possible values are: `all` (default), `URLs` and `emailAddresses`.
	relative	false	boolean	true	Should we auto-link relative urls.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

buttonTag

Public Function buttonTag
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Builds and returns a string containing a button form control.
[section: View Helpers]
[category: General Form Functions]

arguments

label	name	required	type	default	hint
	content	false	string	null	Content to display inside the button.
	type	false	string	null	The type for the button: `button`, `reset`, or `submit`.
	value	false	string	null	The value of the button when submitted.
	image	false	string	null	File name of the image file to use in the button form control.
	prepend	false	string	null	[see:textField]
	append	false	string	null	[see:textField]
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

buttonTo

Public Function buttonTo
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Creates a form containing a single button that submits to the URL.
The URL is built the same way as the `linkTo` function.
[section: View Helpers]
[category: Link Functions]

arguments

label	name	required	type	default	hint
	text	false	string	null	The text content of the button.
	image	false	string	null	If you want to use an image for the button pass in the link to it here (relative from the `images` folder).
	route	false	string		[see:URLFor].
	controller	false	string		[see:URLFor].
	action	false	string		[see:URLFor].
	key	false	any		[see:URLFor].
	params	false	string		[see:URLFor].
	anchor	false	string		[see:URLFor].
	method	false	string	null	[see:startFormTag].
	onlyPath	false	boolean	null	[see:URLFor].
	host	false	string	null	[see:URLFor].
	protocol	false	string	null	[see:URLFor].
	port	false	numeric	null	[see:URLFor].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

caches

Public Function caches
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Tells CFWheels to cache one or more actions.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	action	false	string		Action(s) to cache. This argument is also aliased as `actions`.
	time	false	numeric	null	Minutes to cache the action(s) for.
	static	false	boolean	null	Set to `true` to tell CFWheels that this is a static page and that it can skip running the controller filters (before and after filters set on actions). Please note that the `onSessionStart` and `onRequestStart` events still execute though.
	appendToKey	false	string		List of variables to be evaluated at runtime and included in the cache key so that content can be cached separately.

return type

void

capitalize

Public Function capitalize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Capitalizes all words in the text to create a nicer looking title.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null

return type

string

checkBox

Public Function checkBox
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a check box form control based on the supplied name.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	checkedValue	false	string	null
	uncheckedValue	false	string	null	The value of the check box when it's on the unchecked state.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

checkBoxTag

Public Function checkBoxTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a check box form control based on the supplied name.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	checked	false	boolean	false	Whether or not the check box should be checked by default.
	value	false	string	null	Value of check box in its checked state.
	uncheckedValue	false	string		The value of the check box when it's on the unchecked state.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

config

Public Function config
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

any

contact

Public Function contact
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

any

contentFor

Public Function contentFor
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Used to store a section's output for rendering within a layout.
This content store acts as a stack, so you can store multiple pieces of content for a given section.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	position	false	any	last	The position in the section's stack where you want the content placed. Valid values are `first`, `last`, or the numeric position.
	overwrite	false	any	false	Whether or not to overwrite any of the content. Valid values are `false`, `true`, or `all`.

return type

void

contentForLayout

Public Function contentForLayout
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Includes content for the body section, which equates to the output generated by the view template run by the request.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

string

controller

Public Function controller
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Creates and returns a controller object with your own custom name and params.
Used primarily for testing purposes.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the controller to create.
	params	false	struct		The params struct (combination of form and URL variables).

return type

any

csrfMetaTags

Public Function csrfMetaTags
source: C:\home\pptinc.org\wwwroot\wheels\view\csrf.cfm
Include this in your layouts' `head` sections to include meta tags containing the authenticity token for use by JavaScript AJAX requests needing to `POST` data to your application.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

cycle

Public Function cycle
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Cycles through list values every time it is called.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	values	true	string	null	List of values to cycle through.
	name	false	string	default	Name to give the cycle. Useful when you use multiple cycles on a page.

return type

string

dateSelect

Public Function dateSelect
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateobject.cfm
Builds and returns a string containing three `select` form controls for month, day, and year based on the supplied `objectName` and `property`.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	false	any		The variable name of the object to build the form control for.
	property	false	string		The name of the property to use in the form control.
	association	false	string	null	The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and CFWheels will figure it out.
	position	false	string	null	The position used when referencing a `hasMany` relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and CFWheels will figure it out.
	order	false	string	null	Use to change the order of or exclude date `select` tags.
	separator	false	string	null
	startYear	false	numeric	null	First year in `select` list.
	endYear	false	numeric	null	Last year in `select` list.
	monthDisplay	false	string	null	Pass in names, numbers, or abbreviations to control display.
	monthNames	false	string	null
	monthAbbreviations	false	string	null
	includeBlank	false	any	null	Whether to include a blank option in the `select` form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using `aroundLeft` or `aroundRight`.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The `class` name of the HTML tag that wraps the form control when there are errors.
	combine	false	boolean	null	[see:dateTimeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

dateSelectTags

Public Function dateSelectTags
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing three `select` form controls (month, day, and year) based on a name and value.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		[see:selectTag].
	order	false	string	null	[see:dateSelect].
	separator	false	string	null	[see:dateSelect].
	startYear	false	numeric	null	[see:dateSelect].
	endYear	false	numeric	null	[see:dateSelect].
	monthDisplay	false	string	null	[see:dateSelect].
	monthNames	false	string	null	[see:dateSelect].
	monthAbbreviations	false	string	null	[see:dateSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

dateTimeSelect

Public Function dateTimeSelect
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateobject.cfm
Builds and returns a string containing six `select` form controls (three for date selection and the remaining three for time selection) based on the supplied objectName and property.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	string	null	The variable name of the object to build the form control for.
	property	true	string	null	The name of the property to use in the form control.
	association	false	string	null	The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.
	position	false	string	null	The position used when referencing a hasMany relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.
	dateOrder	false	string	null	Use to change the order of or exclude date select tags.
	dateSeparator	false	string	null
	startYear	false	numeric	null	Last year in select list.
	endYear	false	numeric	null
	monthDisplay	false	string	null	Pass in names, numbers, or abbreviations to control display.
	monthNames	false	string	null
	monthAbbreviations	false	string	null
	timeOrder	false	string	null	Use to change the order of or exclude time select tags.
	timeSeparator	false	string	null	Use to change the character that is displayed between the time select tags.
	minuteStep	false	numeric	null	Pass in 10 to only show minute 10, 20, 30, etc.
	secondStep	false	numeric	null	Pass in 10 to only show seconds 10, 20, 30, etc
	separator	false	string	null	Use to change the character that is displayed between the first and second set of select tags.
	includeBlank	false	any	null	Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The class name of the HTML tag that wraps the form control when there are errors.
	combine	false	boolean	null	Set to false to not combine the select parts into a single DateTime object.
	twelveHour	false	boolean	null	Whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

dateTimeSelectTags

Public Function dateTimeSelectTags
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing six `select` form controls (three for date selection and the remaining three for time selection) based on a name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		[see:selectTag].
	dateOrder	false	string	null	[see:dateTimeSelect].
	dateSeparator	false	string	null	[see:dateTimeSelect].
	startYear	false	numeric	null	[see:dateSelect].
	endYear	false	numeric	null	[see:dateSelect].
	monthDisplay	false	string	null	[see:dateSelect].
	monthNames	false	string	null	[see:dateSelect].
	monthAbbreviations	false	string	null	[see:dateSelect].
	timeOrder	false	string	null	[see:dateTimeSelect].
	timeSeparator	false	string	null	[see:dateTimeSelect].
	minuteStep	false	numeric	null	[see:timeSelect].
	secondStep	false	numeric	null	[see:timeSelect].
	separator	false	string	null	[see:dateTimeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	twelveHour	false	boolean	null	[see:timeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

daySelectTag

Public Function daySelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing a `select` form control for the days of the week based on the supplied name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

deobfuscateParam

Public Function deobfuscateParam
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Deobfuscates a value.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	param	true	string	null	The value to deobfuscate.

return type

string

distanceOfTimeInWords

Public Function distanceOfTimeInWords
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Pass in two dates to this method, and it will return a string describing the difference between them.
[section: Global Helpers]
[category: Date Functions]

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.

return type

string

Public Function e
source: C:\home\pptinc.org\wwwroot\views\helpers.cfm
Shortcut to encodeForHTML, because I'm lazy

arguments

label	name	required	type	default	hint
	string	false	string		The string to encode

return type

string

endFormTag

Public Function endFormTag
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Builds and returns a string containing the closing `form` tag.
[section: View Helpers]
[category: General Form Functions]

arguments

label	name	required	type	default	hint
	prepend	false	string	null	[see:textField]
	append	false	string	null	[see:textField],
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

errorMessageOn

Public Function errorMessageOn
source: C:\home\pptinc.org\wwwroot\wheels\view\errors.cfm
Returns the error message, if one exists, on the object's property.
If multiple error messages exist, the first one is returned.
[section: View Helpers]
[category: Error Functions]

arguments

label	name	required	type	default	hint
	objectName	true	string	null	The variable name of the object to display the error message for.
	property	true	string	null	The name of the property to display the error message for.
	prependText	false	string	null	String to prepend to the error message.
	appendText	false	string	null	String to append to the error message.
	wrapperElement	false	string	null	HTML element to wrap the error message in.
	class	false	string	null	CSS `class` to set on the wrapper element.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

errorMessagesFor

Public Function errorMessagesFor
source: C:\home\pptinc.org\wwwroot\wheels\view\errors.cfm
Builds and returns a list (`ul` tag with a default `class` of `error-messages`) containing all the error messages for all the properties of the object.
Returns an empty string if no errors exist.
[section: View Helpers]
[category: Error Functions]

arguments

label	name	required	type	default	hint
	objectName	true	string	null	The variable name of the object to display error messages for.
	class	false	string	null	CSS `class` to set on the `ul` element.
	showDuplicates	false	boolean	null	Whether or not to show duplicate error messages.
	encode	false	boolean	null	[see:styleSheetLinkTag].
	includeAssociations	false	boolean	false

return type

string

excerpt

Public Function excerpt
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Extracts an excerpt from text that matches the first instance of a given phrase.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to extract an excerpt from.
	phrase	true	string	null	The phrase to extract.
	radius	false	numeric	null	Number of characters to extract surrounding the phrase.
	excerptString	false	string	null	String to replace first and / or last characters with.

return type

string

faq

Public Function faq
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

any

fileField

Public Function fileField
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a file field form control based on the supplied objectName and property.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

fileFieldTag

Public Function fileFieldTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a file form control based on the supplied name.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

filterChain

Public Function filterChain
source: C:\home\pptinc.org\wwwroot\wheels\controller\filters.cfm
Returns an array of all the filters set on current controller in the order in which they will be executed.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	type	false	string	all	Use this argument to return only before or after filters.

return type

array

filters

Public Function filters
source: C:\home\pptinc.org\wwwroot\wheels\controller\filters.cfm
Tells CFWheels to run a function before an action is run or after an action has been run.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	through	true	string	null	Function(s) to execute before or after the action(s).
	type	false	string	before	Whether to run the function(s) before or after the action(s).
	only	false	string		Pass in a list of action names (or one action name) to tell CFWheels that the filter function(s) should only be run on these actions.
	except	false	string		Pass in a list of action names (or one action name) to tell CFWheels that the filter function(s) should be run on all actions except the specified ones.
	placement	false	string	append	Pass in `prepend` to prepend the function(s) to the filter chain instead of appending.

return type

void

flash

Public Function flash
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Returns the value of a specific key in the Flash (or the entire Flash as a struct if no key is passed in).
[section: Controller]
[category: Flash Functions]

arguments

label	name	required	type	default	hint
	key	false	string	null	The key to get the value for.

return type

any

flashClear

Public Function flashClear
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Deletes everything from the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

void

flashCount

Public Function flashCount
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Returns how many keys exist in the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

numeric

flashDelete

Public Function flashDelete
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Deletes a specific key from the Flash.
Returns `true` if the key exists.
[section: Controller]
[category: Flash Functions]

arguments

label	name	required	type	default	hint
	key	true	string	null	The key to delete

return type

any

flashInsert

Public Function flashInsert
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Inserts a new key / value into the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

void

flashIsEmpty

Public Function flashIsEmpty
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Returns whether or not the Flash is empty.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

boolean

flashKeep

Public Function flashKeep
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Make the entire Flash or specific key in it stick around for one more request.
[section: Controller]
[category: Flash Functions]

arguments

label	name	required	type	default	hint
	key	false	string

return type

void

flashKeyExists

Public Function flashKeyExists
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Checks if a specific key exists in the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label	name	required	type	default	hint
	key	true	string	null	The key to check.

return type

boolean

flashMessages

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

get

Public Function get
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns the current setting for the supplied CFWheels setting or the current default for the supplied CFWheels function argument.
[section: Configuration]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	Variable name to get setting for.
	functionName	false	string		Function name to get setting for.

return type

any

getEmails

Public Function getEmails
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Primarily used for testing to get information about emails sent during the request.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

array

getFiles

Public Function getFiles
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Primarily used for testing to get information about files sent during the request.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

array

getRedirect

Public Function getRedirect
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Primarily used for testing to establish whether the current request has performed a redirect.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

struct

hasManyCheckBox

Public Function hasManyCheckBox
source: C:\home\pptinc.org\wwwroot\wheels\view\formsassociation.cfm
Used as a shortcut to output the proper form elements for an association.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Association Functions]

arguments

label	name	required	type	default	hint
	objectName	true	string	null	Name of the variable containing the parent object to represent with this form field.
	association	true	string	null	Name of the association set in the parent object to represent with this form field.
	keys	true	string	null	Primary keys associated with this form field. Note that these keys should be listed in the order that they appear in the database table.
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using `aroundLeft` or `aroundRight`.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The `class` name of the HTML tag that wraps the form control when there are errors.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

hasManyRadioButton

Public Function hasManyRadioButton
source: C:\home\pptinc.org\wwwroot\wheels\view\formsassociation.cfm
Used as a shortcut to output the proper form elements for an association.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Association Functions]

arguments

label	name	required	type	default	hint
	objectName	true	string	null	Name of the variable containing the parent object to represent with this form field.
	association	true	string	null	Name of the association set in the parent object to represent with this form field.
	property	true	string	null	Name of the property in the child object to represent with this form field.
	keys	true	string	null	Primary keys associated with this form field. Note that these keys should be listed in the order that they appear in the database table.
	tagValue	true	string	null	The value of the radio button when selected.
	checkIfBlank	false	boolean	false	Whether or not to check this form field as a default if there is a blank value set for the property.
	label	false	string	null	The label text to use in the form control.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

hiddenField

Public Function hiddenField
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a hidden field form control based on the supplied objectName and property.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

hiddenFieldTag

Public Function hiddenFieldTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a hidden field form control based on the supplied name.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	value	false	string		[see:textFieldTag].
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

highlight

Public Function highlight
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Highlights the phrase(s) everywhere in the text if found by wrapping them in `span` tags.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to search in.
	phrase	false	string	null	Phrase (or list of phrases) to highlight. This argument is also aliased as `phrases`.
	delimiter	false	string	null	Delimiter to use when passing in multiple phrases.
	tag	false	string	null	HTML tag to use to wrap the highlighted phrase(s).
	class	false	string	null	Class to use in the tags wrapping highlighted phrase(s).
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

hourSelectTag

Public Function hourSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing one `select` form control for the hours of the day based on the supplied name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	twelveHour	false	boolean	null	[see:timeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

humanize

Public Function humanize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns readable text by capitalizing and converting camel casing to multiple words.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to humanize.
	except	false	string		A list of strings (space separated) to replace within the output.

return type

string

hyphenize

Public Function hyphenize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Converts camelCase strings to lowercase strings with hyphens as word delimiters instead. Example: myVariable becomes my-variable.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	string	true	string	null	The string to hyphenize.

return type

string

imageTag

Public Function imageTag
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Returns an `img` tag.
If the image is stored in the local `images` folder, the tag will also set the `width`, `height`, and `alt` attributes for you.
You can pass any additional arguments (e.g. `class`, `rel`, `id`), and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Asset Functions]

arguments

label	name	required	type	default	hint
	source	true	string	null	The file name of the image if it's available in the local file system (i.e. ColdFusion will be able to access it). Provide the full URL if the image is on a remote server.
	onlyPath	false	boolean	null
	host	false	string	null
	protocol	false	string	null
	port	false	numeric	null
	encode	false	boolean	null	[see:styleSheetLinkTag].
	required	false	boolean	true

return type

string

includeContent

Public Function includeContent
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Used to output the content for a particular section in a layout.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	name	false	string	body	Name of layout section to return content for.
	defaultValue	false	string		What to display as a default if the section is not defined.

return type

string

includedInObject

Public Function includedInObject
source: C:\home\pptinc.org\wwwroot\wheels\view\formsassociation.cfm
Used as a shortcut to check if the specified IDs are a part of the main form object.
This method should only be used for `hasMany` associations.
[section: View Helpers]
[category: Form Association Functions]

arguments

label	name	required	type	default	hint
	objectName	true	string	null	Name of the variable containing the parent object to represent with this form field.
	association	true	string	null	Name of the association set in the parent object to represent with this form field.
	keys	true	string	null	Primary keys associated with this form field. Note that these keys should be listed in the order that they appear in the database table.

return type

boolean

includeLayout

Public Function includeLayout
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Includes the contents of another layout file.
This is usually used to include a parent layout from within a child layout.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	name	false	string	layout	Name of the layout file to include.

return type

string

includePartial

Public Function includePartial
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Includes the specified partial file in the view.
Similar to using `cfinclude` but with the ability to cache the result and use CFWheels-specific file look-up.
By default, CFWheels will look for the file in the current controller's view folder.
To include a file relative from the base `views` folder, you can start the path supplied to `partial` with a forward slash.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	partial	true	any	null	The name of the partial file to be used. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension. If you want to have CFWheels display the partial for a single model object, array of model objects, or a query, pass a variable containing that data into this argument.
	group	false	string		If passing a query result set for the partial argument, use this to specify the field to group the query by. A new query will be passed into the partial template for you to iterate over.
	cache	false	any		Number of minutes to cache the content for.
	layout	false	string	null	The layout to wrap the content in. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.
	spacer	false	string	null	HTML or string to place between partials when called using a query.
	dataFunction	false	any	null	Name of controller function to load data from.
	$prependWithUnderscore	false	boolean	true

return type

string

includeReCaptchaJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

index

Public Function index
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

any

insertReCaptchaDiv

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

isAjax

Public Function isAjax
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the page was called from JavaScript or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isDelete

Public Function isDelete
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the request was a `DELETE` request or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isGet

Public Function isGet
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the request was a normal `GET` request or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isHead

Public Function isHead
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the request was a `HEAD` request or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isOptions

Public Function isOptions
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the request was an `OPTIONS` request or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isPatch

Public Function isPatch
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the request was a `PATCH` request or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isPost

Public Function isPost
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the request came from a form `POST` submission or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isPut

Public Function isPut
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether the request was a `PUT` request or not.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isSecure

Public Function isSecure
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Returns whether CFWheels is communicating over a secure port.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

boolean

isValidReCaptcha

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

javaScriptIncludeTag

Public Function javaScriptIncludeTag
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Returns a `script` tag for a JavaScript file (or several) based on the supplied arguments.
[section: View Helpers]
[category: Asset Functions]

arguments

label	name	required	type	default	hint
	sources	false	string		The name of one or many JavaScript files in the `javascripts` folder, minus the `.js` extension. Pass a full URL to access an external JavaScript file. Can also be called with the `source` argument.
	type	false	string	null	The `type` attribute for the `script` tag.
	head	false	boolean	null	Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior (which is to place the output where the function is called from).
	delim	false	string	,	The delimiter to use for the list of JavaScript files.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

jobs

Public Function jobs
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

any

linkTo

Public Function linkTo
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Creates a link to another page in your application.
Pass in the name of a route to use your configured routes or a controller/action/key combination.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Link Functions]

arguments

label	name	required	type	default	hint
	text	false	string	null	The text content of the link.
	route	false	string		Name of a route that you have configured in config/routes.cfm.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: wheels=cool&x=y). Please note that CFWheels uses the & and = characters to split the parameters and encode them properly for you. However, if you need to pass in & or = as part of the value, then you need to encode them (and only them), example: a=cats%26dogs%3Dtrouble!&b=1.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If true, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	href	false	string	null	Pass a link to an external site here if you want to bypass the CFWheels routing system altogether and link to an external URL.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

mailTo

Public Function mailTo
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Creates a `mailto` link tag to the specified email address, which is also used as the name of the link unless name is specified.
[section: View Helpers]
[category: Link Functions]

arguments

label	name	required	type	default	hint
	emailAddress	true	string	null	The email address to link to.
	name	false	string		A string to use as the link text ("Joe" or "Support Department", for example).
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

mapper

Public Function mapper
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns the mapper object used to configure your application's routes. Usually you will use this method in `config/routes.cfm` to start chaining route mapping methods like `resources`, `namespace`, etc.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	restful	false	boolean	true	Whether to turn on RESTful routing or not. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	methods	false	boolean		If not RESTful, then specify allowed routes. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	mapFormat	false	boolean	true	This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc. Set to false to disable automatic .[format] generation for resource based routes

return type

struct

mimeTypes

Public Function mimeTypes
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns an associated MIME type based on a file extension.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	extension	true	string	null	The extension to get the MIME type for.
	fallback	false	string	application/octet-stream	The fallback MIME type to return.

return type

string

minuteSelectTag

Public Function minuteSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing one `select` form control for the minutes of an hour based on the supplied name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	minuteStep	false	numeric	null	[see:timeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

model

Public Function model
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns a reference to the requested model so that class level methods can be called on it.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the model to get a reference to.

return type

any

monthSelectTag

Public Function monthSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing a `select` form control for the months of the year based on the supplied name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The month that should be selected initially.
	monthDisplay	false	string	null	[see:dateSelect].
	monthNames	false	string	null	[see:dateSelect].
	monthAbbreviations	false	string	null	[see:dateSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	around [see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

obfuscateParam

Public Function obfuscateParam
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Obfuscates a value. Typically used for hiding primary key values when passed along in the URL.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	param	true	any	null	The value to obfuscate.

return type

string

onlyProvides

Public Function onlyProvides
source: C:\home\pptinc.org\wwwroot\wheels\controller\provides.cfm
Use this in an individual controller action to define which formats the action will respond with.
This can be used to define provides behavior in individual actions or to override a global setting set with `provides` in the controller's `config()`.
[section: Controller]
[category: Provides Functions]

arguments

label	name	required	type	default	hint
	formats	false	string		[see:provides].
	action	false	string		Name of action, defaults to current.

return type

void

pagination

Public Function pagination
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns a struct with information about the specificed paginated query.
The keys that will be included in the struct are `currentPage`, `totalPages` and `totalRecords`.
[section: Controller]
[category: Pagination Functions]

arguments

label	name	required	type	default	hint
	handle	false	string	query	The handle given to the query to return pagination information for.

return type

struct

paginationLinks

Public Function paginationLinks
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Builds and returns a string containing links to pages based on a paginated query.
Uses `linkTo()` internally to build the link, so you need to pass in a route name or a controller/action/key combination.
All other `linkTo()` arguments can be supplied as well, in which case they are passed through directly to `linkTo()`.
If you have paginated more than one query in the controller, you can use the handle argument to reference them. (Don't forget to pass in a handle to the `findAll()` function in your controller first.)
[section: View Helpers]
[category: Link Functions]

arguments

label	name	required	type	default	hint
	windowSize	false	numeric	null	The number of page links to show around the current page.
	alwaysShowAnchors	false	boolean	null	Whether or not links to the first and last page should always be displayed.
	anchorDivider	false	string	null	String to place next to the anchors on either side of the list.
	linkToCurrentPage	false	boolean	null	Whether or not the current page should be linked to.
	prepend	false	string	null	String or HTML to be prepended before result.
	append	false	string	null	String or HTML to be appended after result.
	prependToPage	false	string	null	String or HTML to be prepended before each page number.
	addActiveClassToPrependedParent	false	boolean	null
	prependOnFirst	false	boolean	null	Whether or not to prepend the prependToPage string on the first page in the list.
	prependOnAnchor	false	boolean	null	Whether or not to prepend the prependToPage string on the anchors.
	appendToPage	false	string	null	String or HTML to be appended after each page number.
	appendOnLast	false	boolean	null	Whether or not to append the appendToPage string on the last page in the list.
	appendOnAnchor	false	boolean	null	Whether or not to append the appendToPage string on the anchors.
	classForCurrent	false	string	null	Class name for the current page number (if linkToCurrentPage is true, the class name will go on the a element. If not, a span element will be used).
	handle	false	string	query	The handle given to the query that the pagination links should be displayed for.
	name	false	string	null	The name of the param that holds the current page number.
	showSinglePage	false	boolean	null	Will show a single page when set to true. (The default behavior is to return an empty string when there is only one page in the pagination).
	pageNumberAsParam	false	boolean	null	Decides whether to link the page number as a param or as part of a route. (The default behavior is true).
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

passwordField

Public Function passwordField
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a password field form control based on the supplied objectName and property.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

passwordFieldTag

Public Function passwordFieldTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a password field form control based on the supplied name.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	value	false	string		[see:textFieldTag].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

pluginNames

Public Function pluginNames
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns a list of the names of all installed plugins.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

string

pluralize

Public Function pluralize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns the plural form of the passed in word. Can also pluralize a word based on a value passed to the `count` argument. CFWheels stores a list of words that are the same in both singular and plural form (e.g. "equipment", "information") and words that don't follow the regular pluralization rules (e.g. "child" / "children", "foot" / "feet"). Use `get("uncountables")` / `set("uncountables", newList)` and `get("irregulars")` / `set("irregulars", newList)` to modify them to suit your needs.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null	The word to pluralize.
	count	false	numeric	-1	Pluralization will occur when this value is not 1.
	returnCount	false	boolean	true	Will return count prepended to the pluralization when true and count is not -1.

return type

string

processAction

Public Function processAction
source: C:\home\pptinc.org\wwwroot\wheels\controller\processing.cfm
Process the specified action of the controller.
This is exposed in the API primarily for testing purposes; you would not usually call it directly unless in the test suite.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	includeFilters	false	string	true	Set to `before` to only execute "before" filters, `after` to only execute "after" filters or `false` to skip all filters. This argument is generally inherited from the `processRequest` function during unit test execution.

return type

boolean

processRequest

Public Function processRequest
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Creates a controller and calls an action on it.
Which controller and action that's called is determined by the params passed in.
Returns the result of the request either as a string or in a struct with `body`, `emails`, `files`, `flash`, `redirect`, `status`, and `type`.
Primarily used for testing purposes.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	params	true	struct	null	The params struct to use in the request (make sure that at least `controller` and `action` are set).
	method	false	string	null	The HTTP method to use in the request (`get`, `post` etc).
	returnAs	false	string	null	Pass in `struct` to return all information about the request instead of just the final output (`body`).
	rollback	false	string	null	Pass in `true` to roll back all database transactions made during the request.
	includeFilters	false	string	true	Set to `before` to only execute "before" filters, `after` to only execute "after" filters or `false` to skip all filters.

return type

any

protectsFromForgery

Public Function protectsFromForgery
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Tells CFWheels to protect `POST`ed requests from CSRF vulnerabilities.
Instructs the controller to verify that `params.authenticityToken` or `X-CSRF-Token` HTTP header is provided along with the request containing a valid authenticity token.
Call this method within a controller's `config` method, preferably the base `Controller.cfc` file, to protect the entire application.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	with	false	string	exception	How to handle invalid authenticity token checks. Valid values are `error` (throws a `Wheels.InvalidAuthenticityToken` error), `abort` (aborts the request silently and sends a blank response to the client), and `ignore` (ignores the check and lets the request proceed).
	only	false	string		List of actions that this check should only run on. Leave blank for all.
	except	false	string		List of actions that this check should be omitted from running on. Leave blank for no exceptions.

return type

any

provides

Public Function provides
source: C:\home\pptinc.org\wwwroot\wheels\controller\provides.cfm
Defines formats that the controller will respond with upon request.
The format can be requested through a URL variable called `format`, by appending the `format` name to the end of a URL as an extension (when URL rewriting is enabled), or in the request header.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	formats	false	string		Formats to instruct the controller to provide. Valid values are `html` (the default), `xml`, `json`, `csv`, `pdf`, and `xls`.

return type

void

radioButton

Public Function radioButton
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a radio button form control based on the supplied objectName and property.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	tagValue	false	string	null	The value of the radio button when selected.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

radioButtonTag

Public Function radioButtonTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a radio button form control based on the supplied name.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	value	true	string	null	[see:textFieldTag].
	checked	false	boolean	false	Whether or not to check the radio button by default.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].*
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

redirectTo

Public Function redirectTo
source: C:\home\pptinc.org\wwwroot\wheels\controller\redirection.cfm
Redirects the browser to the supplied controller/action/key, route or back to the referring page.
Internally, this function uses the `URLFor` function to build the link and the `cflocation` tag to perform the redirect.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	back	false	boolean	false	Set to `true` to redirect back to the referring page.
	addToken	false	boolean	null	See documentation for your CFML engine's implementation of `cflocation`.
	statusCode	false	numeric	null	See documentation for your CFML engine's implementation of `cflocation`.
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	method	false	string
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: `wheels=cool&x=y`). Please note that CFWheels uses the `&` and `=` characters to split the parameters and encode them properly for you. However, if you need to pass in `&` or `=` as part of the value, then you need to encode them (and only them), example: `a=cats%26dogs%3Dtrouble!&b=1`.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If `true`, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	url	false	string		Redirect to an external URL.
	delay	false	boolean	null	Set to `true` to delay the redirection until after the rest of your action code has executed.
	encode	false	boolean	null	[see:URLFor].

return type

void

renderNothing

Public Function renderNothing
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Instructs the controller to render an empty string when it's finished processing the action.
This is very similar to calling `cfabort` with the advantage that any after filters you have set on the action will still be run.
[section: Controller]
[category: Rendering Functions]

arguments

label	name	required	type	default	hint
	status	false	string		[see:renderView].

return type

void

renderPartial

Public Function renderPartial
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Instructs the controller to render a partial when it's finished processing the action.
[section: Controller]
[category: Rendering Functions]

arguments

label	name	required	type	default	hint
	partial	true	string	null	The name of the partial file to be used. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension.
	cache	false	any		[see:renderView].
	layout	false	string	null	[see:renderView].
	returnAs	false	string		[see:renderView].
	dataFunction	false	any	null	Name of a controller function to load data from.
	status	false	string		[see:renderView].

return type

any

renderText

Public Function renderText
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Instructs the controller to render specified text when it's finished processing the action.
[section: Controller]
[category: Rendering Functions]

arguments

label	name	required	type	default	hint
	text	false	string		The text to render.
	status	false	any		[see:renderView].

return type

void

renderView

Public Function renderView
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Instructs the controller which view template and layout to render when it's finished processing the action.
Note that when passing values for controller and / or action, this function does not execute the actual action but rather just loads the corresponding view template.
[section: Controller]
[category: Rendering Functions]

arguments

label	name	required	type	default	hint
	controller	false	string		Controller to include the view page for.
	action	false	string		Action to include the view page for.
	template	false	string		A specific template to render. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder.
	layout	false	any	null	The layout to wrap the content in. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.
	cache	false	any		Number of minutes to cache the content for.
	returnAs	false	string		Set to `string` to return the result instead of automatically sending it to the client.
	hideDebugInformation	false	boolean	false	Set to `true` to hide the debug information at the end of the output. This is useful, for example, when you're testing XML output in an environment where the global setting for `showDebugInformation` is `true`.
	status	false	string		Force request to return with specific HTTP status code.

return type

any

renderWith

Public Function renderWith
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Instructs the controller to render the data passed in to the format that is requested.
If the format requested is `json` or `xml`, CFWheels will transform the data into that format automatically.
For other formats (or to override the automatic formatting), you can also create a view template in this format: `nameofaction.xml.cfm`, `nameofaction.json.cfm`, `nameofaction.pdf.cfm`, etc.
[section: Controller]
[category: Rendering Functions]

arguments

label	name	required	type	default	hint
	data	true	any	null	Data to format and render.
	controller	false	string		[see:renderView].
	action	false	string		[see:renderView].
	template	false	string		[see:renderView].
	layout	false	any	null	[see:renderView].
	cache	false	any		[see:renderView].
	returnAs	false	string		[see:renderView].
	hideDebugInformation	false	boolean	false	[see:renderView].
	status	false	string		[see:renderView].

return type

any

resetCycle

Public Function resetCycle
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Resets a cycle so that it starts from the first list value the next time it is called.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	name	false	string	default	The name of the cycle to reset.

return type

void

response

Public Function response
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Returns content that CFWheels will send to the client in response to the request.
[section: Controller]
[category: Rendering Functions]

arguments

label

name

required

type

default

hint

return type

string

secondSelectTag

Public Function secondSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing one `select` form control for the seconds of a minute based on the supplied name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	secondStep	false	numeric	null	[see:timeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

select

Public Function select
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a select form control based on the supplied objectName and property.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	options	false	any	null	A collection to populate the select form control with. Can be a query recordset or an array of objects.
	includeBlank	false	any	null	Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
	valueField	false	string	null	The column or property to use for the value of each list element. Used only when a query or array of objects has been supplied in the options argument. Required when specifying `textField`
	textField	false	string	null	The column or property to use for the value of each list element that the end user will see. Used only when a query or array of objects has been supplied in the options argument. Required when specifying `valueField`
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

selectTag

Public Function selectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a select form control based on the supplied name and options.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	options	true	any	null	[see:select].
	selected	false	string		Value of option that should be selected by default.
	includeBlank	false	any	null	[see:select].
	multiple	false	boolean	null	Whether to allow multiple selection of options in the select form control.
	valueField	false	string	null	[see:select].
	textField	false	string	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

sendEmail

Public Function sendEmail
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Sends an email using a template and an optional layout to wrap it in.
Besides the CFWheels-specific arguments documented here, you can also pass in any argument that is accepted by the `cfmail` tag as well as your own arguments to be used by the view.
[section: Controller]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	template	false	string		The path to the email template or two paths if you want to send a multipart email. if the `detectMultipart` argument is `false`, the template for the text version should be the first one in the list. This argument is also aliased as `templates`.
	from	false	string		Email address to send from.
	to	false	string		List of email addresses to send the email to.
	subject	false	string		The subject line of the email.
	layout	false	any	null	Layout(s) to wrap the email template in. This argument is also aliased as `layouts`.
	file	false	string		A list of the names of the files to attach to the email. This will reference files stored in the `files` folder (or a path relative to it). This argument is also aliased as `files`.
	detectMultipart	false	boolean	null	When set to `true` and multiple values are provided for the `template` argument, CFWheels will detect which of the templates is text and which one is HTML (by counting the `<` characters).
	deliver	false	boolean	null	When set to `false`, the email will not be sent.
	writeToFile	false	string		The file to which the email contents will be written

return type

any

sendFile

Public Function sendFile
source: C:\home\pptinc.org\wwwroot\wheels\controller\miscellaneous.cfm
Sends a file to the user (from the `files` folder or a path relative to it by default).
[section: Controller]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	file	true	string	null	The file to send to the user.
	name	false	string		The file name to show in the browser download dialog box.
	type	false	string		The HTTP content type to deliver the file as.
	disposition	false	string	null	Set to `inline` to have the browser handle the opening of the file (possibly inline in the browser) or set to `attachment` to force a download dialog box.
	directory	false	string		Directory outside of the web root where the file exists. Must be a full path.
	deleteFile	false	boolean	false	Pass in `true` to delete the file on the server after sending it.
	deliver	false	boolean	null

return type

any

set

Public Function set
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Use to configure a global setting or set a default for a function.
[section: Configuration]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

void

setFilterChain

Public Function setFilterChain
source: C:\home\pptinc.org\wwwroot\wheels\controller\filters.cfm
Use this function if you need a more low level way of setting the entire filter chain for a controller.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	chain	true	array	null	An array of structs, each of which represent an `argumentCollection` that get passed to the `filters` function. This should represent the entire filter chain that you want to use for this controller.

return type

void

setPagination

Public Function setPagination
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Allows you to set a pagination handle for a custom query so you can perform pagination on it in your view with `paginationLinks`.
[section: Controller]
[category: Pagination Functions]

arguments

label	name	required	type	default	hint
	totalRecords	true	numeric	null	Total count of records that should be represented by the paginated links.
	currentPage	false	numeric	1	Page number that should be represented by the data being fetched and the paginated links.
	perPage	false	numeric	25	Number of records that should be represented on each page of data.
	handle	false	string	query	Name of handle to reference in `paginationLinks`.

return type

void

setResponse

Public Function setResponse
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Sets content that CFWheels will send to the client in response to the request.
[section: Controller]
[category: Rendering Functions]

arguments

label	name	required	type	default	hint
	content	true	string	null	The content to send to the client.

return type

void

setVerificationChain

Public Function setVerificationChain
source: C:\home\pptinc.org\wwwroot\wheels\controller\verifies.cfm
Use this function if you need a more low level way of setting the entire verification chain for a controller.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	chain	true	array	null	An array of structs, each of which represent an `argumentCollection` that get passed to the `verifies` function. This should represent the entire verification chain that you want to use for this controller.

return type

void

simpleFormat

Public Function simpleFormat
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Returns formatted text using HTML break tags (`<br>`) and HTML paragraph elements (`<p></p>`) based on the newline characters and carriage returns in the `text` that is passed in.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to format.
	wrap	false	boolean	null	Set to `true` to wrap the result in a paragraph HTML element.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

singularize

Public Function singularize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns the singular form of the passed in word.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null

return type

string

soon

Public Function soon
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

any

startFormTag

Public Function startFormTag
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Builds and returns a string containing the opening `form` tag.
The form's action will be built according to the same rules as `URLFor`.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: General Form Functions]

arguments

label	name	required	type	default	hint
	method	false	string	null	The type of `method` to use in the `form` tag (`delete`, `get`, `patch`, `post`, and `put` are the options).
	multipart	false	boolean	null	Set to `true` if the form should be able to upload files.
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: wheels=cool&x=y). Please note that CFWheels uses the & and = characters to split the parameters and encode them properly for you. However, if you need to pass in & or = as part of the value, then you need to encode them (and only them), example: a=cats%26dogs%3Dtrouble!&b=1.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If true, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

stripLinks

Public Function stripLinks
source: C:\home\pptinc.org\wwwroot\wheels\view\sanitize.cfm
Removes all links from an HTML string, leaving just the link text.
[section: View Helpers]
[category: Sanitization Functions]

arguments

label	name	required	type	default	hint
	html	true	string	null	The HTML to remove links from.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

stripTags

Public Function stripTags
source: C:\home\pptinc.org\wwwroot\wheels\view\sanitize.cfm
Removes all HTML tags from a string.
[section: View Helpers]
[category: Sanitization Functions]

arguments

label	name	required	type	default	hint
	html	true	string	null	The HTML to remove tag markup from.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

styleSheetLinkTag

Public Function styleSheetLinkTag
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Returns a `link` tag for a stylesheet (or several) based on the supplied arguments.
[section: View Helpers]
[category: Asset Functions]

arguments

label	name	required	type	default	hint
	sources	false	string		The name of one or many CSS files in the stylesheets folder, minus the `.css` extension. Pass a full URL to generate a tag for an external style sheet. Can also be called with the `source` argument.
	type	false	string	null	The `type` attribute for the `link` tag.
	media	false	string	null	The `media` attribute for the `link` tag.
	rel	false	string	null	The `rel` attribute for the relation between the tag and href.
	head	false	boolean	null	Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior (which is to place the output where the function is called from).
	delim	false	string	,	The delimiter to use for the list of CSS files.
	encode	false	boolean	null	Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to `true` to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to `attributes` to only encode attribute values and not tag content.

return type

string

submitTag

Public Function submitTag
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Builds and returns a string containing a submit button form control.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: General Form Functions]

arguments

label	name	required	type	default	hint
	value	false	string	null	Message to display in the button form control.
	image	false	string	null	File name of the image file to use in the button form control.
	prepend	false	string	null	[see:textField]
	append	false	string	null	[see:textField]
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textArea

Public Function textArea
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a text area field form control based on the supplied objectName and property.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textAreaTag

Public Function textAreaTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a text area form control based on the supplied name.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	content	false	string		Content to display in textarea on page load.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textField

Public Function textField
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Builds and returns a string containing a text field form control based on the supplied objectName and property.
Note: Pass any additional arguments like class, rel, and id, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	true	any	null	The variable name of the object to build the form control for.
	property	true	string	null	The name of the property to use in the form control.
	association	false	string	null	The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and CFWheels will figure it out.
	position	false	string	null	The position used when referencing a hasMany relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and CFWheels will figure it out.
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The class name of the HTML tag that wraps the form control when there are errors.
	type	false	string	text	Input type attribute. Common examples in HTML5 and later are text (default), email, tel, and url.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textFieldTag

Public Function textFieldTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsplain.cfm
Builds and returns a string containing a text field form control based on the supplied name.
Note: Pass any additional arguments like `class`, `rel`, and `id`, and the generated tag will also include those values as HTML attributes.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	Name to populate in tag's name attribute.
	value	false	string		Value to populate in tag's value attribute.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	type	false	string	text	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

timeAgoInWords

Public Function timeAgoInWords
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns a string describing the approximate time difference between the date passed in and the current date.
[section: Global Helpers]
[category: Date Functions]

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	toTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare to.

return type

any

timeSelect

Public Function timeSelect
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateobject.cfm
Builds and returns a string containing three `select` form controls for hour, minute, and second based on the supplied objectName and property.
[section: View Helpers]
[category: Form Object Functions]

arguments

label	name	required	type	default	hint
	objectName	false	any		[see:textField].
	property	false	string		[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	order	false	string	null	Use to change the order of or exclude time select tags.
	separator	false	string	null	Use to change the character that is displayed between the time select tags.
	minuteStep	false	numeric	null	Pass in 10 to only show minute 10, 20, 30, etc.
	secondStep	false	numeric	null	Pass in 10 to only show seconds 10, 20, 30, etc.
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	twelveHour	false	boolean	null	whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

timeSelectTags

Public Function timeSelectTags
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing three `select` form controls for hour, minute, and second based on name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		[see:selectTag].
	order	false	string	null	[see:timeSelect].
	separator	false	string	null	[see:timeSelect].
	minuteStep	false	numeric	null	[see:timeSelect].
	secondStep	false	numeric	null	[see:timeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	twelveHour	false	boolean	null	[see:timeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

timeUntilInWords

Public Function timeUntilInWords
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Returns a string describing the approximate time difference between the current date and the date passed in.
[section: Global Helpers]
[category: Date Functions]

arguments

label	name	required	type	default	hint
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	fromTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare from.

return type

string

titleize

Public Function titleize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Capitalizes all words in the text to create a nicer looking title.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null	The text to turn into a title.

return type

string

truncate

Public Function truncate
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Truncates text to the specified length and replaces the last characters with the specified truncate string (which defaults to "...").
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Length to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

URLFor

Public Function URLFor
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Creates an internal URL based on supplied arguments.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: `wheels=cool&x=y`). Please note that CFWheels uses the `&` and `=` characters to split the parameters and encode them properly for you. However, if you need to pass in `&` or `=` as part of the value, then you need to encode them (and only them), example: `a=cats%26dogs%3Dtrouble!&b=1`.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If `true`, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	encode	false	boolean	null	Encode URL parameters using `EncodeForURL()`. Please note that this does not make the string safe for placement in HTML attributes, for that you need to wrap the result in `EncodeForHtmlAttribute()` or use `linkTo()`, `startFormTag()` etc instead.
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

usesLayout

Public Function usesLayout
source: C:\home\pptinc.org\wwwroot\wheels\controller\layouts.cfm
Used within a controller's `config()` function to specify controller- or action-specific layouts.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	template	true	string	null	Name of the layout template or function name you want to use.
	ajax	false	string		Name of the layout template you want to use for AJAX requests.
	except	false	string	null	List of actions that should not get the layout.
	only	false	string	null	List of actions that should only get the layout.
	useDefault	false	boolean	true	When specifying conditions or a function, pass in `true` to use the default `layout.cfm` if none of the conditions are met.

return type

void

verificationChain

Public Function verificationChain
source: C:\home\pptinc.org\wwwroot\wheels\controller\verifies.cfm
Returns an array of all the verifications set on this controller in the order in which they will be executed.
[section: Controller]
[category: Configuration Functions]

arguments

label

name

required

type

default

hint

return type

array

verifies

Public Function verifies
source: C:\home\pptinc.org\wwwroot\wheels\controller\verifies.cfm
Instructs CFWheels to verify that some specific criterias are met before running an action.
Note that all undeclared arguments will be passed to `redirectTo()` call if a `handler` is not specified.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	only	false	string		List of action names to limit this verification to.
	except	false	string		List of action names to exclude this verification from.
	post	false	any		Set to true to verify that this is a `POST` request.
	get	false	any		Set to true to verify that this is a `GET` request.
	ajax	false	any		Set to true to verify that this is an `AJAX` request.
	cookie	false	string		Verify that the passed in variable name exists in the cookie scope.
	session	false	string		Verify that the passed in variable name exists in the session scope.
	params	false	string		Verify that the passed in variable name exists in the params struct.
	handler	false	string	null	Pass in the name of a function that should handle failed verifications. The default is to just abort the request when a verification fails.
	cookieTypes	false	string		List of types to check each listed cookie value against (will be passed through to your CFML engine's `IsValid` function).
	sessionTypes	false	string		List of types to check each list session value against (will be passed through to your CFML engine's `IsValid` function).
	paramsTypes	false	string		List of types to check each params value against (will be passed through to your CFML engine's `IsValid` function).

return type

void

wordTruncate

Public Function wordTruncate
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Truncates text to the specified length of words and replaces the remaining characters with the specified truncate string (which defaults to "...").
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Number of words to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

yearSelectTag

Public Function yearSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Builds and returns a string containing a `select` form control for a range of years based on the supplied name.
[section: View Helpers]
[category: Form Tag Functions]

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The year that should be selected initially.
	startYear	false	numeric	null	[see:dateSelect].
	endYear	false	numeric	null	[see:dateSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

private

$checkMinimumVersion

Private Function $checkMinimumVersion
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm

arguments

label	name	required	type	default	hint
	engine	true	string	null
	version	true	string	null

return type

string

contactFormSubjects

Private Function contactFormSubjects
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

void

processContactForm

Private Function processContactForm
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

void

processJobsForm

Private Function processJobsForm
source: C:\home\pptinc.org\wwwroot\controllers\Pages.cfc

arguments

label

name

required

type

default

hint

return type

void

Services

Component (controllers.Services)
Only the functions and data members that are accessible from your location are displayed

Extends

Controller

this

public

$abortInvalidRequest

Public Function $abortInvalidRequest
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$abortIssued

Public Function $abortIssued
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$acceptableFormats

Public Function $acceptableFormats
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$addCachableAction

Public Function $addCachableAction
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Called from the caches function.

arguments

label	name	required	type	default	hint
	action	true	struct	null

return type

void

$addImageTagToCache

arguments

label

name

required

type

default

hint

return type

string

$addToCache

Public Function $addToCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	value	true	any	null
	time	false	numeric	60
	category	false	string	main

return type

void

$ampmSelectTag

Public Function $ampmSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	value	true	string	null
	$id	true	string	null
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

$appendQueryString

arguments

label

name

required

type

default

hint

return type

string

$appKey

Public Function $appKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$args

Public Function $args
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	name	true	string	null
	reserved	false	string
	combine	false	string
	required	false	string

return type

void

$argumentsForPartial

Public Function $argumentsForPartial
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$assetDomain

Public Function $assetDomain
source: C:\home\pptinc.org\wwwroot\wheels\view\assets.cfm
Internal function.

arguments

label	name	required	type	default	hint
	pathToAsset	true	string	null

return type

string

$autoLinkLoop

Public Function $autoLinkLoop
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Called from the autoLink function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	regex	true	string	null
	protocol	false	string

return type

string

$buildReleaseZip

Public Function $buildReleaseZip
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
NB: url rewriting files need to be removed from here.

arguments

label	name	required	type	default	hint
	version	false	string	2.5.0
	directory	false	string	C:\home\pptinc.org\wwwroot\

return type

string

$cachableActions

Public Function $cachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Called when processing a request, and from other functions in this file, to get all cachable actions.

arguments

label

name

required

type

default

hint

return type

array

$cache

Public Function $cache
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$cacheCount

Public Function $cacheCount
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

numeric

$cachedControllerClassExists

Public Function $cachedControllerClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cachedModelClassExists

Public Function $cachedModelClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cacheSettingsForAction

Public Function $cacheSettingsForAction
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Get cache info, only called from the test suite

arguments

label	name	required	type	default	hint
	action	true	string	null

return type

any

$callAction

Public Function $callAction
source: C:\home\pptinc.org\wwwroot\wheels\controller\processing.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	true	string	null

return type

void

$callActionAndAddToCache

Public Function $callActionAndAddToCache
source: C:\home\pptinc.org\wwwroot\wheels\controller\processing.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	true	string	null
	time	true	numeric	null
	key	true	string	null
	category	true	string	null

return type

string

$canonicalize

Public Function $canonicalize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Call CFML's canonicalize() function but set to blank string if the result is null (happens on Lucee 5).

arguments

label	name	required	type	default	hint
	input	true	string	null

return type

string

$cgiScope

Public Function $cgiScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
This copies all the variables CFWheels needs from the CGI scope to the request scope.

arguments

label	name	required	type	default	hint
	keys	false	string	request_method,http_x_requested_with,http_referer,server_name,path_info,script_name,query_string,remote_addr,server_port,server_port_secure,server_protocol,http_host,http_accept,content_type,http_x_rewrite_url,http_x_original_url,request_uri,redirect_url,http_x_forwarded_for,http_x_forwarded_proto
	scope	false	struct

return type

struct

$checkVerificationsVars

Public Function $checkVerificationsVars
source: C:\home\pptinc.org\wwwroot\wheels\controller\verifies.cfm
Internal function.

arguments

label	name	required	type	default	hint
	scope	true	struct	null
	vars	true	string	null
	types	true	string	null

return type

boolean

$cleanInlist

Public Function $cleanInlist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	where	true	string	null

return type

any

$clearCachableActions

Public Function $clearCachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Delete all cache info, only called from the test suite.

arguments

label

name

required

type

default

hint

return type

void

$clearCache

Public Function $clearCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

void

$clearControllerInitializationCache

Public Function $clearControllerInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$clearModelInitializationCache

Public Function $clearModelInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$combineArguments

Public Function $combineArguments
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	combine	true	string	null
	required	true	boolean	false
	extendedInfo	false	string

return type

void

$constructParams

Public Function $constructParams
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	true	string	null
	encode	false	boolean	true
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

$content

Public Function $content
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$contentType

arguments

label

name

required

type

default

hint

return type

string

$convertToString

Public Function $convertToString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	any	null
	type	false	string

return type

string

$createControllerClass

Public Function $createControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	controllerPaths	false	string
	type	false	string	controller

return type

any

$createControllerObject

arguments

label	name	required	type	default	hint
	params	true	struct	null

return type

any

$createLabel

Public Function $createLabel
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	string	null
	prependToLabel	true	string	null
	encode	false	any	false

return type

string

$createModelClass

Public Function $createModelClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	modelPaths	false	string	models
	type	false	string	model

return type

any

$createObjectFromRoot

Public Function $createObjectFromRoot
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null
	fileName	true	string	null
	method	true	string	null

return type

any

$csrfCookieAttributeCollection

Public Function $csrfCookieAttributeCollection
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	string	null

return type

struct

$dateForSelectTags

Public Function $dateForSelectTags
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdateplain.cfm
Internal function.

arguments

label	name	required	type	default	hint
	part	true	string	null
	value	true	numeric	null
	$now	true	date	null

return type

datetime

$dateOrTimeSelect

Public Function $dateOrTimeSelect
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	$functionName	true	string	null
	combine	false	boolean	true
	twelveHour	false	boolean	false

return type

string

$daySelectTag

Public Function $daySelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$dbinfo

Public Function $dbinfo
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$debugPoint

Public Function $debugPoint
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

void

$directory

Public Function $directory
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$dollarify

Public Function $dollarify
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	input	true	struct	null
	on	true	string	null

return type

struct

$doubleCheckedLock

Public Function $doubleCheckedLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	condition	true	string	null
	execute	true	string	null
	conditionArgs	false	struct
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$element

Public Function $element
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Creates an HTML element.

arguments

label	name	required	type	default	hint
	name	true	string	null
	attributes	false	struct
	content	false	string
	skip	false	string
	skipStartingWith	false	string
	encode	false	any	false
	encodeExcept	false	string

return type

string

$file

Public Function $file
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$fileExistsNoCase

Public Function $fileExistsNoCase
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	absolutePath	true	string	null

return type

any

$findRoute

Public Function $findRoute
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$flagRequestAsProtected

Public Function $flagRequestAsProtected
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$flashClear

Public Function $flashClear
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$formAfterElement

Public Function $formAfterElement
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	string	null
	labelPlacement	true	string	null
	prepend	true	string	null
	append	true	string	null
	prependToLabel	true	string	null
	appendToLabel	true	string	null
	errorElement	true	string	null
	encode	false	any	false

return type

string

$formatTemplatePathExists

Public Function $formatTemplatePathExists
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$name	true	string	null

return type

boolean

$formBeforeElement

Public Function $formBeforeElement
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	any	null
	labelPlacement	true	string	null
	prepend	true	string	null
	append	true	string	null
	prependToLabel	true	string	null
	appendToLabel	true	string	null
	errorElement	true	string	null
	errorClass	true	string	null
	encode	false	any	false

return type

string

$formHasError

Public Function $formHasError
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

boolean

$formValue

Public Function $formValue
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

string

$fullCgiDomainString

Public Function $fullCgiDomainString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get full domain string from cgi scope: includes protocol and port
e.g https://www.cfwheels.com:443

arguments

label	name	required	type	default	hint
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

string

$fullDomainString

arguments

label	name	required	type	default	hint
	domain	true	string	null	The string to look at

return type

string

$generateAuthenticityToken

Public Function $generateAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$generateCookieAuthenticityToken

Public Function $generateCookieAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$generateIncludeTemplatePath

Public Function $generateIncludeTemplatePath
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$name	true	any	null
	$type	true	any	null
	$controllerName	false	string
	$baseTemplatePath	false	string
	$prependWithUnderscore	false	boolean	true

return type

string

$generateRenderWithTemplatePath

Public Function $generateRenderWithTemplatePath
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	controller	true	string	null
	action	true	string	null
	template	true	string	null
	contentType	true	string	null

return type

string

$get

Public Function $get
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from get().

arguments

label	name	required	type	default	hint
	name	true	string	null
	functionName	false	string

return type

any

$getControllerClassData

Public Function $getControllerClassData
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
Return the controller data that is on the class level.

arguments

label

name

required

type

default

hint

return type

struct

$getFieldLabel

Public Function $getFieldLabel
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	label	true	string	null

return type

string

$getFlashAppend

Public Function $getFlashAppend
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$getFlashStorage

Public Function $getFlashStorage
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$getFromCache

Public Function $getFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

any

$getIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

$getObject

Public Function $getObject
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectname	true	string	null

return type

any

$getRequestTimeout

Public Function $getRequestTimeout
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Returns the request timeout value in seconds

arguments

label

name

required

type

default

hint

return type

numeric

$getStatusCodes

Public Function $getStatusCodes
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Returns a list of HTTP status codes and their response names

arguments

label

name

required

type

default

hint

return type

struct

$hasCachableActions

Public Function $hasCachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Called when processing a request to see if any actions are cachable.

arguments

label

name

required

type

default

hint

return type

boolean

$hashedKey

Public Function $hashedKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Creates a unique string based on any arguments passed in (used as a key for caching mostly).

arguments

label

name

required

type

default

hint

return type

string

$hasManyFormValue

Public Function $hasManyFormValue
source: C:\home\pptinc.org\wwwroot\wheels\view\formsassociation.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	string	null
	association	true	string	null
	property	true	string	null
	keys	true	string	null

return type

string

$header

Public Function $header
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$hourSelectTag

Public Function $hourSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$htmlhead

Public Function $htmlhead
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$image

Public Function $image
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

struct

$imageTag

arguments

label

name

required

type

default

hint

return type

string

$include

Public Function $include
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndOutput

Public Function $includeAndOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndReturnOutput

Public Function $includeAndReturnOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	$template	true	string	null

return type

string

$includeFile

Public Function $includeFile
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$name	true	any	null
	$template	true	any	null
	$type	true	any	null

return type

string

$includeOrRenderPartial

Public Function $includeOrRenderPartial
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$initControllerClass

Public Function $initControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
Initialize the controller class level object and return it.

arguments

label	name	required	type	default	hint
	name	false	string

return type

any

$initControllerObject

Public Function $initControllerObject
source: C:\home\pptinc.org\wwwroot\wheels\controller\initialization.cfm
Initialize the controller instance level object and return it.

arguments

label	name	required	type	default	hint
	name	true	string	null
	params	true	struct	null

return type

any

$initializeRequestScope

Public Function $initializeRequestScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$innerArgs

Public Function $innerArgs
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	args	true	struct	null

return type

struct

$invoke

Public Function $invoke
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$isAnyAuthenticityTokenValid

Public Function $isAnyAuthenticityTokenValid
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$isCookieAuthenticityTokenValid

Public Function $isCookieAuthenticityTokenValid
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$isRequestProtectedFromForgery

Public Function $isRequestProtectedFromForgery
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$isVerifiedRequest

Public Function $isVerifiedRequest
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$listClean

Public Function $listClean
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Removes whitespace between list elements.
Optional argument to return the list as an array.

arguments

label	name	required	type	default	hint
	list	true	string	null
	delim	false	string	,
	returnAs	false	string	string

return type

any

$listToStruct

Public Function $listToStruct
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Converts a comma delimted list to a struct

arguments

label	name	required	type	default	hint
	list	true	string	null
	value	false	string	1

return type

struct

$loadPlugins

Public Function $loadPlugins
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$loadRoutes

Public Function $loadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$location

Public Function $location
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	delay	false	boolean	false

return type

void

$lockedLoadRoutes

Public Function $lockedLoadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$mail

Public Function $mail
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$maxLength

Public Function $maxLength
source: C:\home\pptinc.org\wwwroot\wheels\view\forms.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

any

$minuteSelectTag

Public Function $minuteSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	minuteStep	true	numeric	null

return type

string

$monthSelectTag

Public Function $monthSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	monthDisplay	true	string	null
	monthNames	true	string	null
	monthAbbreviations	true	string	null

return type

string

$namedArguments

arguments

label	name	required	type	default	hint
	$defined	true	string	null

return type

struct

$objectFileName

Public Function $objectFileName
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	objectPath	true	string	null
	type	true	string	null

return type

string

$objectName

Public Function $objectName
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	association	false	string
	position	false	string

return type

any

$option

Public Function $option
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Creates an HTML "option" element.

arguments

label	name	required	type	default	hint
	objectValue	true	string	null
	optionValue	true	string	null
	optionText	true	string	null
	encode	true	any	null

return type

string

$optionsForSelect

Public Function $optionsForSelect
source: C:\home\pptinc.org\wwwroot\wheels\view\formsobject.cfm
Creates multiple HTML "option" elements.

arguments

label	name	required	type	default	hint
	options	true	any	null
	valueField	true	string	null
	textField	true	string	null
	encode	true	any	null

return type

string

$performedRedirect

Public Function $performedRedirect
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$performedRender

Public Function $performedRender
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$performedRenderOrRedirect

Public Function $performedRenderOrRedirect
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$prependUrl

Public Function $prependUrl
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null

return type

string

$query

Public Function $query
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	sql	true	string	null

return type

any

$readAuthenticityTokenFromCookie

Public Function $readAuthenticityTokenFromCookie
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$readFlash

Public Function $readFlash
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$reCacheRequired

Public Function $reCacheRequired
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$removeFromCache

Public Function $removeFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

void

$renderLayout

Public Function $renderLayout
source: C:\home\pptinc.org\wwwroot\wheels\controller\layouts.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$content	true	string	null
	$layout	true	any	null

return type

string

$renderPartial

Public Function $renderPartial
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$renderPartialAndAddToCache

Public Function $renderPartialAndAddToCache
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$renderView

Public Function $renderView
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$renderViewAndAddToCache

Public Function $renderViewAndAddToCache
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$requestContentType

Public Function $requestContentType
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	false	struct
	httpAccept	false	string	/

return type

string

$restoreTestRunnerApplicationScope

Public Function $restoreTestRunnerApplicationScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Restore the application scope modified by the test runner

arguments

label

name

required

type

default

hint

return type

void

$returnStatusCode

Public Function $returnStatusCode
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Returns a response code from the status code list.

arguments

label	name	required	type	default	hint
	status	false	any	200

return type

string

$returnStatusText

Public Function $returnStatusText
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Returns a response text for any status code.

arguments

label	name	required	type	default	hint
	status	false	numeric	200

return type

string

$routeVariables

Public Function $routeVariables
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$runCsrfProtection

Public Function $runCsrfProtection
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	false	string	null

return type

any

$runFilters

Public Function $runFilters
source: C:\home\pptinc.org\wwwroot\wheels\controller\filters.cfm
Called twice when processing a request, first for "before" filters and then for "after" filters.

arguments

label	name	required	type	default	hint
	type	true	string	null
	action	true	string	null

return type

void

$runVerifications

Public Function $runVerifications
source: C:\home\pptinc.org\wwwroot\wheels\controller\verifies.cfm
Internal function.

arguments

label	name	required	type	default	hint
	action	true	string	null
	params	true	struct	null
	cgiScope	false	struct
	sessionScope	false	struct
	cookieScope	false	struct

return type

void

$secondSelectTag

Public Function $secondSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	secondStep	true	numeric	null

return type

any

$sentEmails

Public Function $sentEmails
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$sentFiles

Public Function $sentFiles
source: C:\home\pptinc.org\wwwroot\wheels\controller\rendering.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

boolean

$set

Public Function $set
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from set().

arguments

label

name

required

type

default

hint

return type

void

$setAuthenticityToken

Public Function $setAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$setCachableActions

Public Function $setCachableActions
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Set cache info, only called from the test suite.

arguments

label	name	required	type	default	hint
	actions	true	array	null

return type

void

$setControllerClassData

arguments

label

name

required

type

default

hint

return type

void

$setCORSHeaders

Public Function $setCORSHeaders
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Set CORS Headers: only triggered if application.wheels.allowCorsRequests = true

arguments

label	name	required	type	default	hint
	allowOrigin	false	string	*
	allowCredentials	false	string	false
	allowHeaders	false	string	Origin, Content-Type, X-Auth-Token, X-Requested-By, X-Requested-With
	allowMethods	false	string	GET, POST, PATCH, PUT, DELETE, OPTIONS
	allowMethodsByRoute	false	boolean	false
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm

return type

void

$setFlashAppend

Public Function $setFlashAppend
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label	name	required	type	default	hint
	append	true	boolean	null

return type

void

$setFlashStorage

Public Function $setFlashStorage
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label	name	required	type	default	hint
	storage	true	string	null

return type

void

$setNamedRoutePositions

Public Function $setNamedRoutePositions
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$setRequestStatusCode

arguments

label	name	required	type	default	hint
	status	true	string	null

return type

void

$simpleLock

Public Function $simpleLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	type	true	string	null
	execute	true	string	null
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$singularizeOrPluralize

Public Function $singularizeOrPluralize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	which	true	string	null
	count	false	numeric	-1
	returnCount	false	boolean	true

return type

string

$statusCode

Public Function $statusCode
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get the status code (e.g. 200, 404 etc) of the response we're about to send.

arguments

label

name

required

type

default

hint

return type

string

$storeAuthenticityToken

Public Function $storeAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$structKeysExist

Public Function $structKeysExist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Check to see if all keys in the list exist for the structure and have length.

arguments

label	name	required	type	default	hint
	struct	true	struct	null
	keys	false	string

return type

boolean

$swapArrayPositionsForIds

Public Function $swapArrayPositionsForIds
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null

return type

string

$tag

Public Function $tag
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	attributes	false	struct
	skip	false	string
	skipStartingWith	false	string
	encode	false	boolean	false
	encodeExcept	false	string

return type

string

$tagAttribute

Public Function $tagAttribute
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	value	true	string	null
	encode	true	boolean	null
	encodeExcept	true	string	null

return type

string

$tagId

Public Function $tagId
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null
	valueToAppend	false	string

return type

string

$tagName

Public Function $tagName
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Internal function.

arguments

label	name	required	type	default	hint
	objectName	true	any	null
	property	true	string	null

return type

string

$throwErrorOrShow404Page

arguments

label	name	required	type	default	hint
	type	true	string	null
	message	true	string	null
	extendedInfo	false	string

return type

void

$timeSpanForCache

Public Function $timeSpanForCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	cache	true	any	null
	defaultCacheTime	false	numeric	60
	cacheDatePart	false	string	n

return type

any

$timestamp

Public Function $timestamp
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	timeStampMode	false	string	utc

return type

string

$toXml

Public Function $toXml
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	data	true	any	null

return type

xml

$useLayout

Public Function $useLayout
source: C:\home\pptinc.org\wwwroot\wheels\controller\layouts.cfm
Internal function.

arguments

label	name	required	type	default	hint
	$action	true	string	null

return type

any

$verifyAuthenticityToken

Public Function $verifyAuthenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

any

$wddx

Public Function $wddx
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	input	true	any	null
	action	false	string	cfml2wddx
	useTimeZoneInfo	false	boolean	true

return type

any

$wildcardDomainMatch

Public Function $wildcardDomainMatch
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Wildcard domain match: domain satifies wildcard

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	origin	true	string	null	string to test against e.g bar.foo.com

return type

boolean

$wildcardDomainMatchCGI

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

boolean

$writeFlash

Public Function $writeFlash
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Internal function.

arguments

label	name	required	type	default	hint
	flash	false	struct

return type

any

$yearMonthHourMinuteSecondSelectTag

Public Function $yearMonthHourMinuteSecondSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	value	true	string	null
	includeBlank	true	any	null
	label	true	string	null
	labelPlacement	true	string	null
	prepend	true	string	null
	append	true	string	null
	prependToLabel	true	string	null
	appendToLabel	true	string	null
	errorElement	false	string
	errorClass	false	string
	$type	true	string	null
	$loopFrom	true	numeric	null
	$loopTo	true	numeric	null
	$id	true	string	null
	$step	true	numeric	null
	$optionNames	false	string
	twelveHour	false	boolean	false
	$now	false	date	{ts '2025-04-24 11:22:35'}
	encode	false	any	false

return type

string

$yearMonthHourMinuteSecondSelectTagContent

Public Function $yearMonthHourMinuteSecondSelectTagContent
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$yearSelectTag

Public Function $yearSelectTag
source: C:\home\pptinc.org\wwwroot\wheels\view\formsdate.cfm
Internal function.

arguments

label	name	required	type	default	hint
	startYear	true	numeric	null
	endYear	true	numeric	null

return type

string

$zip

Public Function $zip
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

addFormat

arguments

label	name	required	type	default	hint
	extension	true	string	null	File extension to add.
	mimeType	true	string	null	Matching MIME type to associate with the file extension.

return type

void

authenticityToken

Public Function authenticityToken
source: C:\home\pptinc.org\wwwroot\wheels\controller\csrf.cfm
Returns the raw CSRF authenticity token
[section: Controller]
[category: Miscellaneous Functions]

arguments

label

name

required

type

default

hint

return type

string

authenticityTokenField

arguments

label

name

required

type

default

hint

return type

string

autoLink

Public Function autoLink
source: C:\home\pptinc.org\wwwroot\wheels\view\links.cfm
Turns all URLs and email addresses into links.
[section: View Helpers]
[category: Link Functions]

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to create links in.
	link	false	string	null	Whether to link URLs, email addresses or both. Possible values are: `all` (default), `URLs` and `emailAddresses`.
	relative	false	boolean	true	Should we auto-link relative urls.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

buttonTag

arguments

label	name	required	type	default	hint
	content	false	string	null	Content to display inside the button.
	type	false	string	null	The type for the button: `button`, `reset`, or `submit`.
	value	false	string	null	The value of the button when submitted.
	image	false	string	null	File name of the image file to use in the button form control.
	prepend	false	string	null	[see:textField]
	append	false	string	null	[see:textField]
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

buttonTo

arguments

label	name	required	type	default	hint
	text	false	string	null	The text content of the button.
	image	false	string	null	If you want to use an image for the button pass in the link to it here (relative from the `images` folder).
	route	false	string		[see:URLFor].
	controller	false	string		[see:URLFor].
	action	false	string		[see:URLFor].
	key	false	any		[see:URLFor].
	params	false	string		[see:URLFor].
	anchor	false	string		[see:URLFor].
	method	false	string	null	[see:startFormTag].
	onlyPath	false	boolean	null	[see:URLFor].
	host	false	string	null	[see:URLFor].
	protocol	false	string	null	[see:URLFor].
	port	false	numeric	null	[see:URLFor].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

caches

Public Function caches
source: C:\home\pptinc.org\wwwroot\wheels\controller\caching.cfm
Tells CFWheels to cache one or more actions.
[section: Controller]
[category: Configuration Functions]

arguments

label	name	required	type	default	hint
	action	false	string		Action(s) to cache. This argument is also aliased as `actions`.
	time	false	numeric	null	Minutes to cache the action(s) for.
	static	false	boolean	null	Set to `true` to tell CFWheels that this is a static page and that it can skip running the controller filters (before and after filters set on actions). Please note that the `onSessionStart` and `onRequestStart` events still execute though.
	appendToKey	false	string		List of variables to be evaluated at runtime and included in the cache key so that content can be cached separately.

return type

void

capitalize

arguments

label	name	required	type	default	hint
	text	true	string	null

return type

string

checkBox

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	checkedValue	false	string	null
	uncheckedValue	false	string	null	The value of the check box when it's on the unchecked state.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

checkBoxTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	checked	false	boolean	false	Whether or not the check box should be checked by default.
	value	false	string	null	Value of check box in its checked state.
	uncheckedValue	false	string		The value of the check box when it's on the unchecked state.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

concrete

Public Function concrete
source: C:\home\pptinc.org\wwwroot\controllers\Services.cfc

arguments

label

name

required

type

default

hint

return type

any

config

Public Function config
source: C:\home\pptinc.org\wwwroot\controllers\Services.cfc

arguments

label

name

required

type

default

hint

return type

any

contentFor

arguments

label	name	required	type	default	hint
	position	false	any	last	The position in the section's stack where you want the content placed. Valid values are `first`, `last`, or the numeric position.
	overwrite	false	any	false	Whether or not to overwrite any of the content. Valid values are `false`, `true`, or `all`.

return type

void

contentForLayout

arguments

label

name

required

type

default

hint

return type

string

controller

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the controller to create.
	params	false	struct		The params struct (combination of form and URL variables).

return type

any

csrfMetaTags

arguments

label	name	required	type	default	hint
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

cycle

Public Function cycle
source: C:\home\pptinc.org\wwwroot\wheels\view\miscellaneous.cfm
Cycles through list values every time it is called.
[section: View Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	values	true	string	null	List of values to cycle through.
	name	false	string	default	Name to give the cycle. Useful when you use multiple cycles on a page.

return type

string

dateSelect

arguments

label	name	required	type	default	hint
	objectName	false	any		The variable name of the object to build the form control for.
	property	false	string		The name of the property to use in the form control.
	association	false	string	null	The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and CFWheels will figure it out.
	position	false	string	null	The position used when referencing a `hasMany` relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and CFWheels will figure it out.
	order	false	string	null	Use to change the order of or exclude date `select` tags.
	separator	false	string	null
	startYear	false	numeric	null	First year in `select` list.
	endYear	false	numeric	null	Last year in `select` list.
	monthDisplay	false	string	null	Pass in names, numbers, or abbreviations to control display.
	monthNames	false	string	null
	monthAbbreviations	false	string	null
	includeBlank	false	any	null	Whether to include a blank option in the `select` form control. Pass `true` to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using `aroundLeft` or `aroundRight`.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The `class` name of the HTML tag that wraps the form control when there are errors.
	combine	false	boolean	null	[see:dateTimeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

dateSelectTags

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		[see:selectTag].
	order	false	string	null	[see:dateSelect].
	separator	false	string	null	[see:dateSelect].
	startYear	false	numeric	null	[see:dateSelect].
	endYear	false	numeric	null	[see:dateSelect].
	monthDisplay	false	string	null	[see:dateSelect].
	monthNames	false	string	null	[see:dateSelect].
	monthAbbreviations	false	string	null	[see:dateSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

dateTimeSelect

arguments

label	name	required	type	default	hint
	objectName	true	string	null	The variable name of the object to build the form control for.
	property	true	string	null	The name of the property to use in the form control.
	association	false	string	null	The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and Wheels will figure it out.
	position	false	string	null	The position used when referencing a hasMany relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and Wheels will figure it out.
	dateOrder	false	string	null	Use to change the order of or exclude date select tags.
	dateSeparator	false	string	null
	startYear	false	numeric	null	Last year in select list.
	endYear	false	numeric	null
	monthDisplay	false	string	null	Pass in names, numbers, or abbreviations to control display.
	monthNames	false	string	null
	monthAbbreviations	false	string	null
	timeOrder	false	string	null	Use to change the order of or exclude time select tags.
	timeSeparator	false	string	null	Use to change the character that is displayed between the time select tags.
	minuteStep	false	numeric	null	Pass in 10 to only show minute 10, 20, 30, etc.
	secondStep	false	numeric	null	Pass in 10 to only show seconds 10, 20, 30, etc
	separator	false	string	null	Use to change the character that is displayed between the first and second set of select tags.
	includeBlank	false	any	null	Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The class name of the HTML tag that wraps the form control when there are errors.
	combine	false	boolean	null	Set to false to not combine the select parts into a single DateTime object.
	twelveHour	false	boolean	null	Whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

dateTimeSelectTags

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		[see:selectTag].
	dateOrder	false	string	null	[see:dateTimeSelect].
	dateSeparator	false	string	null	[see:dateTimeSelect].
	startYear	false	numeric	null	[see:dateSelect].
	endYear	false	numeric	null	[see:dateSelect].
	monthDisplay	false	string	null	[see:dateSelect].
	monthNames	false	string	null	[see:dateSelect].
	monthAbbreviations	false	string	null	[see:dateSelect].
	timeOrder	false	string	null	[see:dateTimeSelect].
	timeSeparator	false	string	null	[see:dateTimeSelect].
	minuteStep	false	numeric	null	[see:timeSelect].
	secondStep	false	numeric	null	[see:timeSelect].
	separator	false	string	null	[see:dateTimeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	twelveHour	false	boolean	null	[see:timeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

daySelectTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

deobfuscateParam

Public Function deobfuscateParam
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Deobfuscates a value.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	param	true	string	null	The value to deobfuscate.

return type

string

distanceOfTimeInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.

return type

string

Public Function e
source: C:\home\pptinc.org\wwwroot\views\helpers.cfm
Shortcut to encodeForHTML, because I'm lazy

arguments

label	name	required	type	default	hint
	string	false	string		The string to encode

return type

string

endFormTag

arguments

label	name	required	type	default	hint
	prepend	false	string	null	[see:textField]
	append	false	string	null	[see:textField],
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

errorMessageOn

arguments

label	name	required	type	default	hint
	objectName	true	string	null	The variable name of the object to display the error message for.
	property	true	string	null	The name of the property to display the error message for.
	prependText	false	string	null	String to prepend to the error message.
	appendText	false	string	null	String to append to the error message.
	wrapperElement	false	string	null	HTML element to wrap the error message in.
	class	false	string	null	CSS `class` to set on the wrapper element.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

errorMessagesFor

arguments

label	name	required	type	default	hint
	objectName	true	string	null	The variable name of the object to display error messages for.
	class	false	string	null	CSS `class` to set on the `ul` element.
	showDuplicates	false	boolean	null	Whether or not to show duplicate error messages.
	encode	false	boolean	null	[see:styleSheetLinkTag].
	includeAssociations	false	boolean	false

return type

string

excerpt

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to extract an excerpt from.
	phrase	true	string	null	The phrase to extract.
	radius	false	numeric	null	Number of characters to extract surrounding the phrase.
	excerptString	false	string	null	String to replace first and / or last characters with.

return type

string

fileField

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

fileFieldTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

filterChain

arguments

label	name	required	type	default	hint
	type	false	string	all	Use this argument to return only before or after filters.

return type

array

filters

arguments

label	name	required	type	default	hint
	through	true	string	null	Function(s) to execute before or after the action(s).
	type	false	string	before	Whether to run the function(s) before or after the action(s).
	only	false	string		Pass in a list of action names (or one action name) to tell CFWheels that the filter function(s) should only be run on these actions.
	except	false	string		Pass in a list of action names (or one action name) to tell CFWheels that the filter function(s) should be run on all actions except the specified ones.
	placement	false	string	append	Pass in `prepend` to prepend the function(s) to the filter chain instead of appending.

return type

void

flash

arguments

label	name	required	type	default	hint
	key	false	string	null	The key to get the value for.

return type

any

flashClear

Public Function flashClear
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Deletes everything from the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

void

flashCount

Public Function flashCount
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Returns how many keys exist in the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

numeric

flashDelete

arguments

label	name	required	type	default	hint
	key	true	string	null	The key to delete

return type

any

flashInsert

Public Function flashInsert
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Inserts a new key / value into the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

void

flashIsEmpty

Public Function flashIsEmpty
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Returns whether or not the Flash is empty.
[section: Controller]
[category: Flash Functions]

arguments

label

name

required

type

default

hint

return type

boolean

flashKeep

arguments

label	name	required	type	default	hint
	key	false	string

return type

void

flashKeyExists

Public Function flashKeyExists
source: C:\home\pptinc.org\wwwroot\wheels\controller\flash.cfm
Checks if a specific key exists in the Flash.
[section: Controller]
[category: Flash Functions]

arguments

label	name	required	type	default	hint
	key	true	string	null	The key to check.

return type

boolean

flashMessages

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

foundation

Public Function foundation
source: C:\home\pptinc.org\wwwroot\controllers\Services.cfc

arguments

label

name

required

type

default

hint

return type

any

get

arguments

label	name	required	type	default	hint
	name	true	string	null	Variable name to get setting for.
	functionName	false	string		Function name to get setting for.

return type

any

getEmails

arguments

label

name

required

type

default

hint

return type

array

getFiles

arguments

label

name

required

type

default

hint

return type

array

getRedirect

arguments

label

name

required

type

default

hint

return type

struct

hasManyCheckBox

arguments

label	name	required	type	default	hint
	objectName	true	string	null	Name of the variable containing the parent object to represent with this form field.
	association	true	string	null	Name of the association set in the parent object to represent with this form field.
	keys	true	string	null	Primary keys associated with this form field. Note that these keys should be listed in the order that they appear in the database table.
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using `aroundLeft` or `aroundRight`.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The `class` name of the HTML tag that wraps the form control when there are errors.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

hasManyRadioButton

arguments

label	name	required	type	default	hint
	objectName	true	string	null	Name of the variable containing the parent object to represent with this form field.
	association	true	string	null	Name of the association set in the parent object to represent with this form field.
	property	true	string	null	Name of the property in the child object to represent with this form field.
	keys	true	string	null	Primary keys associated with this form field. Note that these keys should be listed in the order that they appear in the database table.
	tagValue	true	string	null	The value of the radio button when selected.
	checkIfBlank	false	boolean	false	Whether or not to check this form field as a default if there is a blank value set for the property.
	label	false	string	null	The label text to use in the form control.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

hiddenField

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

hiddenFieldTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	value	false	string		[see:textFieldTag].
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

highlight

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to search in.
	phrase	false	string	null	Phrase (or list of phrases) to highlight. This argument is also aliased as `phrases`.
	delimiter	false	string	null	Delimiter to use when passing in multiple phrases.
	tag	false	string	null	HTML tag to use to wrap the highlighted phrase(s).
	class	false	string	null	Class to use in the tags wrapping highlighted phrase(s).
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

hourSelectTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	twelveHour	false	boolean	null	[see:timeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

humanize

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to humanize.
	except	false	string		A list of strings (space separated) to replace within the output.

return type

string

hyphenize

arguments

label	name	required	type	default	hint
	string	true	string	null	The string to hyphenize.

return type

string

imageTag

arguments

label	name	required	type	default	hint
	source	true	string	null	The file name of the image if it's available in the local file system (i.e. ColdFusion will be able to access it). Provide the full URL if the image is on a remote server.
	onlyPath	false	boolean	null
	host	false	string	null
	protocol	false	string	null
	port	false	numeric	null
	encode	false	boolean	null	[see:styleSheetLinkTag].
	required	false	boolean	true

return type

string

includeContent

arguments

label	name	required	type	default	hint
	name	false	string	body	Name of layout section to return content for.
	defaultValue	false	string		What to display as a default if the section is not defined.

return type

string

includedInObject

arguments

label	name	required	type	default	hint
	objectName	true	string	null	Name of the variable containing the parent object to represent with this form field.
	association	true	string	null	Name of the association set in the parent object to represent with this form field.
	keys	true	string	null	Primary keys associated with this form field. Note that these keys should be listed in the order that they appear in the database table.

return type

boolean

includeLayout

arguments

label	name	required	type	default	hint
	name	false	string	layout	Name of the layout file to include.

return type

string

includePartial

arguments

label	name	required	type	default	hint
	partial	true	any	null	The name of the partial file to be used. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension. If you want to have CFWheels display the partial for a single model object, array of model objects, or a query, pass a variable containing that data into this argument.
	group	false	string		If passing a query result set for the partial argument, use this to specify the field to group the query by. A new query will be passed into the partial template for you to iterate over.
	cache	false	any		Number of minutes to cache the content for.
	layout	false	string	null	The layout to wrap the content in. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.
	spacer	false	string	null	HTML or string to place between partials when called using a query.
	dataFunction	false	any	null	Name of controller function to load data from.
	$prependWithUnderscore	false	boolean	true

return type

string

includeReCaptchaJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

insertReCaptchaDiv

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

isAjax

arguments

label

name

required

type

default

hint

return type

boolean

isDelete

arguments

label

name

required

type

default

hint

return type

boolean

isGet

arguments

label

name

required

type

default

hint

return type

boolean

isHead

arguments

label

name

required

type

default

hint

return type

boolean

isOptions

arguments

label

name

required

type

default

hint

return type

boolean

isPatch

arguments

label

name

required

type

default

hint

return type

boolean

isPost

arguments

label

name

required

type

default

hint

return type

boolean

isPut

arguments

label

name

required

type

default

hint

return type

boolean

isSecure

arguments

label

name

required

type

default

hint

return type

boolean

isValidReCaptcha

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

javaScriptIncludeTag

arguments

label	name	required	type	default	hint
	sources	false	string		The name of one or many JavaScript files in the `javascripts` folder, minus the `.js` extension. Pass a full URL to access an external JavaScript file. Can also be called with the `source` argument.
	type	false	string	null	The `type` attribute for the `script` tag.
	head	false	boolean	null	Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior (which is to place the output where the function is called from).
	delim	false	string	,	The delimiter to use for the list of JavaScript files.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

linkTo

arguments

label	name	required	type	default	hint
	text	false	string	null	The text content of the link.
	route	false	string		Name of a route that you have configured in config/routes.cfm.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: wheels=cool&x=y). Please note that CFWheels uses the & and = characters to split the parameters and encode them properly for you. However, if you need to pass in & or = as part of the value, then you need to encode them (and only them), example: a=cats%26dogs%3Dtrouble!&b=1.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If true, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	href	false	string	null	Pass a link to an external site here if you want to bypass the CFWheels routing system altogether and link to an external URL.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

mailTo

arguments

label	name	required	type	default	hint
	emailAddress	true	string	null	The email address to link to.
	name	false	string		A string to use as the link text ("Joe" or "Support Department", for example).
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

mapper

arguments

label	name	required	type	default	hint
	restful	false	boolean	true	Whether to turn on RESTful routing or not. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	methods	false	boolean		If not RESTful, then specify allowed routes. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	mapFormat	false	boolean	true	This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc. Set to false to disable automatic .[format] generation for resource based routes

return type

struct

mimeTypes

arguments

label	name	required	type	default	hint
	extension	true	string	null	The extension to get the MIME type for.
	fallback	false	string	application/octet-stream	The fallback MIME type to return.

return type

string

minuteSelectTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	minuteStep	false	numeric	null	[see:timeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

model

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the model to get a reference to.

return type

any

monthSelectTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The month that should be selected initially.
	monthDisplay	false	string	null	[see:dateSelect].
	monthNames	false	string	null	[see:dateSelect].
	monthAbbreviations	false	string	null	[see:dateSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	around [see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

obfuscateParam

arguments

label	name	required	type	default	hint
	param	true	any	null	The value to obfuscate.

return type

string

onlyProvides

arguments

label	name	required	type	default	hint
	formats	false	string		[see:provides].
	action	false	string		Name of action, defaults to current.

return type

void

pagination

arguments

label	name	required	type	default	hint
	handle	false	string	query	The handle given to the query to return pagination information for.

return type

struct

paginationLinks

arguments

label	name	required	type	default	hint
	windowSize	false	numeric	null	The number of page links to show around the current page.
	alwaysShowAnchors	false	boolean	null	Whether or not links to the first and last page should always be displayed.
	anchorDivider	false	string	null	String to place next to the anchors on either side of the list.
	linkToCurrentPage	false	boolean	null	Whether or not the current page should be linked to.
	prepend	false	string	null	String or HTML to be prepended before result.
	append	false	string	null	String or HTML to be appended after result.
	prependToPage	false	string	null	String or HTML to be prepended before each page number.
	addActiveClassToPrependedParent	false	boolean	null
	prependOnFirst	false	boolean	null	Whether or not to prepend the prependToPage string on the first page in the list.
	prependOnAnchor	false	boolean	null	Whether or not to prepend the prependToPage string on the anchors.
	appendToPage	false	string	null	String or HTML to be appended after each page number.
	appendOnLast	false	boolean	null	Whether or not to append the appendToPage string on the last page in the list.
	appendOnAnchor	false	boolean	null	Whether or not to append the appendToPage string on the anchors.
	classForCurrent	false	string	null	Class name for the current page number (if linkToCurrentPage is true, the class name will go on the a element. If not, a span element will be used).
	handle	false	string	query	The handle given to the query that the pagination links should be displayed for.
	name	false	string	null	The name of the param that holds the current page number.
	showSinglePage	false	boolean	null	Will show a single page when set to true. (The default behavior is to return an empty string when there is only one page in the pagination).
	pageNumberAsParam	false	boolean	null	Decides whether to link the page number as a param or as part of a route. (The default behavior is true).
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

passwordField

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

passwordFieldTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	value	false	string		[see:textFieldTag].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

piers

Public Function piers
source: C:\home\pptinc.org\wwwroot\controllers\Services.cfc

arguments

label

name

required

type

default

hint

return type

any

pluginNames

arguments

label

name

required

type

default

hint

return type

string

pluralize

arguments

label	name	required	type	default	hint
	word	true	string	null	The word to pluralize.
	count	false	numeric	-1	Pluralization will occur when this value is not 1.
	returnCount	false	boolean	true	Will return count prepended to the pluralization when true and count is not -1.

return type

string

postTension

Public Function postTension
source: C:\home\pptinc.org\wwwroot\controllers\Services.cfc

arguments

label

name

required

type

default

hint

return type

any

processAction

arguments

label	name	required	type	default	hint
	includeFilters	false	string	true	Set to `before` to only execute "before" filters, `after` to only execute "after" filters or `false` to skip all filters. This argument is generally inherited from the `processRequest` function during unit test execution.

return type

boolean

processRequest

arguments

label	name	required	type	default	hint
	params	true	struct	null	The params struct to use in the request (make sure that at least `controller` and `action` are set).
	method	false	string	null	The HTTP method to use in the request (`get`, `post` etc).
	returnAs	false	string	null	Pass in `struct` to return all information about the request instead of just the final output (`body`).
	rollback	false	string	null	Pass in `true` to roll back all database transactions made during the request.
	includeFilters	false	string	true	Set to `before` to only execute "before" filters, `after` to only execute "after" filters or `false` to skip all filters.

return type

any

protectsFromForgery

arguments

label	name	required	type	default	hint
	with	false	string	exception	How to handle invalid authenticity token checks. Valid values are `error` (throws a `Wheels.InvalidAuthenticityToken` error), `abort` (aborts the request silently and sends a blank response to the client), and `ignore` (ignores the check and lets the request proceed).
	only	false	string		List of actions that this check should only run on. Leave blank for all.
	except	false	string		List of actions that this check should be omitted from running on. Leave blank for no exceptions.

return type

any

provides

arguments

label	name	required	type	default	hint
	formats	false	string		Formats to instruct the controller to provide. Valid values are `html` (the default), `xml`, `json`, `csv`, `pdf`, and `xls`.

return type

void

radioButton

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	tagValue	false	string	null	The value of the radio button when selected.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

radioButtonTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	value	true	string	null	[see:textFieldTag].
	checked	false	boolean	false	Whether or not to check the radio button by default.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].*
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

redirectTo

arguments

label	name	required	type	default	hint
	back	false	boolean	false	Set to `true` to redirect back to the referring page.
	addToken	false	boolean	null	See documentation for your CFML engine's implementation of `cflocation`.
	statusCode	false	numeric	null	See documentation for your CFML engine's implementation of `cflocation`.
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	method	false	string
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: `wheels=cool&x=y`). Please note that CFWheels uses the `&` and `=` characters to split the parameters and encode them properly for you. However, if you need to pass in `&` or `=` as part of the value, then you need to encode them (and only them), example: `a=cats%26dogs%3Dtrouble!&b=1`.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If `true`, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	url	false	string		Redirect to an external URL.
	delay	false	boolean	null	Set to `true` to delay the redirection until after the rest of your action code has executed.
	encode	false	boolean	null	[see:URLFor].

return type

void

renderNothing

arguments

label	name	required	type	default	hint
	status	false	string		[see:renderView].

return type

void

renderPartial

arguments

label	name	required	type	default	hint
	partial	true	string	null	The name of the partial file to be used. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Do not include the partial filename's underscore and file extension.
	cache	false	any		[see:renderView].
	layout	false	string	null	[see:renderView].
	returnAs	false	string		[see:renderView].
	dataFunction	false	any	null	Name of a controller function to load data from.
	status	false	string		[see:renderView].

return type

any

renderText

arguments

label	name	required	type	default	hint
	text	false	string		The text to render.
	status	false	any		[see:renderView].

return type

void

renderView

arguments

label	name	required	type	default	hint
	controller	false	string		Controller to include the view page for.
	action	false	string		Action to include the view page for.
	template	false	string		A specific template to render. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder.
	layout	false	any	null	The layout to wrap the content in. Prefix with a leading slash (`/`) if you need to build a path from the root `views` folder. Pass `false` to not load a layout at all.
	cache	false	any		Number of minutes to cache the content for.
	returnAs	false	string		Set to `string` to return the result instead of automatically sending it to the client.
	hideDebugInformation	false	boolean	false	Set to `true` to hide the debug information at the end of the output. This is useful, for example, when you're testing XML output in an environment where the global setting for `showDebugInformation` is `true`.
	status	false	string		Force request to return with specific HTTP status code.

return type

any

renderWith

arguments

label	name	required	type	default	hint
	data	true	any	null	Data to format and render.
	controller	false	string		[see:renderView].
	action	false	string		[see:renderView].
	template	false	string		[see:renderView].
	layout	false	any	null	[see:renderView].
	cache	false	any		[see:renderView].
	returnAs	false	string		[see:renderView].
	hideDebugInformation	false	boolean	false	[see:renderView].
	status	false	string		[see:renderView].

return type

any

resetCycle

arguments

label	name	required	type	default	hint
	name	false	string	default	The name of the cycle to reset.

return type

void

response

arguments

label

name

required

type

default

hint

return type

string

secondSelectTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The day that should be selected initially.
	secondStep	false	numeric	null	[see:timeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

select

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	options	false	any	null	A collection to populate the select form control with. Can be a query recordset or an array of objects.
	includeBlank	false	any	null	Whether to include a blank option in the select form control. Pass true to include a blank line or a string that should represent what display text should appear for the empty value (for example, "- Select One -").
	valueField	false	string	null	The column or property to use for the value of each list element. Used only when a query or array of objects has been supplied in the options argument. Required when specifying `textField`
	textField	false	string	null	The column or property to use for the value of each list element that the end user will see. Used only when a query or array of objects has been supplied in the options argument. Required when specifying `valueField`
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

selectTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	options	true	any	null	[see:select].
	selected	false	string		Value of option that should be selected by default.
	includeBlank	false	any	null	[see:select].
	multiple	false	boolean	null	Whether to allow multiple selection of options in the select form control.
	valueField	false	string	null	[see:select].
	textField	false	string	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

sendEmail

arguments

label	name	required	type	default	hint
	template	false	string		The path to the email template or two paths if you want to send a multipart email. if the `detectMultipart` argument is `false`, the template for the text version should be the first one in the list. This argument is also aliased as `templates`.
	from	false	string		Email address to send from.
	to	false	string		List of email addresses to send the email to.
	subject	false	string		The subject line of the email.
	layout	false	any	null	Layout(s) to wrap the email template in. This argument is also aliased as `layouts`.
	file	false	string		A list of the names of the files to attach to the email. This will reference files stored in the `files` folder (or a path relative to it). This argument is also aliased as `files`.
	detectMultipart	false	boolean	null	When set to `true` and multiple values are provided for the `template` argument, CFWheels will detect which of the templates is text and which one is HTML (by counting the `<` characters).
	deliver	false	boolean	null	When set to `false`, the email will not be sent.
	writeToFile	false	string		The file to which the email contents will be written

return type

any

sendFile

arguments

label	name	required	type	default	hint
	file	true	string	null	The file to send to the user.
	name	false	string		The file name to show in the browser download dialog box.
	type	false	string		The HTTP content type to deliver the file as.
	disposition	false	string	null	Set to `inline` to have the browser handle the opening of the file (possibly inline in the browser) or set to `attachment` to force a download dialog box.
	directory	false	string		Directory outside of the web root where the file exists. Must be a full path.
	deleteFile	false	boolean	false	Pass in `true` to delete the file on the server after sending it.
	deliver	false	boolean	null

return type

any

set

arguments

label

name

required

type

default

hint

return type

void

setFilterChain

arguments

label	name	required	type	default	hint
	chain	true	array	null	An array of structs, each of which represent an `argumentCollection` that get passed to the `filters` function. This should represent the entire filter chain that you want to use for this controller.

return type

void

setPagination

arguments

label	name	required	type	default	hint
	totalRecords	true	numeric	null	Total count of records that should be represented by the paginated links.
	currentPage	false	numeric	1	Page number that should be represented by the data being fetched and the paginated links.
	perPage	false	numeric	25	Number of records that should be represented on each page of data.
	handle	false	string	query	Name of handle to reference in `paginationLinks`.

return type

void

setResponse

arguments

label	name	required	type	default	hint
	content	true	string	null	The content to send to the client.

return type

void

setVerificationChain

arguments

label	name	required	type	default	hint
	chain	true	array	null	An array of structs, each of which represent an `argumentCollection` that get passed to the `verifies` function. This should represent the entire verification chain that you want to use for this controller.

return type

void

simpleFormat

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to format.
	wrap	false	boolean	null	Set to `true` to wrap the result in a paragraph HTML element.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

singularize

Public Function singularize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns the singular form of the passed in word.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null

return type

string

startFormTag

arguments

label	name	required	type	default	hint
	method	false	string	null	The type of `method` to use in the `form` tag (`delete`, `get`, `patch`, `post`, and `put` are the options).
	multipart	false	boolean	null	Set to `true` if the form should be able to upload files.
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: wheels=cool&x=y). Please note that CFWheels uses the & and = characters to split the parameters and encode them properly for you. However, if you need to pass in & or = as part of the value, then you need to encode them (and only them), example: a=cats%26dogs%3Dtrouble!&b=1.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If true, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

stripLinks

arguments

label	name	required	type	default	hint
	html	true	string	null	The HTML to remove links from.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

stripTags

Public Function stripTags
source: C:\home\pptinc.org\wwwroot\wheels\view\sanitize.cfm
Removes all HTML tags from a string.
[section: View Helpers]
[category: Sanitization Functions]

arguments

label	name	required	type	default	hint
	html	true	string	null	The HTML to remove tag markup from.
	encode	false	boolean	null	[see:styleSheetLinkTag].

return type

string

styleSheetLinkTag

arguments

label	name	required	type	default	hint
	sources	false	string		The name of one or many CSS files in the stylesheets folder, minus the `.css` extension. Pass a full URL to generate a tag for an external style sheet. Can also be called with the `source` argument.
	type	false	string	null	The `type` attribute for the `link` tag.
	media	false	string	null	The `media` attribute for the `link` tag.
	rel	false	string	null	The `rel` attribute for the relation between the tag and href.
	head	false	boolean	null	Set to `true` to place the output in the `head` area of the HTML page instead of the default behavior (which is to place the output where the function is called from).
	delim	false	string	,	The delimiter to use for the list of CSS files.
	encode	false	boolean	null	Use this argument to decide whether the output of the function should be encoded in order to prevent Cross Site Scripting (XSS) attacks. Set it to `true` to encode all relevant output for the specific HTML element in question (e.g. tag content, attribute values, and URLs). For HTML elements that have both tag content and attribute values you can set this argument to `attributes` to only encode attribute values and not tag content.

return type

string

submitTag

arguments

label	name	required	type	default	hint
	value	false	string	null	Message to display in the button form control.
	image	false	string	null	File name of the image file to use in the button form control.
	prepend	false	string	null	[see:textField]
	append	false	string	null	[see:textField]
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textArea

arguments

label	name	required	type	default	hint
	objectName	true	any	null	[see:textField].
	property	true	string	null	[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textAreaTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	content	false	string		Content to display in textarea on page load.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textField

arguments

label	name	required	type	default	hint
	objectName	true	any	null	The variable name of the object to build the form control for.
	property	true	string	null	The name of the property to use in the form control.
	association	false	string	null	The name of the association that the property is located on. Used for building nested forms that work with nested properties. If you are building a form with deep nesting, simply pass in a list to the nested object, and CFWheels will figure it out.
	position	false	string	null	The position used when referencing a hasMany relationship in the association argument. Used for building nested forms that work with nested properties. If you are building a form with deep nestings, simply pass in a list of positions, and CFWheels will figure it out.
	label	false	string	null	The label text to use in the form control.
	labelPlacement	false	string	null	Whether to place the label before, after, or wrapped around the form control. Label text placement can be controlled using aroundLeft or aroundRight.
	prepend	false	string	null	String to prepend to the form control. Useful to wrap the form control with HTML tags.
	append	false	string	null	String to append to the form control. Useful to wrap the form control with HTML tags.
	prependToLabel	false	string	null	String to prepend to the form control's label. Useful to wrap the form control with HTML tags.
	appendToLabel	false	string	null	String to append to the form control's label. Useful to wrap the form control with HTML tags.
	errorElement	false	string	null	HTML tag to wrap the form control with when the object contains errors.
	errorClass	false	string	null	The class name of the HTML tag that wraps the form control when there are errors.
	type	false	string	text	Input type attribute. Common examples in HTML5 and later are text (default), email, tel, and url.
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

textFieldTag

arguments

label	name	required	type	default	hint
	name	true	string	null	Name to populate in tag's name attribute.
	value	false	string		Value to populate in tag's value attribute.
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	type	false	string	text	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

timeAgoInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	toTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare to.

return type

any

timeSelect

arguments

label	name	required	type	default	hint
	objectName	false	any		[see:textField].
	property	false	string		[see:textField].
	association	false	string	null	[see:textField].
	position	false	string	null	[see:textField].
	order	false	string	null	Use to change the order of or exclude time select tags.
	separator	false	string	null	Use to change the character that is displayed between the time select tags.
	minuteStep	false	numeric	null	Pass in 10 to only show minute 10, 20, 30, etc.
	secondStep	false	numeric	null	Pass in 10 to only show seconds 10, 20, 30, etc.
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	errorElement	false	string	null	[see:textField].
	errorClass	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	twelveHour	false	boolean	null	whether to display the hours in 24 or 12 hour format. 12 hour format has AM/PM drop downs
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

timeSelectTags

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		[see:selectTag].
	order	false	string	null	[see:timeSelect].
	separator	false	string	null	[see:timeSelect].
	minuteStep	false	numeric	null	[see:timeSelect].
	secondStep	false	numeric	null	[see:timeSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:dateSelect].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	combine	false	boolean	null	[see:dateTimeSelect].
	twelveHour	false	boolean	null	[see:timeSelect].
	encode	false	any	null	[see:styleSheetLinkTag].

return type

string

timeUntilInWords

arguments

label	name	required	type	default	hint
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	fromTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare from.

return type

string

titleize

arguments

label	name	required	type	default	hint
	word	true	string	null	The text to turn into a title.

return type

string

truncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Length to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

turnKey

Public Function turnKey
source: C:\home\pptinc.org\wwwroot\controllers\Services.cfc

arguments

label

name

required

type

default

hint

return type

any

URLFor

Public Function URLFor
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Creates an internal URL based on supplied arguments.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: `wheels=cool&x=y`). Please note that CFWheels uses the `&` and `=` characters to split the parameters and encode them properly for you. However, if you need to pass in `&` or `=` as part of the value, then you need to encode them (and only them), example: `a=cats%26dogs%3Dtrouble!&b=1`.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If `true`, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	encode	false	boolean	null	Encode URL parameters using `EncodeForURL()`. Please note that this does not make the string safe for placement in HTML attributes, for that you need to wrap the result in `EncodeForHtmlAttribute()` or use `linkTo()`, `startFormTag()` etc instead.
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

usesLayout

arguments

label	name	required	type	default	hint
	template	true	string	null	Name of the layout template or function name you want to use.
	ajax	false	string		Name of the layout template you want to use for AJAX requests.
	except	false	string	null	List of actions that should not get the layout.
	only	false	string	null	List of actions that should only get the layout.
	useDefault	false	boolean	true	When specifying conditions or a function, pass in `true` to use the default `layout.cfm` if none of the conditions are met.

return type

void

verificationChain

arguments

label

name

required

type

default

hint

return type

array

verifies

arguments

label	name	required	type	default	hint
	only	false	string		List of action names to limit this verification to.
	except	false	string		List of action names to exclude this verification from.
	post	false	any		Set to true to verify that this is a `POST` request.
	get	false	any		Set to true to verify that this is a `GET` request.
	ajax	false	any		Set to true to verify that this is an `AJAX` request.
	cookie	false	string		Verify that the passed in variable name exists in the cookie scope.
	session	false	string		Verify that the passed in variable name exists in the session scope.
	params	false	string		Verify that the passed in variable name exists in the params struct.
	handler	false	string	null	Pass in the name of a function that should handle failed verifications. The default is to just abort the request when a verification fails.
	cookieTypes	false	string		List of types to check each listed cookie value against (will be passed through to your CFML engine's `IsValid` function).
	sessionTypes	false	string		List of types to check each list session value against (will be passed through to your CFML engine's `IsValid` function).
	paramsTypes	false	string		List of types to check each params value against (will be passed through to your CFML engine's `IsValid` function).

return type

void

wordTruncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Number of words to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

work

Public Function work
source: C:\home\pptinc.org\wwwroot\controllers\Services.cfc

arguments

label

name

required

type

default

hint

return type

any

yearSelectTag

arguments

label	name	required	type	default	hint
	name	true	string	null	[see:textFieldTag].
	selected	false	string		The year that should be selected initially.
	startYear	false	numeric	null	[see:dateSelect].
	endYear	false	numeric	null	[see:dateSelect].
	includeBlank	false	any	null	[see:select].
	label	false	string	null	[see:textField].
	labelPlacement	false	string	null	[see:textField].
	prepend	false	string	null	[see:textField].
	append	false	string	null	[see:textField].
	prependToLabel	false	string	null	[see:textField].
	appendToLabel	false	string	null	[see:textField].
	encode	false	any	null	[see:styleSheetLinkTag].
	$now	false	date	{ts '2025-04-24 11:22:35'}

return type

string

private

$checkMinimumVersion

Private Function $checkMinimumVersion
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm

arguments

label	name	required	type	default	hint
	engine	true	string	null
	version	true	string	null

return type

string

CORETESTDATASOURCENAME

string

wwwroot

CREATEMIGRATORTABLE

boolean

true

CSRFCOOKIEDOMAIN

string

CSRFCOOKIEENCODEVALUE

string

CSRFCOOKIEENCRYPTIONALGORITHM

string

AES

CSRFCOOKIEENCRYPTIONENCODING

string

Base64

CSRFCOOKIEENCRYPTIONSECRETKEY

string

CSRFCOOKIEHTTPONLY

string

CSRFCOOKIENAME

string

_wheels_authenticity

CSRFCOOKIEPATH

string

CSRFCOOKIEPRESERVECASE

string

CSRFCOOKIESECURE

string

CSRFSTORE

string

session

DATASOURCENAME

string

pptcorpweb_dsn

DATASOURCEPASSWORD

string

DATASOURCEUSERNAME

string

DEFAULTCACHETIME

number

DELETEPLUGINDIRECTORIES

boolean

true

DEPENDANTPLUGINS

string

DIRECTORYFILES

Struct

636D80FB524E11F00A390E9E3355B77B

string

Controller.cfc,Pages.cfc,Services.cfc

DISPATCH

Component (wheels.Dispatch)
Only the functions and data members that are accessible from your location are displayed

this

public

$abortInvalidRequest

Public Function $abortInvalidRequest
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$addRouteFormat

Public Function $addRouteFormat
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Adds in the format variable from the route if it exists.

arguments

label	name	required	type	default	hint
	params	true	struct	null
	route	true	struct	null

return type

struct

$addRouteName

Public Function $addRouteName
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Adds in the name variable from the route if it exists.

arguments

label	name	required	type	default	hint
	params	true	struct	null
	route	true	struct	null

return type

struct

$addToCache

Public Function $addToCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	value	true	any	null
	time	false	numeric	60
	category	false	string	main

return type

void

$appKey

Public Function $appKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$args

Public Function $args
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	name	true	string	null
	reserved	false	string
	combine	false	string
	required	false	string

return type

void

$buildReleaseZip

Public Function $buildReleaseZip
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
NB: url rewriting files need to be removed from here.

arguments

label	name	required	type	default	hint
	version	false	string	2.5.0
	directory	false	string	C:\home\pptinc.org\wwwroot\

return type

string

$cache

Public Function $cache
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$cacheCount

Public Function $cacheCount
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

numeric

$cachedControllerClassExists

Public Function $cachedControllerClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cachedModelClassExists

Public Function $cachedModelClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$canonicalize

Public Function $canonicalize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Call CFML's canonicalize() function but set to blank string if the result is null (happens on Lucee 5).

arguments

label	name	required	type	default	hint
	input	true	string	null

return type

string

$cgiScope

Public Function $cgiScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
This copies all the variables CFWheels needs from the CGI scope to the request scope.

arguments

label	name	required	type	default	hint
	keys	false	string	request_method,http_x_requested_with,http_referer,server_name,path_info,script_name,query_string,remote_addr,server_port,server_port_secure,server_protocol,http_host,http_accept,content_type,http_x_rewrite_url,http_x_original_url,request_uri,redirect_url,http_x_forwarded_for,http_x_forwarded_proto
	scope	false	struct

return type

struct

$cleanInlist

Public Function $cleanInlist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	where	true	string	null

return type

any

$clearCache

Public Function $clearCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

void

$clearControllerInitializationCache

Public Function $clearControllerInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$clearModelInitializationCache

Public Function $clearModelInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$combineArguments

Public Function $combineArguments
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	combine	true	string	null
	required	true	boolean	false
	extendedInfo	false	string

return type

void

$constructParams

Public Function $constructParams
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	true	string	null
	encode	false	boolean	true
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

$content

Public Function $content
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$contentType

arguments

label

name

required

type

default

hint

return type

string

$convertToString

Public Function $convertToString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	any	null
	type	false	string

return type

string

$createControllerClass

Public Function $createControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	controllerPaths	false	string
	type	false	string	controller

return type

any

$createModelClass

Public Function $createModelClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	modelPaths	false	string	models
	type	false	string	model

return type

any

$createNestedParamStruct

Public Function $createNestedParamStruct
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	true	struct	null

return type

struct

$createObjectFromRoot

Public Function $createObjectFromRoot
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null
	fileName	true	string	null
	method	true	string	null

return type

any

$createParams

Public Function $createParams
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Create a struct to hold the params, merge form and url scopes into it, add JSON body etc.

arguments

label	name	required	type	default	hint
	path	true	string	null
	route	true	struct	null
	formScope	true	struct	null
	urlScope	true	struct	null

return type

struct

$dbinfo

Public Function $dbinfo
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$debugPoint

Public Function $debugPoint
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

void

$deobfuscateParams

Public Function $deobfuscateParams
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Loops through the params struct passed in and attempts to deobfuscate it.
Ignores the controller and action params values.

arguments

label	name	required	type	default	hint
	params	true	struct	null

return type

struct

$directory

Public Function $directory
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$dollarify

Public Function $dollarify
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	input	true	struct	null
	on	true	string	null

return type

struct

$doubleCheckedLock

Public Function $doubleCheckedLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	condition	true	string	null
	execute	true	string	null
	conditionArgs	false	struct
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$ensureControllerAndAction

Public Function $ensureControllerAndAction
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Ensure that the controller and action params exist and are camelized.

arguments

label	name	required	type	default	hint
	params	true	struct	null
	route	true	struct	null

return type

struct

$file

Public Function $file
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$fileExistsNoCase

Public Function $fileExistsNoCase
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	absolutePath	true	string	null

return type

any

$findMatchingRoute

Public Function $findMatchingRoute
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null
	requestMethod	false	string

return type

struct

$findRoute

Public Function $findRoute
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$fullCgiDomainString

Public Function $fullCgiDomainString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get full domain string from cgi scope: includes protocol and port
e.g https://www.cfwheels.com:443

arguments

label	name	required	type	default	hint
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

string

$fullDomainString

arguments

label	name	required	type	default	hint
	domain	true	string	null	The string to look at

return type

string

$get

Public Function $get
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from get().

arguments

label	name	required	type	default	hint
	name	true	string	null
	functionName	false	string

return type

any

$getFromCache

Public Function $getFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

any

$getIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

$getPathFromRequest

Public Function $getPathFromRequest
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Return the path without the leading "/".

arguments

label	name	required	type	default	hint
	pathInfo	true	string	null
	scriptName	true	string	null

return type

string

$getRequestMethod

Public Function $getRequestMethod
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Determine HTTP verb used in request.

arguments

label

name

required

type

default

hint

return type

string

$getRequestTimeout

Public Function $getRequestTimeout
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Returns the request timeout value in seconds

arguments

label

name

required

type

default

hint

return type

numeric

$hashedKey

Public Function $hashedKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Creates a unique string based on any arguments passed in (used as a key for caching mostly).

arguments

label

name

required

type

default

hint

return type

string

$header

Public Function $header
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$htmlhead

Public Function $htmlhead
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$image

Public Function $image
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

struct

$include

Public Function $include
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndOutput

Public Function $includeAndOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndReturnOutput

Public Function $includeAndReturnOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	$template	true	string	null

return type

string

$init

Public Function $init
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Returns itself (the Dispatch object).

arguments

label

name

required

type

default

hint

return type

any

$initializeRequestScope

Public Function $initializeRequestScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$invoke

Public Function $invoke
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$listClean

Public Function $listClean
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Removes whitespace between list elements.
Optional argument to return the list as an array.

arguments

label	name	required	type	default	hint
	list	true	string	null
	delim	false	string	,
	returnAs	false	string	string

return type

any

$listToStruct

Public Function $listToStruct
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Converts a comma delimted list to a struct

arguments

label	name	required	type	default	hint
	list	true	string	null
	value	false	string	1

return type

struct

$loadPlugins

Public Function $loadPlugins
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$loadRoutes

Public Function $loadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$location

Public Function $location
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	delay	false	boolean	false

return type

void

$lockedLoadRoutes

Public Function $lockedLoadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$mail

Public Function $mail
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$mergeRoutePattern

Public Function $mergeRoutePattern
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Parses the route pattern, identifies the variable markers within the pattern and assigns the value from the url variables with the path.

arguments

label	name	required	type	default	hint
	params	true	struct	null
	route	true	struct	null
	path	true	string	null

return type

struct

$mergeUrlAndFormScopes

Public Function $mergeUrlAndFormScopes
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Merges the URL and form scope into a single structure, URL scope has precedence.

arguments

label	name	required	type	default	hint
	params	true	struct	null
	urlScope	true	struct	null
	formScope	true	struct	null

return type

struct

$namedArguments

arguments

label	name	required	type	default	hint
	$defined	true	string	null

return type

struct

$objectFileName

Public Function $objectFileName
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	objectPath	true	string	null
	type	true	string	null

return type

string

$paramParser

Public Function $paramParser
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Find the route that matches the path, create params struct and return it.

arguments

label	name	required	type	default	hint
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm
	formScope	false	struct
	urlScope	false	struct

return type

struct

$parseJsonBody

Public Function $parseJsonBody
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
If content type is JSON, deserialize it into a struct and add to the params struct.

arguments

label	name	required	type	default	hint
	params	true	struct	null

return type

struct

$prependUrl

Public Function $prependUrl
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null

return type

string

$query

Public Function $query
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	sql	true	string	null

return type

any

$removeFromCache

Public Function $removeFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

void

$request

Public Function $request
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Parse incoming params, create controller object, call an action on it and return the response.
Called from index.cfm in the root so what we return here is the final result of the request processing.

arguments

label	name	required	type	default	hint
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm
	formScope	false	struct
	urlScope	false	struct

return type

string

$restoreTestRunnerApplicationScope

Public Function $restoreTestRunnerApplicationScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Restore the application scope modified by the test runner

arguments

label

name

required

type

default

hint

return type

void

$routeVariables

Public Function $routeVariables
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$set

Public Function $set
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from set().

arguments

label

name

required

type

default

hint

return type

void

$setCORSHeaders

Public Function $setCORSHeaders
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Set CORS Headers: only triggered if application.wheels.allowCorsRequests = true

arguments

label	name	required	type	default	hint
	allowOrigin	false	string	*
	allowCredentials	false	string	false
	allowHeaders	false	string	Origin, Content-Type, X-Auth-Token, X-Requested-By, X-Requested-With
	allowMethods	false	string	GET, POST, PATCH, PUT, DELETE, OPTIONS
	allowMethodsByRoute	false	boolean	false
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm

return type

void

$setNamedRoutePositions

Public Function $setNamedRoutePositions
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$simpleLock

Public Function $simpleLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	type	true	string	null
	execute	true	string	null
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$singularizeOrPluralize

Public Function $singularizeOrPluralize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	which	true	string	null
	count	false	numeric	-1
	returnCount	false	boolean	true

return type

string

$statusCode

Public Function $statusCode
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get the status code (e.g. 200, 404 etc) of the response we're about to send.

arguments

label

name

required

type

default

hint

return type

string

$structKeysExist

Public Function $structKeysExist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Check to see if all keys in the list exist for the structure and have length.

arguments

label	name	required	type	default	hint
	struct	true	struct	null
	keys	false	string

return type

boolean

$throwErrorOrShow404Page

arguments

label	name	required	type	default	hint
	type	true	string	null
	message	true	string	null
	extendedInfo	false	string

return type

void

$timeSpanForCache

Public Function $timeSpanForCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	cache	true	any	null
	defaultCacheTime	false	numeric	60
	cacheDatePart	false	string	n

return type

any

$timestamp

Public Function $timestamp
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	timeStampMode	false	string	utc

return type

string

$toXml

Public Function $toXml
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	data	true	any	null

return type

xml

$translateBlankCheckBoxSubmissions

Public Function $translateBlankCheckBoxSubmissions
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Loops through the params struct and handle the cases where checkboxes are unchecked.

arguments

label	name	required	type	default	hint
	params	true	struct	null

return type

struct

$translateDatePartSubmissions

Public Function $translateDatePartSubmissions
source: C:\home\pptinc.org\wwwroot\wheels\dispatch\functions.cfm
Combines date parts into a single value.

arguments

label	name	required	type	default	hint
	params	true	struct	null

return type

struct

$wddx

Public Function $wddx
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	input	true	any	null
	action	false	string	cfml2wddx
	useTimeZoneInfo	false	boolean	true

return type

any

$wildcardDomainMatch

Public Function $wildcardDomainMatch
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Wildcard domain match: domain satifies wildcard

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	origin	true	string	null	string to test against e.g bar.foo.com

return type

boolean

$wildcardDomainMatchCGI

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

boolean

$zip

Public Function $zip
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

addFormat

arguments

label	name	required	type	default	hint
	extension	true	string	null	File extension to add.
	mimeType	true	string	null	Matching MIME type to associate with the file extension.

return type

void

capitalize

arguments

label	name	required	type	default	hint
	text	true	string	null

return type

string

controller

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the controller to create.
	params	false	struct		The params struct (combination of form and URL variables).

return type

any

deobfuscateParam

Public Function deobfuscateParam
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Deobfuscates a value.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	param	true	string	null	The value to deobfuscate.

return type

string

distanceOfTimeInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.

return type

string

excerpt

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to extract an excerpt from.
	phrase	true	string	null	The phrase to extract.
	radius	false	numeric	null	Number of characters to extract surrounding the phrase.
	excerptString	false	string	null	String to replace first and / or last characters with.

return type

string

flashMessages

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

get

arguments

label	name	required	type	default	hint
	name	true	string	null	Variable name to get setting for.
	functionName	false	string		Function name to get setting for.

return type

any

humanize

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to humanize.
	except	false	string		A list of strings (space separated) to replace within the output.

return type

string

hyphenize

arguments

label	name	required	type	default	hint
	string	true	string	null	The string to hyphenize.

return type

string

includeReCaptchaJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

insertReCaptchaDiv

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

isValidReCaptcha

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

mapper

arguments

label	name	required	type	default	hint
	restful	false	boolean	true	Whether to turn on RESTful routing or not. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	methods	false	boolean		If not RESTful, then specify allowed routes. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	mapFormat	false	boolean	true	This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc. Set to false to disable automatic .[format] generation for resource based routes

return type

struct

mimeTypes

arguments

label	name	required	type	default	hint
	extension	true	string	null	The extension to get the MIME type for.
	fallback	false	string	application/octet-stream	The fallback MIME type to return.

return type

string

model

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the model to get a reference to.

return type

any

obfuscateParam

arguments

label	name	required	type	default	hint
	param	true	any	null	The value to obfuscate.

return type

string

pagination

arguments

label	name	required	type	default	hint
	handle	false	string	query	The handle given to the query to return pagination information for.

return type

struct

pluginNames

arguments

label

name

required

type

default

hint

return type

string

pluralize

arguments

label	name	required	type	default	hint
	word	true	string	null	The word to pluralize.
	count	false	numeric	-1	Pluralization will occur when this value is not 1.
	returnCount	false	boolean	true	Will return count prepended to the pluralization when true and count is not -1.

return type

string

processRequest

arguments

label	name	required	type	default	hint
	params	true	struct	null	The params struct to use in the request (make sure that at least `controller` and `action` are set).
	method	false	string	null	The HTTP method to use in the request (`get`, `post` etc).
	returnAs	false	string	null	Pass in `struct` to return all information about the request instead of just the final output (`body`).
	rollback	false	string	null	Pass in `true` to roll back all database transactions made during the request.
	includeFilters	false	string	true	Set to `before` to only execute "before" filters, `after` to only execute "after" filters or `false` to skip all filters.

return type

any

set

arguments

label

name

required

type

default

hint

return type

void

setPagination

arguments

label	name	required	type	default	hint
	totalRecords	true	numeric	null	Total count of records that should be represented by the paginated links.
	currentPage	false	numeric	1	Page number that should be represented by the data being fetched and the paginated links.
	perPage	false	numeric	25	Number of records that should be represented on each page of data.
	handle	false	string	query	Name of handle to reference in `paginationLinks`.

return type

void

singularize

Public Function singularize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns the singular form of the passed in word.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null

return type

string

timeAgoInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	toTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare to.

return type

any

timeUntilInWords

arguments

label	name	required	type	default	hint
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	fromTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare from.

return type

string

titleize

arguments

label	name	required	type	default	hint
	word	true	string	null	The text to turn into a title.

return type

string

truncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Length to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

URLFor

Public Function URLFor
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Creates an internal URL based on supplied arguments.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: `wheels=cool&x=y`). Please note that CFWheels uses the `&` and `=` characters to split the parameters and encode them properly for you. However, if you need to pass in `&` or `=` as part of the value, then you need to encode them (and only them), example: `a=cats%26dogs%3Dtrouble!&b=1`.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If `true`, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	encode	false	boolean	null	Encode URL parameters using `EncodeForURL()`. Please note that this does not make the string safe for placement in HTML attributes, for that you need to wrap the result in `EncodeForHtmlAttribute()` or use `linkTo()`, `startFormTag()` etc instead.
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

wordTruncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Number of words to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

private

$checkMinimumVersion

Private Function $checkMinimumVersion
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm

arguments

label	name	required	type	default	hint
	engine	true	string	null
	version	true	string	null

return type

string

ENABLEMIGRATORCOMPONENT

boolean

true

ENABLEPLUGINSCOMPONENT

boolean

true

ENABLEPUBLICCOMPONENT

boolean

false

ENCODEHTMLATTRIBUTES

boolean

true

ENCODEHTMLTAGS

boolean

true

ENCODEURLS

boolean

true

environment

string

production

ERROREMAILADDRESS

string

tech.cfgeek@gmail.com

ERROREMAILFROMADDRESS

string

ERROREMAILSUBJECT

string

Error

ERROREMAILTOADDRESS

string

EVENTPATH

string

events

EXCLUDEFROMERROREMAIL

string

EXISTINGHELPERFILES

string

EXISTINGLAYOUTFILES

string

EXISTINGOBJECTFILES

string

controllers/Pages,controllers/Services

FILEPATH

string

files

FLASHAPPEND

boolean

true

FLASHSTORAGE

string

session

FORMATS

Struct

CSV

string

text/csv

HTML

string

text/html

JSON

string

application/json

PDF

string

application/pdf

XLS

string

application/vnd.ms-excel

XML

string

text/xml

FUNCTIONS

Struct
Entries: 102

AUTOLINK

Struct

ENCODE

boolean

true

LINK

string

all

AVERAGE

Struct

DISTINCT

boolean

false

IFNULL

string

PARAMETERIZE

boolean

true

BELONGSTO

Struct

JOINTYPE

string

inner

BUTTONTAG

Struct

APPEND

string

CONTENT

string

Save changes

ENCODE

boolean

true

IMAGE

string

PREPEND

string

TYPE

string

submit

VALUE

string

save

BUTTONTO

Struct

ENCODE

boolean

true

HOST

string

IMAGE

string

ONLYPATH

boolean

true

PORT

number

PROTOCOL

string

TEXT

string

CACHES

Struct

STATIC

boolean

false

TIME

number

CHECKBOX

Struct
Entries: 11

APPEND

string

APPENDTOLABEL

string

CHECKEDVALUE

number

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

LABEL

string

useDefaultLabel

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

UNCHECKEDVALUE

number

CHECKBOXTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

VALUE

number

COUNT

Struct

PARAMETERIZE

boolean

true

CREATE

Struct

PARAMETERIZE

boolean

true

RELOAD

boolean

false

CSRFMETATAGS

Struct

ENCODE

boolean

true

DATESELECT

Struct
Entries: 17

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ENDYEAR

number

2030

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

INCLUDEBLANK

boolean

false

LABEL

boolean

false

LABELPLACEMENT

string

around

MONTHABBREVIATIONS

string

Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec

MONTHDISPLAY

string

names

MONTHNAMES

string

January,February,March,April,May,June,July,August,September,October,November,December

ORDER

string

month,day,year

PREPEND

string

PREPENDTOLABEL

string

SEPARATOR

string

STARTYEAR

number

2020

DATESELECTTAGS

Struct
Entries: 15

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ENDYEAR

number

2030

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

MONTHABBREVIATIONS

string

Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec

MONTHDISPLAY

string

names

MONTHNAMES

string

January,February,March,April,May,June,July,August,September,October,November,December

ORDER

string

month,day,year

PREPEND

string

PREPENDTOLABEL

string

SEPARATOR

string

STARTYEAR

number

2020

DATETIMESELECT

Struct
Entries: 23

APPEND

string

APPENDTOLABEL

string

DATEORDER

string

month,day,year

DATESEPARATOR

string

ENCODE

boolean

true

ENDYEAR

number

2030

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

INCLUDEBLANK

boolean

false

LABEL

boolean

false

LABELPLACEMENT

string

around

MINUTESTEP

number

MONTHABBREVIATIONS

string

Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec

MONTHDISPLAY

string

names

MONTHNAMES

string

January,February,March,April,May,June,July,August,September,October,November,December

PREPEND

string

PREPENDTOLABEL

string

SECONDSTEP

number

SEPARATOR

string

STARTYEAR

number

2020

TIMEORDER

string

hour,minute,second

TIMESEPARATOR

string

TWELVEHOUR

boolean

false

DATETIMESELECTTAGS

Struct
Entries: 21

APPEND

string

APPENDTOLABEL

string

DATEORDER

string

month,day,year

DATESEPARATOR

string

ENCODE

boolean

true

ENDYEAR

number

2030

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

MINUTESTEP

number

MONTHABBREVIATIONS

string

Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec

MONTHDISPLAY

string

names

MONTHNAMES

string

January,February,March,April,May,June,July,August,September,October,November,December

PREPEND

string

PREPENDTOLABEL

string

SECONDSTEP

number

SEPARATOR

string

STARTYEAR

number

2020

TIMEORDER

string

hour,minute,second

TIMESEPARATOR

string

TWELVEHOUR

boolean

false

DAYSELECTTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

DELETE

Struct

PARAMETERIZE

boolean

true

DELETEALL

Struct

INSTANTIATE

boolean

false

PARAMETERIZE

boolean

true

RELOAD

boolean

false

DELETEBYKEY

Struct

RELOAD

boolean

false

DELETEONE

Struct

RELOAD

boolean

false

DISTANCEOFTIMEINWORDS

Struct

INCLUDESECONDS

boolean

false

ENDFORMTAG

Struct

APPEND

string

ENCODE

boolean

true

PREPEND

string

ERRORMESSAGEON

Struct

APPENDTEXT

string

CLASS

string

error-message

ENCODE

boolean

true

PREPENDTEXT

string

WRAPPERELEMENT

string

span

ERRORMESSAGESFOR

Struct

CLASS

string

error-messages

ENCODE

boolean

true

INCLUDEASSOCIATIONS

boolean

true

SHOWDUPLICATES

boolean

true

EXCERPT

Struct

EXCERPTSTRING

string

...

RADIUS

number

100

EXISTS

Struct

PARAMETERIZE

boolean

true

RELOAD

boolean

false

FILEFIELD

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

LABEL

string

useDefaultLabel

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

FILEFIELDTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

FINDALL

Struct

GROUP

string

ORDER

string

PARAMETERIZE

boolean

true

PERPAGE

number

RELOAD

boolean

false

RETURNAS

string

query

RETURNINCLUDED

boolean

true

FINDBYKEY

Struct

PARAMETERIZE

boolean

true

RELOAD

boolean

false

RETURNAS

string

object

FINDONE

Struct

PARAMETERIZE

boolean

true

RELOAD

boolean

false

RETURNAS

string

object

FLASHKEEP

Struct

FLASHMESSAGES

Struct

CLASS

string

flash-messages

ENCODE

boolean

true

INCLUDEEMPTYCONTAINER

string

false

HASMANY

Struct

DEPENDENT

boolean

false

JOINTYPE

string

outer

HASMANYCHECKBOX

Struct

ENCODE

boolean

true

HASMANYRADIOBUTTON

Struct

ENCODE

boolean

true

HASONE

Struct

DEPENDENT

boolean

false

JOINTYPE

string

outer

HIDDENFIELD

Struct

ENCODE

boolean

true

HIDDENFIELDTAG

Struct

ENCODE

boolean

true

HIGHLIGHT

Struct

CLASS

string

highlight

DELIMITER

string

ENCODE

boolean

true

TAG

string

span

HOURSELECTTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

TWELVEHOUR

boolean

false

IMAGETAG

Struct

ENCODE

boolean

true

HOST

string

ONLYPATH

boolean

true

PORT

number

PROTOCOL

string

INCLUDEPARTIAL

Struct

DATAFUNCTION

boolean

true

LAYOUT

string

SPACER

string

JAVASCRIPTINCLUDETAG

Struct

ENCODE

boolean

true

HEAD

boolean

false

TYPE

string

text/javascript

LINKTO

Struct

ENCODE

boolean

true

HOST

string

ONLYPATH

boolean

true

PORT

number

PROTOCOL

string

MAILTO

Struct

ENCODE

boolean

true

MAXIMUM

Struct

IFNULL

string

PARAMETERIZE

boolean

true

MINIMUM

Struct

IFNULL

string

PARAMETERIZE

boolean

true

MINUTESELECTTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

MINUTESTEP

number

PREPEND

string

PREPENDTOLABEL

string

MONTHSELECTTAG

Struct
Entries: 11

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

MONTHABBREVIATIONS

string

Jan,Feb,Mar,Apr,May,Jun,Jul,Aug,Sep,Oct,Nov,Dec

MONTHDISPLAY

string

names

MONTHNAMES

string

January,February,March,April,May,June,July,August,September,October,November,December

PREPEND

string

PREPENDTOLABEL

string

NESTEDPROPERTIES

Struct

ALLOWDELETE

boolean

false

AUTOSAVE

boolean

true

REJECTIFBLANK

string

SORTPROPERTY

string

PAGINATIONLINKS

Struct
Entries: 18

ADDACTIVECLASSTOPREPENDEDPARENT

boolean

false

ALWAYSSHOWANCHORS

boolean

true

ANCHORDIVIDER

string

...

APPEND

string

APPENDONANCHOR

boolean

true

APPENDONLAST

boolean

true

APPENDTOPAGE

string

CLASSFORCURRENT

string

ENCODE

boolean

true

LINKTOCURRENTPAGE

boolean

false

NAME

string

page

PAGENUMBERASPARAM

boolean

true

PREPEND

string

PREPENDONANCHOR

boolean

true

PREPENDONFIRST

boolean

true

PREPENDTOPAGE

string

SHOWSINGLEPAGE

boolean

false

WINDOWSIZE

number

PASSWORDFIELD

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

LABEL

string

useDefaultLabel

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

PASSWORDFIELDTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

PROCESSREQUEST

Struct

METHOD

string

get

RETURNAS

string

ROLLBACK

boolean

false

PROTECTSFROMFORGERY

Struct

EXCEPT

string

ONLY

string

WITH

string

exception

RADIOBUTTON

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

LABEL

string

useDefaultLabel

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

RADIOBUTTONTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

REDIRECTTO

Struct

ADDTOKEN

boolean

false

DELAY

boolean

false

ENCODE

boolean

true

HOST

string

ONLYPATH

boolean

true

PORT

number

PROTOCOL

string

STATUSCODE

number

302

RENDERPARTIAL

Struct

DATAFUNCTION

boolean

true

LAYOUT

string

RENDERVIEW

Struct

LAYOUT

string

RENDERWITH

Struct

LAYOUT

string

SAVE

Struct

PARAMETERIZE

boolean

true

RELOAD

boolean

false

SECONDSELECTTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

SECONDSTEP

number

SELECT

Struct
Entries: 12

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

INCLUDEBLANK

boolean

false

LABEL

string

useDefaultLabel

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

TEXTFIELD

string

VALUEFIELD

string

SELECTTAG

Struct
Entries: 11

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

MULTIPLE

boolean

false

PREPEND

string

PREPENDTOLABEL

string

TEXTFIELD

string

VALUEFIELD

string

SENDEMAIL

Struct

DELIVER

boolean

true

DETECTMULTIPART

boolean

true

FROM

string

LAYOUT

boolean

false

SUBJECT

string

SENDFILE

Struct

DELIVER

boolean

true

DISPOSITION

string

attachment

SIMPLEFORMAT

Struct

ENCODE

boolean

true

WRAP

boolean

true

STARTFORMTAG

Struct

APPEND

string

ENCODE

boolean

true

HOST

string

METHOD

string

post

MULTIPART

boolean

false

ONLYPATH

boolean

true

PORT

number

PREPEND

string

PROTOCOL

string

STRIPLINKS

Struct

ENCODE

boolean

true

STRIPTAGS

Struct

ENCODE

boolean

true

STYLESHEETLINKTAG

Struct

ENCODE

boolean

true

HEAD

boolean

false

MEDIA

string

all

TYPE

string

text/css

SUBMITTAG

Struct

APPEND

string

ENCODE

boolean

true

IMAGE

string

PREPEND

string

VALUE

string

Save changes

SUM

Struct

DISTINCT

boolean

false

IFNULL

string

PARAMETERIZE

boolean

true

TEXTAREA

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

LABEL

string

useDefaultLabel

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

TEXTAREATAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

TEXTFIELD

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

LABEL

string

useDefaultLabel

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

TEXTFIELDTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

TIMEAGOINWORDS

Struct

INCLUDESECONDS

boolean

false

TIMESELECT

Struct
Entries: 15

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ERRORCLASS

string

field-with-errors

ERRORELEMENT

string

span

INCLUDEBLANK

boolean

false

LABEL

boolean

false

LABELPLACEMENT

string

around

MINUTESTEP

number

ORDER

string

hour,minute,second

PREPEND

string

PREPENDTOLABEL

string

SECONDSTEP

number

SEPARATOR

string

TWELVEHOUR

boolean

false

TIMESELECTTAGS

Struct
Entries: 13

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

MINUTESTEP

number

ORDER

string

hour,minute,second

PREPEND

string

PREPENDTOLABEL

string

SECONDSTEP

number

SEPARATOR

string

TWELVEHOUR

boolean

false

TIMEUNTILINWORDS

Struct

INCLUDESECONDS

boolean

false

TOGGLE

Struct

SAVE

boolean

true

TRUNCATE

Struct

LENGTH

number

TRUNCATESTRING

string

...

UPDATE

Struct

PARAMETERIZE

boolean

true

RELOAD

boolean

false

UPDATEALL

Struct

INSTANTIATE

boolean

false

PARAMETERIZE

boolean

true

RELOAD

boolean

false

UPDATEBYKEY

Struct

RELOAD

boolean

false

UPDATEONE

Struct

RELOAD

boolean

false

UPDATEPROPERTY

Struct

PARAMETERIZE

boolean

true

URLFOR

Struct

ENCODE

boolean

true

HOST

string

ONLYPATH

boolean

true

PORT

number

PROTOCOL

string

VALIDATESCONFIRMATIONOF

Struct

MESSAGE

string

[property] should match confirmation

VALIDATESEXCLUSIONOF

Struct

ALLOWBLANK

boolean

false

MESSAGE

string

[property] is reserved

VALIDATESFORMATOF

Struct

ALLOWBLANK

boolean

false

MESSAGE

string

[property] is invalid

VALIDATESINCLUSIONOF

Struct

ALLOWBLANK

boolean

false

MESSAGE

string

[property] is not included in the list

VALIDATESLENGTHOF

Struct

ALLOWBLANK

boolean

false

EXACTLY

number

MAXIMUM

number

MESSAGE

string

[property] is the wrong length

MINIMUM

number

WITHIN

string

VALIDATESNUMERICALITYOF

Struct

ALLOWBLANK

boolean

false

EQUALTO

string

EVEN

string

GREATERTHAN

string

GREATERTHANOREQUALTO

string

LESSTHAN

string

LESSTHANOREQUALTO

string

MESSAGE

string

[property] is not a number

ODD

string

ONLYINTEGER

boolean

false

VALIDATESPRESENCEOF

Struct

MESSAGE

string

[property] can't be empty

VALIDATESUNIQUENESSOF

Struct

ALLOWBLANK

boolean

false

MESSAGE

string

[property] has already been taken

VERIFIES

Struct

HANDLER

string

WORDTRUNCATE

Struct

LENGTH

number

TRUNCATESTRING

string

...

YEARSELECTTAG

Struct

APPEND

string

APPENDTOLABEL

string

ENCODE

boolean

true

ENDYEAR

number

2030

INCLUDEBLANK

boolean

false

LABEL

string

LABELPLACEMENT

string

around

PREPEND

string

PREPENDTOLABEL

string

STARTYEAR

number

2020

HOSTNAME

string

VPS-FC8-B2-414

IMAGEPATH

string

images

INCLUDEERRORINEMAILSUBJECT

boolean

true

INCOMPATIBLEPLUGINS

string

flashMessages,reCaptcha

INITIALIZED

boolean

true

IPEXCEPTIONS

string

IRREGULARS

Struct

CHILD

string

children

FOOT

string

feet

MAN

string

men

MOVE

string

moves

PERSON

string

people

SEX

string

sexes

TOOTH

string

teeth

WOMAN

string

women

JAVASCRIPTPATH

string

javascripts

LOADINCOMPATIBLEPLUGINS

boolean

true

LOWERCASETABLENAMES

boolean

false

MAPPER

Component (wheels.Mapper)
Only the functions and data members that are accessible from your location are displayed

this

public

$abortInvalidRequest

Public Function $abortInvalidRequest
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$addToCache

Public Function $addToCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	value	true	any	null
	time	false	numeric	60
	category	false	string	main

return type

void

$appKey

Public Function $appKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$args

Public Function $args
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	name	true	string	null
	reserved	false	string
	combine	false	string
	required	false	string

return type

void

$buildReleaseZip

Public Function $buildReleaseZip
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
NB: url rewriting files need to be removed from here.

arguments

label	name	required	type	default	hint
	version	false	string	2.5.0
	directory	false	string	C:\home\pptinc.org\wwwroot\

return type

string

$cache

Public Function $cache
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$cacheCount

Public Function $cacheCount
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

numeric

$cachedControllerClassExists

Public Function $cachedControllerClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cachedModelClassExists

Public Function $cachedModelClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$canonicalize

Public Function $canonicalize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Call CFML's canonicalize() function but set to blank string if the result is null (happens on Lucee 5).

arguments

label	name	required	type	default	hint
	input	true	string	null

return type

string

$cgiScope

Public Function $cgiScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
This copies all the variables CFWheels needs from the CGI scope to the request scope.

arguments

label	name	required	type	default	hint
	keys	false	string	request_method,http_x_requested_with,http_referer,server_name,path_info,script_name,query_string,remote_addr,server_port,server_port_secure,server_protocol,http_host,http_accept,content_type,http_x_rewrite_url,http_x_original_url,request_uri,redirect_url,http_x_forwarded_for,http_x_forwarded_proto
	scope	false	struct

return type

struct

$cleanInlist

Public Function $cleanInlist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	where	true	string	null

return type

any

$clearCache

Public Function $clearCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

void

$clearControllerInitializationCache

Public Function $clearControllerInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$clearModelInitializationCache

Public Function $clearModelInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$combineArguments

Public Function $combineArguments
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	combine	true	string	null
	required	true	boolean	false
	extendedInfo	false	string

return type

void

$compileRegex

Public Function $compileRegex
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Internal function.

arguments

label	name	required	type	default	hint
	string	false	rquired	null

return type

void

$constructParams

Public Function $constructParams
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	true	string	null
	encode	false	boolean	true
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

$content

Public Function $content
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$contentType

arguments

label

name

required

type

default

hint

return type

string

$convertToString

Public Function $convertToString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	any	null
	type	false	string

return type

string

$createControllerClass

Public Function $createControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	controllerPaths	false	string
	type	false	string	controller

return type

any

$createModelClass

Public Function $createModelClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	modelPaths	false	string	models
	type	false	string	model

return type

any

$createObjectFromRoot

Public Function $createObjectFromRoot
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null
	fileName	true	string	null
	method	true	string	null

return type

any

$dbinfo

Public Function $dbinfo
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$debugPoint

Public Function $debugPoint
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

void

$directory

Public Function $directory
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$dollarify

Public Function $dollarify
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	input	true	struct	null
	on	true	string	null

return type

struct

$doubleCheckedLock

Public Function $doubleCheckedLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	condition	true	string	null
	execute	true	string	null
	conditionArgs	false	struct
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$draw

Public Function $draw
source: C:\home\pptinc.org\wwwroot\wheels\mapper\mapping.cfm
Internal function.

arguments

label	name	required	type	default	hint
	restful	false	boolean	true
	methods	false	boolean
	mapFormat	false	boolean

return type

struct

$file

Public Function $file
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$fileExistsNoCase

Public Function $fileExistsNoCase
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	absolutePath	true	string	null

return type

any

$findRoute

Public Function $findRoute
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$fullCgiDomainString

Public Function $fullCgiDomainString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get full domain string from cgi scope: includes protocol and port
e.g https://www.cfwheels.com:443

arguments

label	name	required	type	default	hint
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

string

$fullDomainString

arguments

label	name	required	type	default	hint
	domain	true	string	null	The string to look at

return type

string

$get

Public Function $get
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from get().

arguments

label	name	required	type	default	hint
	name	true	string	null
	functionName	false	string

return type

any

$getFromCache

Public Function $getFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

any

$getIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

$getRequestTimeout

Public Function $getRequestTimeout
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Returns the request timeout value in seconds

arguments

label

name

required

type

default

hint

return type

numeric

$hashedKey

Public Function $hashedKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Creates a unique string based on any arguments passed in (used as a key for caching mostly).

arguments

label

name

required

type

default

hint

return type

string

$header

Public Function $header
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$htmlhead

Public Function $htmlhead
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$image

Public Function $image
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

struct

$include

Public Function $include
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndOutput

Public Function $includeAndOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndReturnOutput

Public Function $includeAndReturnOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	$template	true	string	null

return type

string

$init

Public Function $init
source: C:\home\pptinc.org\wwwroot\wheels\mapper\initialization.cfm
Internal function.

arguments

label	name	required	type	default	hint
	restful	false	boolean	true
	methods	false	boolean
	mapFormat	false	boolean	true

return type

struct

$initializeRequestScope

Public Function $initializeRequestScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$invoke

Public Function $invoke
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$listClean

Public Function $listClean
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Removes whitespace between list elements.
Optional argument to return the list as an array.

arguments

label	name	required	type	default	hint
	list	true	string	null
	delim	false	string	,
	returnAs	false	string	string

return type

any

$listToStruct

Public Function $listToStruct
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Converts a comma delimted list to a struct

arguments

label	name	required	type	default	hint
	list	true	string	null
	value	false	string	1

return type

struct

$loadPlugins

Public Function $loadPlugins
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$loadRoutes

Public Function $loadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$location

Public Function $location
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	delay	false	boolean	false

return type

void

$lockedLoadRoutes

Public Function $lockedLoadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$mail

Public Function $mail
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$match

Public Function $match
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Internal function.
Match a URL.

arguments

label	name	required	type	default	hint
	name	false	string	null	Name for route. Used for path helpers.
	pattern	false	string	null	Pattern to match for route.
	to	false	string	null	Set controller##action for route.
	methods	false	string	null	HTTP verbs that match route.
	package	false	string	null	Namespace to append to controller.
	on	false	string	null	Created resource route under "member" or "collection".
	constraints	false	struct

return type

struct

$namedArguments

arguments

label	name	required	type	default	hint
	$defined	true	string	null

return type

struct

$normalizePattern

Public Function $normalizePattern
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Internal function.
Force leading slashes, remove trailing and duplicate slashes.

arguments

label	name	required	type	default	hint
	pattern	true	string	null

return type

string

$objectFileName

Public Function $objectFileName
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	objectPath	true	string	null
	type	true	string	null

return type

string

$patternToRegex

Public Function $patternToRegex
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Internal function.
Transform route pattern into regular expression.

arguments

label	name	required	type	default	hint
	pattern	true	string	null
	constraints	false	struct

return type

string

$prependUrl

Public Function $prependUrl
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null

return type

string

$query

Public Function $query
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	sql	true	string	null

return type

any

$removeFromCache

Public Function $removeFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

void

$restoreTestRunnerApplicationScope

Public Function $restoreTestRunnerApplicationScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Restore the application scope modified by the test runner

arguments

label

name

required

type

default

hint

return type

void

$routeVariables

Public Function $routeVariables
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$set

Public Function $set
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from set().

arguments

label

name

required

type

default

hint

return type

void

$setCORSHeaders

Public Function $setCORSHeaders
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Set CORS Headers: only triggered if application.wheels.allowCorsRequests = true

arguments

label	name	required	type	default	hint
	allowOrigin	false	string	*
	allowCredentials	false	string	false
	allowHeaders	false	string	Origin, Content-Type, X-Auth-Token, X-Requested-By, X-Requested-With
	allowMethods	false	string	GET, POST, PATCH, PUT, DELETE, OPTIONS
	allowMethodsByRoute	false	boolean	false
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm

return type

void

$setNamedRoutePositions

Public Function $setNamedRoutePositions
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$simpleLock

Public Function $simpleLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	type	true	string	null
	execute	true	string	null
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$singularizeOrPluralize

Public Function $singularizeOrPluralize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	which	true	string	null
	count	false	numeric	-1
	returnCount	false	boolean	true

return type

string

$statusCode

Public Function $statusCode
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get the status code (e.g. 200, 404 etc) of the response we're about to send.

arguments

label

name

required

type

default

hint

return type

string

$stripRouteVariables

Public Function $stripRouteVariables
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Internal function.
Pull list of variables out of route pattern.

arguments

label	name	required	type	default	hint
	pattern	true	string	null

return type

string

$structKeysExist

Public Function $structKeysExist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Check to see if all keys in the list exist for the structure and have length.

arguments

label	name	required	type	default	hint
	struct	true	struct	null
	keys	false	string

return type

boolean

$throwErrorOrShow404Page

arguments

label	name	required	type	default	hint
	type	true	string	null
	message	true	string	null
	extendedInfo	false	string

return type

void

$timeSpanForCache

Public Function $timeSpanForCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	cache	true	any	null
	defaultCacheTime	false	numeric	60
	cacheDatePart	false	string	n

return type

any

$timestamp

Public Function $timestamp
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	timeStampMode	false	string	utc

return type

string

$toXml

Public Function $toXml
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	data	true	any	null

return type

xml

$wddx

Public Function $wddx
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	input	true	any	null
	action	false	string	cfml2wddx
	useTimeZoneInfo	false	boolean	true

return type

any

$wildcardDomainMatch

Public Function $wildcardDomainMatch
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Wildcard domain match: domain satifies wildcard

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	origin	true	string	null	string to test against e.g bar.foo.com

return type

boolean

$wildcardDomainMatchCGI

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

boolean

$zip

Public Function $zip
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

capitalize

arguments

label	name	required	type	default	hint
	text	true	string	null

return type

string

collection

Public Function collection
source: C:\home\pptinc.org\wwwroot\wheels\mapper\resources.cfm
A collection route doesn't require an id because it acts on a collection of objects.
photos/search is an example of a collection route, because it acts on (and displays) a collection of objects.
[section: Configuration]
[category: Routing]

arguments

label

name

required

type

default

hint

return type

struct

constraints

Public Function constraints
source: C:\home\pptinc.org\wwwroot\wheels\mapper\scoping.cfm
Set variable patterns to use for matching.
[section: Configuration]
[category: Routing]

arguments

label

name

required

type

default

hint

return type

struct

controller

Public Function controller
source: C:\home\pptinc.org\wwwroot\wheels\mapper\scoping.cfm
Considered deprecated as this doesn't conform to RESTful routing principles; Try not to use this.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	controller	true	string	null
	name	false	string
	path	false	string

return type

struct

delete

Public Function delete
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Create a route that matches a URL requiring an HTTP `DELETE` method. We recommend using this matcher to expose actions that delete database records.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	false	string	null	Camel-case name of route to reference when build links and form actions (e.g., `blogPost`).
	pattern	false	string	null	Overrides the URL pattern that will match the route. The default value is a dasherized version of `name` (e.g., a `name` of `blogPost` generates a pattern of `blog-post`).
	to	false	string	null	Set `controller##action` combination to map the route to. You may use either this argument or a combination of `controller` and `action`.
	controller	false	string	null	Map the route to a given controller. This must be passed along with the `action` argument.
	action	false	string	null	Map the route to a given action within the `controller`. This must be passed along with the `controller` argument.
	package	false	string	null	Indicates a subfolder that the controller will be referenced from (but not added to the URL pattern). For example, if you set this to `admin`, the controller will be located at `admin/YourController.cfc`, but the URL path will not contain `admin/`.
	on	false	string	null	If this route is within a nested resource, you can set this argument to `member` or `collection`. A `member` route contains a reference to the resource's `key`, while a `collection` route does not.
	redirect	false	string	null	Redirect via 302 to this URL when this route is matched. Has precedence over controller/action. Use either an absolute link like `/about/`, or a full canonical link.

return type

struct

end

Public Function end
source: C:\home\pptinc.org\wwwroot\wheels\mapper\mapping.cfm
Call this to end a nested routing block or the entire route configuration. This method is chained on a sequence of routing mapper method calls started by `mapper()`.
[section: Configuration]
[category: Routing]

arguments

label

name

required

type

default

hint

return type

struct

flashMessages

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

get

Public Function get
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Create a route that matches a URL requiring an HTTP `GET` method. We recommend only using this matcher to expose actions that display data. See `post`, `patch`, `delete`, and `put` for matchers that are appropriate for actions that change data in your database.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	false	string	null	Camel-case name of route to reference when build links and form actions (e.g., `blogPost`).
	pattern	false	string	null	Overrides the URL pattern that will match the route. The default value is a dasherized version of `name` (e.g., a `name` of `blogPost` generates a pattern of `blog-post`).
	to	false	string	null	Set `controller##action` combination to map the route to. You may use either this argument or a combination of `controller` and `action`.
	controller	false	string	null	Map the route to a given controller. This must be passed along with the `action` argument.
	action	false	string	null	Map the route to a given action within the `controller`. This must be passed along with the `controller` argument.
	package	false	string	null	Indicates a subfolder that the controller will be referenced from (but not added to the URL pattern). For example, if you set this to `admin`, the controller will be located at `admin/YourController.cfc`, but the URL path will not contain `admin/`.
	on	false	string	null	If this route is within a nested resource, you can set this argument to `member` or `collection`. A `member` route contains a reference to the resource's `key`, while a `collection` route does not.
	redirect	false	string	null	Redirect via 302 to this URL when this route is matched. Has precedence over controller/action. Use either an absolute link like `/about/`, or a full canonical link.

return type

struct

humanize

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to humanize.
	except	false	string		A list of strings (space separated) to replace within the output.

return type

string

hyphenize

arguments

label	name	required	type	default	hint
	string	true	string	null	The string to hyphenize.

return type

string

includeReCaptchaJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

insertReCaptchaDiv

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

isValidReCaptcha

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

member

Public Function member
source: C:\home\pptinc.org\wwwroot\wheels\mapper\resources.cfm
Scope routes within a nested resource which require use of the primary key as part of the URL pattern;
A member route will require an ID, because it acts on a member.
photos/1/preview is an example of a member route, because it acts on (and displays) a single object.
[section: Configuration]
[category: Routing]

arguments

label

name

required

type

default

hint

return type

struct

namespace

Public Function namespace
source: C:\home\pptinc.org\wwwroot\wheels\mapper\scoping.cfm
Scopes any the controllers for any routes configured within this block to a subfolder (package) and also adds the package name to the URL.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	true	string	null	Name to prepend to child route names.
	package	false	string		Subfolder (package) to reference for controllers. This defaults to the value provided for `name`.
	path	false	string		Subfolder path to add to the URL.

return type

struct

package

Public Function package
source: C:\home\pptinc.org\wwwroot\wheels\mapper\scoping.cfm
Scopes any the controllers for any routes configured within this block to a subfolder (package) without adding the package name to the URL.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	true	string	null	Name to prepend to child route names.
	package	false	string		Subfolder (package) to reference for controllers. This defaults to the value provided for `name`.

return type

struct

patch

Public Function patch
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Create a route that matches a URL requiring an HTTP `PATCH` method. We recommend using this matcher to expose actions that update database records.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	false	string	null	Camel-case name of route to reference when build links and form actions (e.g., `blogPost`).
	pattern	false	string	null	Overrides the URL pattern that will match the route. The default value is a dasherized version of `name` (e.g., a `name` of `blogPost` generates a pattern of `blog-post`).
	to	false	string	null	Set `controller##action` combination to map the route to. You may use either this argument or a combination of `controller` and `action`.
	controller	false	string	null	Map the route to a given controller. This must be passed along with the `action` argument.
	action	false	string	null	Map the route to a given action within the `controller`. This must be passed along with the `controller` argument.
	package	false	string	null	Indicates a subfolder that the controller will be referenced from (but not added to the URL pattern). For example, if you set this to `admin`, the controller will be located at `admin/YourController.cfc`, but the URL path will not contain `admin/`.
	on	false	string	null	If this route is within a nested resource, you can set this argument to `member` or `collection`. A `member` route contains a reference to the resource's `key`, while a `collection` route does not.
	redirect	false	string	null	Redirect via 302 to this URL when this route is matched. Has precedence over controller/action. Use either an absolute link like `/about/`, or a full canonical link.

return type

struct

pluralize

arguments

label	name	required	type	default	hint
	word	true	string	null	The word to pluralize.
	count	false	numeric	-1	Pluralization will occur when this value is not 1.
	returnCount	false	boolean	true	Will return count prepended to the pluralization when true and count is not -1.

return type

string

post

Public Function post
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Create a route that matches a URL requiring an HTTP `POST` method. We recommend using this matcher to expose actions that create database records.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	false	string	null	Camel-case name of route to reference when build links and form actions (e.g., `blogPosts`).
	pattern	false	string	null	Overrides the URL pattern that will match the route. The default value is a dasherized version of `name` (e.g., a `name` of `blogPosts` generates a pattern of `blog-posts`).
	to	false	string	null	Set `controller##action` combination to map the route to. You may use either this argument or a combination of `controller` and `action`.
	controller	false	string	null	Map the route to a given controller. This must be passed along with the `action` argument.
	action	false	string	null	Map the route to a given action within the `controller`. This must be passed along with the `controller` argument.
	package	false	string	null	Indicates a subfolder that the controller will be referenced from (but not added to the URL pattern). For example, if you set this to `admin`, the controller will be located at `admin/YourController.cfc`, but the URL path will not contain `admin/`.
	on	false	string	null	If this route is within a nested resource, you can set this argument to `member` or `collection`. A `member` route contains a reference to the resource's `key`, while a `collection` route does not.
	redirect	false	string	null	Redirect via 302 to this URL when this route is matched. Has precedence over controller/action. Use either an absolute link like `/about/`, or a full canonical link.

return type

struct

put

Public Function put
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Create a route that matches a URL requiring an HTTP `PUT` method. We recommend using this matcher to expose actions that update database records. This method is provided as a convenience for when you really need to support the `PUT` verb; consider using the `patch` matcher instead of this one.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	false	string	null	Camel-case name of route to reference when build links and form actions (e.g., `blogPost`).
	pattern	false	string	null	Overrides the URL pattern that will match the route. The default value is a dasherized version of `name` (e.g., a `name` of `blogPost` generates a pattern of `blog-post`).
	to	false	string	null	Set `controller##action` combination to map the route to. You may use either this argument or a combination of `controller` and `action`.
	controller	false	string	null	Map the route to a given controller. This must be passed along with the `action` argument.
	action	false	string	null	Map the route to a given action within the `controller`. This must be passed along with the `controller` argument.
	package	false	string	null	Indicates a subfolder that the controller will be referenced from (but not added to the URL pattern). For example, if you set this to `admin`, the controller will be located at `admin/YourController.cfc`, but the URL path will not contain `admin/`.
	on	false	string	null	If this route is within a nested resource, you can set this argument to `member` or `collection`. A `member` route contains a reference to the resource's `key`, while a `collection` route does not.
	redirect	false	string	null	Redirect via 302 to this URL when this route is matched. Has precedence over controller/action. Use either an absolute link like `/about/`, or a full canonical link.

return type

struct

resource

Public Function resource
source: C:\home\pptinc.org\wwwroot\wheels\mapper\resources.cfm
Create a group of routes that exposes actions for manipulating a singular resource. A singular resource exposes URL patterns for the entire CRUD lifecycle of a single entity (`show`, `new`, `create`, `edit`, `update`, and `delete`) without exposing a primary key in the URL. Usually this type of resource represents a singleton entity tied to the session, application, or another resource (perhaps nested within another resource). If you need to generate routes for manipulating a collection of resources with a primary key in the URL, see the `resources` mapper method.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	true	string	null	Camel-case name of resource to reference when build links and form actions. This is typically a singular word (e.g., `profile`).
	nested	false	boolean	false	Whether or not additional calls will be nested within this resource.
	path	false	string		Override URL path representing this resource. Default is a dasherized version of `name` (e.g., `blogPost` generates a path of `blog-post`).
	controller	false	string	null	Override name of the controller used by resource. This defaults to a pluralized version of `name`.
	singular	false	string	null	Override singularize() result in plural resources.
	plural	false	string	null	Override pluralize() result in singular resource.
	only	false	string	null	Limits the list of RESTful routes to generate. Can include `show`, `new`, `create`, `edit`, `update`, and `delete`.
	except	false	string	null	Excludes RESTful routes to generate, taking priority over the `only` argument. Can include `show`, `new`, `create`, `edit,` `update`, and `delete`.
	shallow	false	boolean	null	Turn on shallow resources.
	shallowPath	false	string	null	Shallow path prefix.
	shallowName	false	string	null	Shallow name prefix.
	constraints	false	struct	null	Variable patterns to use for matching.
	$call	false	string	resource
	$plural	false	boolean	false
	mapFormat	false	boolean		Whether or not to add an optional `.[format]` pattern to the end of the generated routes. This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc.

return type

struct

resources

Public Function resources
source: C:\home\pptinc.org\wwwroot\wheels\mapper\resources.cfm
Create a group of routes that exposes actions for manipulating a collection of resources. A plural resource exposes URL patterns for the entire CRUD lifecycle (`index`, `show`, `new`, `create`, `edit`, `update`, `delete`), exposing a primary key in the URL for showing, editing, updating, and deleting records. If you need to generate routes for manipulating a singular resource without a primary key, see the `resource` mapper method.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	true	string	null	Camel-case name of resource to reference when build links and form actions. This is typically a plural word (e.g., `posts`).
	nested	false	boolean	false	Whether or not additional calls will be nested within this resource.
	path	false	string		Override URL path representing this resource. Default is a dasherized version of `name` (e.g., `blogPosts` generates a path of `blog-posts`).
	controller	false	string	null	Override name of the controller used by resource. This defaults to the value provided for `name`.
	singular	false	string	null	Override singularize() result in plural resources.
	plural	false	string	null	Override pluralize() result in singular resource.
	only	false	string	null	Limits the list of RESTful routes to generate. Can include `index`, `show`, `new`, `create`, `edit`, `update`, and `delete`.
	except	false	string	null	Excludes RESTful routes to generate, taking priority over the `only` argument. Can include `index`, `show`, `new`, `create`, `edit`, `update`, and `delete`.
	shallow	false	boolean	null	Turn on shallow resources.
	shallowPath	false	string	null	Shallow path prefix.
	shallowName	false	string	null	Shallow name prefix.
	constraints	false	struct	null	Variable patterns to use for matching.
	mapFormat	false	boolean		Whether or not to add an optional `.[format]` pattern to the end of the generated routes. This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc.

return type

struct

root

Public Function root
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Create a route that matches the root of its current context. This mapper can be used for the application's web root (or home page), or it can generate a route for the root of a namespace or other path scoping mapper.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	to	false	string	null	Set `controller##action` combination to map the route to. You may use either this argument or a combination of `controller` and `action`.
	mapFormat	false	boolean	null	Set to `true` to include the format (e.g. `.json`) in the route.

return type

struct

scope

Public Function scope
source: C:\home\pptinc.org\wwwroot\wheels\mapper\scoping.cfm
Set any number of parameters to be inherited by mappers called within this matcher's block. For example, set a package or URL path to be used by all child routes.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	name	false	string	null	Name to prepend to child route names for use when building links, forms, and other URLs.
	path	false	string	null	Path to prefix to all child routes.
	package	false	string	null	Package namespace to append to controllers.
	controller	false	string	null	Controller to use for routes.
	shallow	false	boolean	null	Turn on shallow resources to eliminate routing added before this one.
	shallowPath	false	string	null	Shallow path prefix.
	shallowName	false	string	null	Shallow name prefix.
	constraints	false	struct	null	Variable patterns to use for matching.
	$call	false	string	scope

return type

struct

singularize

Public Function singularize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns the singular form of the passed in word.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null

return type

string

titleize

arguments

label	name	required	type	default	hint
	word	true	string	null	The text to turn into a title.

return type

string

wildcard

Public Function wildcard
source: C:\home\pptinc.org\wwwroot\wheels\mapper\matching.cfm
Special wildcard matching generates routes with `[controller]/[action]` and `[controller]` patterns. The `mapKey` argument also enables a `[controller]/[action]/[key]` pattern as well.
[section: Configuration]
[category: Routing]

arguments

label	name	required	type	default	hint
	method	false	string	get	List of HTTP methods (verbs) to generate the wildcard routes for. We strongly recommend leaving the default value of `get` and using other routing mappers if you need to `POST` to a URL endpoint. For better readability, you can also pass this argument as `methods` if you're listing multiple methods.
	action	false	string	index	Default action to specify if the value for the `[action]` placeholder is not provided.
	mapKey	false	boolean	false	Whether or not to enable a `[key]` matcher, enabling a `[controller]/[action]/[key]` pattern.
	mapFormat	false	boolean	false	Whether or not to add an optional `.[format]` pattern to the end of the generated routes. This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc.

return type

struct

private

$addRoute

Private Function $addRoute
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.
Add route to Wheels, removing useless params.

arguments

label	name	required	type	default	hint
	pattern	true	string	null
	constraints	true	struct	null

return type

void

$checkMinimumVersion

Private Function $checkMinimumVersion
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm

arguments

label	name	required	type	default	hint
	engine	true	string	null
	version	true	string	null

return type

string

$collection

Private Function $collection
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.
Get collection name if defined.

arguments

label

name

required

type

default

hint

return type

string

$member

Private Function $member
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.
Get member name if defined.

arguments

label

name

required

type

default

hint

return type

string

$resetScopeStack

Private Function $resetScopeStack
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.

arguments

label

name

required

type

default

hint

return type

void

$scopeName

Private Function $scopeName
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.
Get scoped route name if defined.

arguments

label

name

required

type

default

hint

return type

string

$shallow

Private Function $shallow
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.
See if resource is shallow.

arguments

label

name

required

type

default

hint

return type

boolean

$shallowName

Private Function $shallowName
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.
Get scoped shallow route name if defined.

arguments

label

name

required

type

default

hint

return type

string

$shallowNameForCall

Private Function $shallowNameForCall
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.

arguments

label

name

required

type

default

hint

return type

string

$shallowPath

Private Function $shallowPath
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.
Get scoped shallow path if defined.

arguments

label

name

required

type

default

hint

return type

string

$shallowPathForCall

Private Function $shallowPathForCall
source: C:\home\pptinc.org\wwwroot\wheels\mapper\utilities.cfm
Private internal function.

arguments

label

name

required

type

default

hint

return type

string

MAXIMUMITEMSTOCACHE

number

5000

MIGRATOR

Component (wheels.Migrator)
Only the functions and data members that are accessible from your location are displayed

this

public

$abortInvalidRequest

Public Function $abortInvalidRequest
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$addToCache

Public Function $addToCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	value	true	any	null
	time	false	numeric	60
	category	false	string	main

return type

void

$appKey

Public Function $appKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$args

Public Function $args
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	name	true	string	null
	reserved	false	string
	combine	false	string
	required	false	string

return type

void

$buildReleaseZip

Public Function $buildReleaseZip
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
NB: url rewriting files need to be removed from here.

arguments

label	name	required	type	default	hint
	version	false	string	2.5.0
	directory	false	string	C:\home\pptinc.org\wwwroot\

return type

string

$cache

Public Function $cache
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$cacheCount

Public Function $cacheCount
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

numeric

$cachedControllerClassExists

Public Function $cachedControllerClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cachedModelClassExists

Public Function $cachedModelClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$canonicalize

Public Function $canonicalize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Call CFML's canonicalize() function but set to blank string if the result is null (happens on Lucee 5).

arguments

label	name	required	type	default	hint
	input	true	string	null

return type

string

$cgiScope

Public Function $cgiScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
This copies all the variables CFWheels needs from the CGI scope to the request scope.

arguments

label	name	required	type	default	hint
	keys	false	string	request_method,http_x_requested_with,http_referer,server_name,path_info,script_name,query_string,remote_addr,server_port,server_port_secure,server_protocol,http_host,http_accept,content_type,http_x_rewrite_url,http_x_original_url,request_uri,redirect_url,http_x_forwarded_for,http_x_forwarded_proto
	scope	false	struct

return type

struct

$cleanInlist

Public Function $cleanInlist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	where	true	string	null

return type

any

$clearCache

Public Function $clearCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

void

$clearControllerInitializationCache

Public Function $clearControllerInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$clearModelInitializationCache

Public Function $clearModelInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$combineArguments

Public Function $combineArguments
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	combine	true	string	null
	required	true	boolean	false
	extendedInfo	false	string

return type

void

$constructParams

Public Function $constructParams
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	true	string	null
	encode	false	boolean	true
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

$content

Public Function $content
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$contentType

arguments

label

name

required

type

default

hint

return type

string

$convertToString

Public Function $convertToString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	any	null
	type	false	string

return type

string

$createControllerClass

Public Function $createControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	controllerPaths	false	string
	type	false	string	controller

return type

any

$createModelClass

Public Function $createModelClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	modelPaths	false	string	models
	type	false	string	model

return type

any

$createObjectFromRoot

Public Function $createObjectFromRoot
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null
	fileName	true	string	null
	method	true	string	null

return type

any

$dbinfo

Public Function $dbinfo
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$debugPoint

Public Function $debugPoint
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

void

$directory

Public Function $directory
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$dollarify

Public Function $dollarify
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	input	true	struct	null
	on	true	string	null

return type

struct

$doubleCheckedLock

Public Function $doubleCheckedLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	condition	true	string	null
	execute	true	string	null
	conditionArgs	false	struct
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$file

Public Function $file
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$fileExistsNoCase

Public Function $fileExistsNoCase
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	absolutePath	true	string	null

return type

any

$findRoute

Public Function $findRoute
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$fullCgiDomainString

Public Function $fullCgiDomainString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get full domain string from cgi scope: includes protocol and port
e.g https://www.cfwheels.com:443

arguments

label	name	required	type	default	hint
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

string

$fullDomainString

arguments

label	name	required	type	default	hint
	domain	true	string	null	The string to look at

return type

string

$get

Public Function $get
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from get().

arguments

label	name	required	type	default	hint
	name	true	string	null
	functionName	false	string

return type

any

$getFromCache

Public Function $getFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

any

$getNextMigrationNumber

Public Function $getNextMigrationNumber
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Returns the next migration.

arguments

label	name	required	type	default	hint
	migrationPrefix	false	string

return type

string

$getRequestTimeout

Public Function $getRequestTimeout
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Returns the request timeout value in seconds

arguments

label

name

required

type

default

hint

return type

numeric

$hashedKey

Public Function $hashedKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Creates a unique string based on any arguments passed in (used as a key for caching mostly).

arguments

label

name

required

type

default

hint

return type

string

$header

Public Function $header
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$htmlhead

Public Function $htmlhead
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$image

Public Function $image
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

struct

$include

Public Function $include
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndOutput

Public Function $includeAndOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndReturnOutput

Public Function $includeAndReturnOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	$template	true	string	null

return type

string

$initializeRequestScope

Public Function $initializeRequestScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$invoke

Public Function $invoke
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$listClean

Public Function $listClean
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Removes whitespace between list elements.
Optional argument to return the list as an array.

arguments

label	name	required	type	default	hint
	list	true	string	null
	delim	false	string	,
	returnAs	false	string	string

return type

any

$listToStruct

Public Function $listToStruct
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Converts a comma delimted list to a struct

arguments

label	name	required	type	default	hint
	list	true	string	null
	value	false	string	1

return type

struct

$loadPlugins

Public Function $loadPlugins
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$loadRoutes

Public Function $loadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$location

Public Function $location
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	delay	false	boolean	false

return type

void

$lockedLoadRoutes

Public Function $lockedLoadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$mail

Public Function $mail
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$namedArguments

arguments

label	name	required	type	default	hint
	$defined	true	string	null

return type

struct

$objectFileName

Public Function $objectFileName
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	objectPath	true	string	null
	type	true	string	null

return type

string

$prependUrl

Public Function $prependUrl
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null

return type

string

$query

Public Function $query
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	sql	true	string	null

return type

any

$removeFromCache

Public Function $removeFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

void

$restoreTestRunnerApplicationScope

Public Function $restoreTestRunnerApplicationScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Restore the application scope modified by the test runner

arguments

label

name

required

type

default

hint

return type

void

$routeVariables

Public Function $routeVariables
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$set

Public Function $set
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from set().

arguments

label

name

required

type

default

hint

return type

void

$setCORSHeaders

Public Function $setCORSHeaders
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Set CORS Headers: only triggered if application.wheels.allowCorsRequests = true

arguments

label	name	required	type	default	hint
	allowOrigin	false	string	*
	allowCredentials	false	string	false
	allowHeaders	false	string	Origin, Content-Type, X-Auth-Token, X-Requested-By, X-Requested-With
	allowMethods	false	string	GET, POST, PATCH, PUT, DELETE, OPTIONS
	allowMethodsByRoute	false	boolean	false
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm

return type

void

$setNamedRoutePositions

Public Function $setNamedRoutePositions
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$simpleLock

Public Function $simpleLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	type	true	string	null
	execute	true	string	null
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$singularizeOrPluralize

Public Function $singularizeOrPluralize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	which	true	string	null
	count	false	numeric	-1
	returnCount	false	boolean	true

return type

string

$statusCode

Public Function $statusCode
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get the status code (e.g. 200, 404 etc) of the response we're about to send.

arguments

label

name

required

type

default

hint

return type

string

$structKeysExist

Public Function $structKeysExist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Check to see if all keys in the list exist for the structure and have length.

arguments

label	name	required	type	default	hint
	struct	true	struct	null
	keys	false	string

return type

boolean

$throwErrorOrShow404Page

arguments

label	name	required	type	default	hint
	type	true	string	null
	message	true	string	null
	extendedInfo	false	string

return type

void

$timeSpanForCache

Public Function $timeSpanForCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	cache	true	any	null
	defaultCacheTime	false	numeric	60
	cacheDatePart	false	string	n

return type

any

$timestamp

Public Function $timestamp
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	timeStampMode	false	string	utc

return type

string

$toXml

Public Function $toXml
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	data	true	any	null

return type

xml

$wddx

Public Function $wddx
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	input	true	any	null
	action	false	string	cfml2wddx
	useTimeZoneInfo	false	boolean	true

return type

any

$wildcardDomainMatch

Public Function $wildcardDomainMatch
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Wildcard domain match: domain satifies wildcard

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	origin	true	string	null	string to test against e.g bar.foo.com

return type

boolean

$wildcardDomainMatchCGI

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

boolean

$zip

Public Function $zip
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

addFormat

arguments

label	name	required	type	default	hint
	extension	true	string	null	File extension to add.
	mimeType	true	string	null	Matching MIME type to associate with the file extension.

return type

void

capitalize

arguments

label	name	required	type	default	hint
	text	true	string	null

return type

string

controller

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the controller to create.
	params	false	struct		The params struct (combination of form and URL variables).

return type

any

createMigration

Public Function createMigration
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Creates a migration file. Whilst you can use this in your application, the recommended useage is via either the CLI or the provided GUI interface
[section: Migrator]
[category: General Functions]

arguments

label	name	required	type	default	hint
	migrationName	true	string	null
	templateName	false	string
	migrationPrefix	false	string	timestamp

return type

string

deobfuscateParam

Public Function deobfuscateParam
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Deobfuscates a value.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	param	true	string	null	The value to deobfuscate.

return type

string

distanceOfTimeInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.

return type

string

excerpt

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to extract an excerpt from.
	phrase	true	string	null	The phrase to extract.
	radius	false	numeric	null	Number of characters to extract surrounding the phrase.
	excerptString	false	string	null	String to replace first and / or last characters with.

return type

string

get

arguments

label	name	required	type	default	hint
	name	true	string	null	Variable name to get setting for.
	functionName	false	string		Function name to get setting for.

return type

any

getAvailableMigrations

Public Function getAvailableMigrations
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Searches db/migrate folder for migrations. Whilst you can use this in your application, the recommended useage is via either the CLI or the provided GUI interface
[section: Migrator]
[category: General Functions]

arguments

label	name	required	type	default	hint
	path	false	string		Path to Migration Files: defaults to /migrator/migrations/

return type

array

getCurrentMigrationVersion

Public Function getCurrentMigrationVersion
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Returns current database version. Whilst you can use this in your application, the recommended useage is via either the CLI or the provided GUI interface
[section: Migrator]
[category: General Functions]

arguments

label

name

required

type

default

hint

return type

string

humanize

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to humanize.
	except	false	string		A list of strings (space separated) to replace within the output.

return type

string

hyphenize

arguments

label	name	required	type	default	hint
	string	true	string	null	The string to hyphenize.

return type

string

init

Public Function init
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Configure and return migrator object. Now uses /app mapping

arguments

label	name	required	type	default	hint
	migratePath	false	string	/app/migrator/migrations/
	sqlPath	false	string	/app/migrator/sql/
	templatePath	false	string	/wheels/migrator/templates/

return type

struct

mapper

arguments

label	name	required	type	default	hint
	restful	false	boolean	true	Whether to turn on RESTful routing or not. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	methods	false	boolean		If not RESTful, then specify allowed routes. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	mapFormat	false	boolean	true	This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc. Set to false to disable automatic .[format] generation for resource based routes

return type

struct

migrateTo

Public Function migrateTo
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Migrates database to a specified version. Whilst you can use this in your application, the recommended useage is via either the CLI or the provided GUI interface
[section: Migrator]
[category: General Functions]

arguments

label	name	required	type	default	hint
	version	false	string		The Database schema version to migrate to

return type

string

migrateToLatest

Public Function migrateToLatest
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Shortcut function to migrate to the latest version
[section: Migrator]
[category: General Functions]

arguments

label

name

required

type

default

hint

return type

string

mimeTypes

arguments

label	name	required	type	default	hint
	extension	true	string	null	The extension to get the MIME type for.
	fallback	false	string	application/octet-stream	The fallback MIME type to return.

return type

string

model

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the model to get a reference to.

return type

any

obfuscateParam

arguments

label	name	required	type	default	hint
	param	true	any	null	The value to obfuscate.

return type

string

pagination

arguments

label	name	required	type	default	hint
	handle	false	string	query	The handle given to the query to return pagination information for.

return type

struct

PATHS

Struct

MIGRATE

string

C:\home\pptinc.org\wwwroot\migrator\migrations\

MIGRATECOMPONENTS

string

app.migrator.migrations

SQL

string

C:\home\pptinc.org\wwwroot\migrator\sql\

TEMPLATES

string

C:\home\pptinc.org\wwwroot\wheels\migrator\templates\

pluginNames

arguments

label

name

required

type

default

hint

return type

string

pluralize

arguments

label	name	required	type	default	hint
	word	true	string	null	The word to pluralize.
	count	false	numeric	-1	Pluralization will occur when this value is not 1.
	returnCount	false	boolean	true	Will return count prepended to the pluralization when true and count is not -1.

return type

string

processRequest

arguments

label	name	required	type	default	hint
	params	true	struct	null	The params struct to use in the request (make sure that at least `controller` and `action` are set).
	method	false	string	null	The HTTP method to use in the request (`get`, `post` etc).
	returnAs	false	string	null	Pass in `struct` to return all information about the request instead of just the final output (`body`).
	rollback	false	string	null	Pass in `true` to roll back all database transactions made during the request.
	includeFilters	false	string	true	Set to `before` to only execute "before" filters, `after` to only execute "after" filters or `false` to skip all filters.

return type

any

redoMigration

Public Function redoMigration
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Reruns the specified migration version. Whilst you can use this in your application, the recommended useage is via either the CLI or the provided GUI interface
[section: Migrator]
[category: General Functions]

arguments

label	name	required	type	default	hint
	version	false	string		The Database schema version to rerun

return type

string

set

arguments

label

name

required

type

default

hint

return type

void

setPagination

arguments

label	name	required	type	default	hint
	totalRecords	true	numeric	null	Total count of records that should be represented by the paginated links.
	currentPage	false	numeric	1	Page number that should be represented by the data being fetched and the paginated links.
	perPage	false	numeric	25	Number of records that should be represented on each page of data.
	handle	false	string	query	Name of handle to reference in `paginationLinks`.

return type

void

singularize

Public Function singularize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns the singular form of the passed in word.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null

return type

string

timeAgoInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	toTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare to.

return type

any

timeUntilInWords

arguments

label	name	required	type	default	hint
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	fromTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare from.

return type

string

titleize

arguments

label	name	required	type	default	hint
	word	true	string	null	The text to turn into a title.

return type

string

truncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Length to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

URLFor

Public Function URLFor
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Creates an internal URL based on supplied arguments.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: `wheels=cool&x=y`). Please note that CFWheels uses the `&` and `=` characters to split the parameters and encode them properly for you. However, if you need to pass in `&` or `=` as part of the value, then you need to encode them (and only them), example: `a=cats%26dogs%3Dtrouble!&b=1`.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If `true`, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	encode	false	boolean	null	Encode URL parameters using `EncodeForURL()`. Please note that this does not make the string safe for placement in HTML attributes, for that you need to wrap the result in `EncodeForHtmlAttribute()` or use `linkTo()`, `startFormTag()` etc instead.
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

wordTruncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Number of words to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

private

$checkMinimumVersion

Private Function $checkMinimumVersion
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm

arguments

label	name	required	type	default	hint
	engine	true	string	null
	version	true	string	null

return type

string

$copyTemplateMigrationAndRename

Private Function $copyTemplateMigrationAndRename
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Creates a migration file based on a template.

arguments

label	name	required	type	default	hint
	migrationName	true	string	null
	templateName	true	string	null
	migrationPrefix	false	string

return type

string

$getVersionsPreviouslyMigrated

Private Function $getVersionsPreviouslyMigrated
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Returns previously migrated versions as a list.

arguments

label

name

required

type

default

hint

return type

string

$removeVersionAsMigrated

Private Function $removeVersionAsMigrated
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Deletes a record to flag a version as not migrated.

arguments

label	name	required	type	default	hint
	version	true	string	null

return type

void

$sanitiseVersion

Private Function $sanitiseVersion
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Ensures a version as user input is numeric.

arguments

label	name	required	type	default	hint
	version	true	string	null

return type

string

$setVersionAsMigrated

Private Function $setVersionAsMigrated
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Inserts a record to flag a version as migrated.

arguments

label	name	required	type	default	hint
	version	true	string	null

return type

void

$writeMigrationFile

Private Function $writeMigrationFile
source: C:\home\pptinc.org\wwwroot\wheels\migrator\functions.cfm
Writes a migration file

arguments

label	name	required	type	default	hint
	filePath	true	string	null
	data	true	string	null

return type

void

MIGRATOROBJECTCASE

string

lower

MIGRATORTABLENAME

string

migratorversions

MIMETYPES

Struct
Entries: 16

DOC

string

application/word

DOCX

string

application/word

GIF

string

image/gif

JPEG

string

image/jpg

JPG

string

image/jpg

MP3

string

audio/mpeg3

PDF

string

application/pdf

PJPEG

string

image/jpg

PNG

string

image/png

PPT

string

application/powerpoint

PPTX

string

application/powerpoint

TXT

string

text/plain

WAV

string

audio/wav

XLS

string

application/excel

XLSX

string

application/excel

ZIP

string

application/zip

MIXINS

Struct
Entries: 11

application

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

base

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

controller

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

dispatch

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

mapper

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

model

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

mysql

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

postgresql

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

sqlserver

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

test

Struct

$GETIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

FLASHMESSAGES

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

INCLUDERECAPTCHAJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

INSERTRECAPTCHADIV

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

ISVALIDRECAPTCHA

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

MODELPATH

string

models

MODELREQUIRECONFIG

boolean

false

MODELS

Struct

NAMEDROUTEPOSITIONS

Struct
Entries: 30

about

string

concrete

string

contact

string

30,31

faq

string

foundation

string

home

string

jobs

string

28,29

pier

string

postTension

string

root

string

turnKey

string

wheelsBuild

string

wheelsCli

string

wheelsDocs

string

wheelsInfo

string

wheelsLegacy

string

wheelsMigrator

string

wheelsMigratorCommand

string

wheelsMigratorSQL

string

wheelsMigratorTemplates

string

wheelsMigratorTemplatesCreate

string

wheelsPackages

string

wheelsPluginEntry

string

wheelsPluginPost

string

wheelsPlugins

string

wheelsRoot

string

wheelsRoutes

string

wheelsRouteTester

string

wheelsTests

string

work

string

NONEXISTINGHELPERFILES

string

Pages,Services

NONEXISTINGLAYOUTFILES

string

Pages,Services

NONEXISTINGOBJECTFILES

string

OBFUSCATEURLS

boolean

false

OVERWRITEPLUGINS

boolean

true

PLUGINCOMPONENTPATH

string

plugins

PLUGINMETA

Struct

flashMessages

Struct

boxjson

Struct

version

string

reCaptcha

Struct

boxjson

Struct

version

string

PLUGINOBJ

Component (wheels.Plugins)
Only the functions and data members that are accessible from your location are displayed

this

public

$abortInvalidRequest

Public Function $abortInvalidRequest
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$addToCache

Public Function $addToCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	value	true	any	null
	time	false	numeric	60
	category	false	string	main

return type

void

$appKey

Public Function $appKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$args

Public Function $args
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	name	true	string	null
	reserved	false	string
	combine	false	string
	required	false	string

return type

void

$buildReleaseZip

Public Function $buildReleaseZip
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
NB: url rewriting files need to be removed from here.

arguments

label	name	required	type	default	hint
	version	false	string	2.5.0
	directory	false	string	C:\home\pptinc.org\wwwroot\

return type

string

$cache

Public Function $cache
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$cacheCount

Public Function $cacheCount
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

numeric

$cachedControllerClassExists

Public Function $cachedControllerClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$cachedModelClassExists

Public Function $cachedModelClassExists
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

any

$canonicalize

Public Function $canonicalize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Call CFML's canonicalize() function but set to blank string if the result is null (happens on Lucee 5).

arguments

label	name	required	type	default	hint
	input	true	string	null

return type

string

$cgiScope

Public Function $cgiScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
This copies all the variables CFWheels needs from the CGI scope to the request scope.

arguments

label	name	required	type	default	hint
	keys	false	string	request_method,http_x_requested_with,http_referer,server_name,path_info,script_name,query_string,remote_addr,server_port,server_port_secure,server_protocol,http_host,http_accept,content_type,http_x_rewrite_url,http_x_original_url,request_uri,redirect_url,http_x_forwarded_for,http_x_forwarded_proto
	scope	false	struct

return type

struct

$cleanInlist

Public Function $cleanInlist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	where	true	string	null

return type

any

$clearCache

Public Function $clearCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	category	false	string

return type

void

$clearControllerInitializationCache

Public Function $clearControllerInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$clearModelInitializationCache

Public Function $clearModelInitializationCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$combineArguments

Public Function $combineArguments
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	args	true	struct	null
	combine	true	string	null
	required	true	boolean	false
	extendedInfo	false	string

return type

void

$componentPathToPlugin

Public Function $componentPathToPlugin
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label	name	required	type	default	hint
	folder	true	string	null
	file	true	string	null

return type

string

$constructParams

Public Function $constructParams
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	params	true	string	null
	encode	false	boolean	true
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

$content

Public Function $content
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$contentType

arguments

label

name

required

type

default

hint

return type

string

$convertToString

Public Function $convertToString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	value	true	any	null
	type	false	string

return type

string

$createControllerClass

Public Function $createControllerClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	controllerPaths	false	string
	type	false	string	controller

return type

any

$createModelClass

Public Function $createModelClass
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	modelPaths	false	string	models
	type	false	string	model

return type

any

$createObjectFromRoot

Public Function $createObjectFromRoot
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null
	fileName	true	string	null
	method	true	string	null

return type

any

$dbinfo

Public Function $dbinfo
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$debugPoint

Public Function $debugPoint
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null

return type

void

$determineDependency

Public Function $determineDependency
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

void

$directory

Public Function $directory
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$dollarify

Public Function $dollarify
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	input	true	struct	null
	on	true	string	null

return type

struct

$doubleCheckedLock

Public Function $doubleCheckedLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	condition	true	string	null
	execute	true	string	null
	conditionArgs	false	struct
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$file

Public Function $file
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$fileExistsNoCase

Public Function $fileExistsNoCase
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	absolutePath	true	string	null

return type

any

$files

Public Function $files
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

query

$findRoute

Public Function $findRoute
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

struct

$folders

Public Function $folders
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

query

$fullCgiDomainString

Public Function $fullCgiDomainString
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get full domain string from cgi scope: includes protocol and port
e.g https://www.cfwheels.com:443

arguments

label	name	required	type	default	hint
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

string

$fullDomainString

arguments

label	name	required	type	default	hint
	domain	true	string	null	The string to look at

return type

string

$fullPathToPlugin

Public Function $fullPathToPlugin
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm
PRIVATE

arguments

label	name	required	type	default	hint
	folder	true	string	null

return type

string

$get

Public Function $get
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from get().

arguments

label	name	required	type	default	hint
	name	true	string	null
	functionName	false	string

return type

any

$getFromCache

Public Function $getFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

any

$getRequestTimeout

Public Function $getRequestTimeout
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Returns the request timeout value in seconds

arguments

label

name

required

type

default

hint

return type

numeric

$hashedKey

Public Function $hashedKey
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Creates a unique string based on any arguments passed in (used as a key for caching mostly).

arguments

label

name

required

type

default

hint

return type

string

$header

Public Function $header
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$htmlhead

Public Function $htmlhead
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$image

Public Function $image
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

struct

$include

Public Function $include
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndOutput

Public Function $includeAndOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	template	true	string	null

return type

void

$includeAndReturnOutput

Public Function $includeAndReturnOutput
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	$template	true	string	null

return type

string

$initializeRequestScope

Public Function $initializeRequestScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$invoke

Public Function $invoke
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

$listClean

Public Function $listClean
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Removes whitespace between list elements.
Optional argument to return the list as an array.

arguments

label	name	required	type	default	hint
	list	true	string	null
	delim	false	string	,
	returnAs	false	string	string

return type

any

$listToStruct

Public Function $listToStruct
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Converts a comma delimted list to a struct

arguments

label	name	required	type	default	hint
	list	true	string	null
	value	false	string	1

return type

struct

$loadPlugins

Public Function $loadPlugins
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$loadRoutes

Public Function $loadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$location

Public Function $location
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	delay	false	boolean	false

return type

void

$lockedLoadRoutes

Public Function $lockedLoadRoutes
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$mail

Public Function $mail
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

void

$namedArguments

arguments

label	name	required	type	default	hint
	$defined	true	string	null

return type

struct

$objectFileName

Public Function $objectFileName
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	name	true	string	null
	objectPath	true	string	null
	type	true	string	null

return type

string

$pluginDelete

Public Function $pluginDelete
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

void

$pluginFiles

Public Function $pluginFiles
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

struct

$pluginFolders

Public Function $pluginFolders
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

struct

$pluginMetaData

Public Function $pluginMetaData
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm
Attempt to extract version numbers from box.json and/or corresponding .zip files
Storing box.json data too as this may be useful later

arguments

label

name

required

type

default

hint

return type

void

$pluginsExtract

Public Function $pluginsExtract
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

void

$pluginsProcess

Public Function $pluginsProcess
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

void

$prependUrl

Public Function $prependUrl
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	path	true	string	null

return type

string

$processMixins

Public Function $processMixins
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm
MIXINS

arguments

label

name

required

type

default

hint

return type

void

$query

Public Function $query
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	sql	true	string	null

return type

any

$removeFromCache

Public Function $removeFromCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	key	true	string	null
	category	false	string	main

return type

void

$restoreTestRunnerApplicationScope

Public Function $restoreTestRunnerApplicationScope
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Restore the application scope modified by the test runner

arguments

label

name

required

type

default

hint

return type

void

$routeVariables

Public Function $routeVariables
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

string

$set

Public Function $set
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Internal function.
Called from set().

arguments

label

name

required

type

default

hint

return type

void

$setCORSHeaders

Public Function $setCORSHeaders
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Set CORS Headers: only triggered if application.wheels.allowCorsRequests = true

arguments

label	name	required	type	default	hint
	allowOrigin	false	string	*
	allowCredentials	false	string	false
	allowHeaders	false	string	Origin, Content-Type, X-Auth-Token, X-Requested-By, X-Requested-With
	allowMethods	false	string	GET, POST, PATCH, PUT, DELETE, OPTIONS
	allowMethodsByRoute	false	boolean	false
	pathInfo	false	string	/services/pier-drilling
	scriptName	false	string	/rewrite.cfm

return type

void

$setNamedRoutePositions

Public Function $setNamedRoutePositions
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label

name

required

type

default

hint

return type

void

$simpleLock

Public Function $simpleLock
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	name	true	string	null
	type	true	string	null
	execute	true	string	null
	executeArgs	false	struct
	timeout	false	numeric	30

return type

any

$singularizeOrPluralize

Public Function $singularizeOrPluralize
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	text	true	string	null
	which	true	string	null
	count	false	numeric	-1
	returnCount	false	boolean	true

return type

string

$statusCode

Public Function $statusCode
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Get the status code (e.g. 200, 404 etc) of the response we're about to send.

arguments

label

name

required

type

default

hint

return type

string

$structKeysExist

Public Function $structKeysExist
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Check to see if all keys in the list exist for the structure and have length.

arguments

label	name	required	type	default	hint
	struct	true	struct	null
	keys	false	string

return type

boolean

$throwErrorOrShow404Page

arguments

label	name	required	type	default	hint
	type	true	string	null
	message	true	string	null
	extendedInfo	false	string

return type

void

$timeSpanForCache

Public Function $timeSpanForCache
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	cache	true	any	null
	defaultCacheTime	false	numeric	60
	cacheDatePart	false	string	n

return type

any

$timestamp

Public Function $timestamp
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	timeStampMode	false	string	utc

return type

string

$toXml

Public Function $toXml
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Internal function.

arguments

label	name	required	type	default	hint
	data	true	any	null

return type

xml

$wddx

Public Function $wddx
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label	name	required	type	default	hint
	input	true	any	null
	action	false	string	cfml2wddx
	useTimeZoneInfo	false	boolean	true

return type

any

$wildcardDomainMatch

Public Function $wildcardDomainMatch
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm
Wildcard domain match: domain satifies wildcard

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	origin	true	string	null	string to test against e.g bar.foo.com

return type

boolean

$wildcardDomainMatchCGI

arguments

label	name	required	type	default	hint
	domain	true	string	null	string to test against e.g *.foo.com
	cgi	false	struct	null	Fake CGI Scope for Testing; will default to normal cgi scope

return type

boolean

$zip

Public Function $zip
source: C:\home\pptinc.org\wwwroot\wheels\global\cfml.cfm

arguments

label

name

required

type

default

hint

return type

any

addFormat

arguments

label	name	required	type	default	hint
	extension	true	string	null	File extension to add.
	mimeType	true	string	null	Matching MIME type to associate with the file extension.

return type

void

capitalize

arguments

label	name	required	type	default	hint
	text	true	string	null

return type

string

controller

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the controller to create.
	params	false	struct		The params struct (combination of form and URL variables).

return type

any

deobfuscateParam

Public Function deobfuscateParam
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Deobfuscates a value.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	param	true	string	null	The value to deobfuscate.

return type

string

distanceOfTimeInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.

return type

string

excerpt

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to extract an excerpt from.
	phrase	true	string	null	The phrase to extract.
	radius	false	numeric	null	Number of characters to extract surrounding the phrase.
	excerptString	false	string	null	String to replace first and / or last characters with.

return type

string

get

arguments

label	name	required	type	default	hint
	name	true	string	null	Variable name to get setting for.
	functionName	false	string		Function name to get setting for.

return type

any

getDependantPlugins

Public Function getDependantPlugins
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

any

getIncompatiblePlugins

Public Function getIncompatiblePlugins
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

any

getMixableComponents

Public Function getMixableComponents
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

any

getMixins

Public Function getMixins
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

any

getPluginMeta

Public Function getPluginMeta
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

any

getPlugins

Public Function getPlugins
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm
GETTERS

arguments

label

name

required

type

default

hint

return type

any

humanize

arguments

label	name	required	type	default	hint
	text	true	string	null	Text to humanize.
	except	false	string		A list of strings (space separated) to replace within the output.

return type

string

hyphenize

arguments

label	name	required	type	default	hint
	string	true	string	null	The string to hyphenize.

return type

string

init

Public Function init
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label	name	required	type	default	hint
	pluginPath	true	string	null
	deletePluginDirectories	false	boolean	true
	overwritePlugins	false	boolean	true
	loadIncompatiblePlugins	false	boolean	true
	wheelsEnvironment	false	string	production
	wheelsVersion	false	string	2.5.0

return type

any

inspect

Public Function inspect
source: C:\home\pptinc.org\wwwroot\wheels\plugins\initialization.cfm

arguments

label

name

required

type

default

hint

return type

any

mapper

arguments

label	name	required	type	default	hint
	restful	false	boolean	true	Whether to turn on RESTful routing or not. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	methods	false	boolean		If not RESTful, then specify allowed routes. Not recommended to set. Will probably be removed in a future version of wheels, as RESTful routes are the default.
	mapFormat	false	boolean	true	This is useful for providing formats via URL like `json`, `xml`, `pdf`, etc. Set to false to disable automatic .[format] generation for resource based routes

return type

struct

mimeTypes

arguments

label	name	required	type	default	hint
	extension	true	string	null	The extension to get the MIME type for.
	fallback	false	string	application/octet-stream	The fallback MIME type to return.

return type

string

model

arguments

label	name	required	type	default	hint
	name	true	string	null	Name of the model to get a reference to.

return type

any

obfuscateParam

arguments

label	name	required	type	default	hint
	param	true	any	null	The value to obfuscate.

return type

string

pagination

arguments

label	name	required	type	default	hint
	handle	false	string	query	The handle given to the query to return pagination information for.

return type

struct

pluginNames

arguments

label

name

required

type

default

hint

return type

string

pluralize

arguments

label	name	required	type	default	hint
	word	true	string	null	The word to pluralize.
	count	false	numeric	-1	Pluralization will occur when this value is not 1.
	returnCount	false	boolean	true	Will return count prepended to the pluralization when true and count is not -1.

return type

string

processRequest

arguments

label	name	required	type	default	hint
	params	true	struct	null	The params struct to use in the request (make sure that at least `controller` and `action` are set).
	method	false	string	null	The HTTP method to use in the request (`get`, `post` etc).
	returnAs	false	string	null	Pass in `struct` to return all information about the request instead of just the final output (`body`).
	rollback	false	string	null	Pass in `true` to roll back all database transactions made during the request.
	includeFilters	false	string	true	Set to `before` to only execute "before" filters, `after` to only execute "after" filters or `false` to skip all filters.

return type

any

set

arguments

label

name

required

type

default

hint

return type

void

setPagination

arguments

label	name	required	type	default	hint
	totalRecords	true	numeric	null	Total count of records that should be represented by the paginated links.
	currentPage	false	numeric	1	Page number that should be represented by the data being fetched and the paginated links.
	perPage	false	numeric	25	Number of records that should be represented on each page of data.
	handle	false	string	query	Name of handle to reference in `paginationLinks`.

return type

void

singularize

Public Function singularize
source: C:\home\pptinc.org\wwwroot\wheels\global\util.cfm
Returns the singular form of the passed in word.
[section: Global Helpers]
[category: String Functions]

arguments

label	name	required	type	default	hint
	word	true	string	null

return type

string

timeAgoInWords

arguments

label	name	required	type	default	hint
	fromTime	true	date	null	Date to compare from.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	toTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare to.

return type

any

timeUntilInWords

arguments

label	name	required	type	default	hint
	toTime	true	date	null	Date to compare to.
	includeSeconds	false	boolean	null	Whether or not to include the number of seconds in the returned string.
	fromTime	false	date	{ts '2025-04-24 11:22:35'}	Date to compare from.

return type

string

titleize

arguments

label	name	required	type	default	hint
	word	true	string	null	The text to turn into a title.

return type

string

truncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Length to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

URLFor

Public Function URLFor
source: C:\home\pptinc.org\wwwroot\wheels\global\misc.cfm
Creates an internal URL based on supplied arguments.
[section: Global Helpers]
[category: Miscellaneous Functions]

arguments

label	name	required	type	default	hint
	route	false	string		Name of a route that you have configured in `config/routes.cfm`.
	controller	false	string		Name of the controller to include in the URL.
	action	false	string		Name of the action to include in the URL.
	key	false	any		Key(s) to include in the URL.
	params	false	string		Any additional parameters to be set in the query string (example: `wheels=cool&x=y`). Please note that CFWheels uses the `&` and `=` characters to split the parameters and encode them properly for you. However, if you need to pass in `&` or `=` as part of the value, then you need to encode them (and only them), example: `a=cats%26dogs%3Dtrouble!&b=1`.
	anchor	false	string		Sets an anchor name to be appended to the path.
	onlyPath	false	boolean	null	If `true`, returns only the relative URL (no protocol, host name or port).
	host	false	string	null	Set this to override the current host.
	protocol	false	string	null	Set this to override the current protocol.
	port	false	numeric	null	Set this to override the current port number.
	encode	false	boolean	null	Encode URL parameters using `EncodeForURL()`. Please note that this does not make the string safe for placement in HTML attributes, for that you need to wrap the result in `EncodeForHtmlAttribute()` or use `linkTo()`, `startFormTag()` etc instead.
	$encodeForHtmlAttribute	false	boolean	false
	$URLRewriting	false	string	on

return type

string

wordTruncate

arguments

label	name	required	type	default	hint
	text	true	string	null	The text to truncate.
	length	false	numeric	null	Number of words to truncate the text to.
	truncateString	false	string	null	String to replace the last characters with.

return type

string

private

$checkMinimumVersion

Private Function $checkMinimumVersion
source: C:\home\pptinc.org\wwwroot\wheels\global\internal.cfm

arguments

label	name	required	type	default	hint
	engine	true	string	null
	version	true	string	null

return type

string

PLUGINPATH

string

plugins

PLUGINS

Struct

flashMessages

Component (plugins.flashMessages.flashMessages)
Only the functions and data members that are accessible from your location are displayed

this

public

flashMessages

Public Function flashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label	name	required	type	default	hint
	keys	false	string	null
	closeable	false	boolean	true
	includeEmptyContainer	false	boolean	false
	encode	false	boolean	false

return type

string

init

Public Function init
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label

name

required

type

default

hint

return type

any

VERSION

string

2.2.0

private

$initFlashMessages

Private Function $initFlashMessages
source: C:\home\pptinc.org\wwwroot\plugins\flashMessages\flashMessages.cfc

arguments

label

name

required

type

default

hint

return type

struct

reCaptcha

Component (plugins.reCaptcha.reCaptcha)
Only the functions and data members that are accessible from your location are displayed

this

public

$getIP

Public Function $getIP
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

string

includeReCaptchaJS

Public Function includeReCaptchaJS
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	async	false	boolean	true
	defer	false	boolean	true

return type

void

init

Public Function init
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

any

insertReCaptchaDiv

Public Function insertReCaptchaDiv
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	sitekey	true	string
	callback	false	string	onSubmit
	size	false	string	invisible
	badge	false	string

return type

string

isValidReCaptcha

Public Function isValidReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label	name	required	type	default	hint
	secret	true	string
	response	true	string
	remoteIp	false	string

return type

any

VERSION

string

1.0.0

private

$initReCaptcha

Private Function $initReCaptcha
source: C:\home\pptinc.org\wwwroot\plugins\reCaptcha\reCaptcha.cfc

arguments

label

name

required

type

default

hint

return type

struct

PROTECTEDCONTROLLERMETHODS

string

BUTTONTAG,GETEMAILS,STRIPLINKS,MODEL,FILTERS,TEXTAREA,HUMANIZE,FILEFIELD,ISPUT,DATESELECT,ERRORMESSAGESFOR,BUTTONTO,REDIRECTTO,PAGINATIONLINKS,DISTANCEOFTIMEINWORDS,INCLUDEPARTIAL,SIMPLEFORMAT,DATESELECTTAGS,YEARSELECTTAG,MAILTO,SELECTTAG,ISDELETE,IMAGETAG,TEXTFIELDTAG,FLASHINSERT,ISAJAX,ERRORMESSAGEON,URLFOR,ADDFORMAT,FLASHCLEAR,RADIOBUTTON,GETREDIRECT,STYLESHEETLINKTAG,STRIPTAGS,ISPATCH,PLURALIZE,ONLYPROVIDES,AUTOLINK,HIGHLIGHT,CONTENTFORLAYOUT,WORDTRUNCATE,FLASHCOUNT,TIMEAGOINWORDS,CACHES,MINUTESELECTTAG,RESETCYCLE,SENDEMAIL,FILEFIELDTAG,PROCESSACTION,RADIOBUTTONTAG,USESLAYOUT,TIMESELECT,FLASHKEEP,MIMETYPES,SINGULARIZE,GETFILES,SECONDSELECTTAG,FLASHISEMPTY,RESPONSE,RENDERNOTHING,RENDERVIEW,FLASHDELETE,PASSWORDFIELDTAG,SETRESPONSE,PLUGINNAMES,SETVERIFICATIONCHAIN,HIDDENFIELDTAG,CSRFMETATAGS,VERIFIES,TEXTAREATAG,CHECKBOXTAG,INCLUDECONTENT,SELECT,HIDDENFIELD,FLASHMESSAGES,STARTFORMTAG,INCLUDEDINOBJECT,RENDERWITH,ISPOST,CAPITALIZE,TRUNCATE,CONTROLLER,MONTHSELECTTAG,TIMESELECTTAGS,HASMANYCHECKBOX,ISHEAD,OBFUSCATEPARAM,TITLEIZE,ISGET,FILTERCHAIN,HASMANYRADIOBUTTON,PASSWORDFIELD,VERIFICATIONCHAIN,SETFILTERCHAIN,EXCERPT,ISOPTIONS,TEXTFIELD,DATETIMESELECTTAGS,FLASH,HOURSELECTTAG,SUBMITTAG,CHECKBOX,HYPHENIZE,SENDFILE,JAVASCRIPTINCLUDETAG,PROCESSREQUEST,SETPAGINATION,DEOBFUSCATEPARAM,TIMEUNTILINWORDS,ENDFORMTAG,RENDERTEXT,RENDERPARTIAL,LINKTO,PROVIDES,DAYSELECTTAG,FLASHKEYEXISTS,DATETIMESELECT,AUTHENTICITYTOKENFIELD,INCLUDELAYOUT,AUTHENTICITYTOKEN,ISSECURE,PAGINATION,CONTENTFOR,PROTECTSFROMFORGERY,CYCLE

reCaptchaSecretKey

string

6Lcd9BkrAAAAAA0eWrXh_AZfPHTzqYu5gsWehrrn

reCaptchaSiteKey

string

6Lcd9BkrAAAAAMtUy6mUPhBR27UUu7WQ7oBPF6vC

REDIRECTAFTERRELOAD

boolean

true

RELOADPASSWORD

string

dkslfjh&*^hewgbf

RESETPROPERTIESSTRUCTKEYCASE

boolean

true

RESOURCECONTROLLERNAMING

string

plural

RESTORETESTRUNNERAPPLICATIONSCOPE

boolean

true

REWRITEFILE

string

rewrite.cfm

ROOTCOMPONENTPATH

string

ROOTPATH

string

ROUTES

Array
Rows: 32

Scope Arguments

pattern

string

/wheels/info

constraints

Struct

name

string

wheelsInfo

methods

string

get

Empty:null

controller

string

wheels.public

action

string

info

redirect

Empty:null

REGEX

string

^wheels\/info\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/routes

constraints

Struct

name

string

wheelsRoutes

methods

string

get

Empty:null

controller

string

wheels.public

action

string

routes

redirect

Empty:null

REGEX

string

^wheels\/routes\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/route-tester

constraints

Struct

name

string

wheelsRouteTester

methods

string

post

Empty:null

controller

string

wheels.public

action

string

routetester

redirect

Empty:null

REGEX

string

^wheels\/route-tester\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/packages/[type]

constraints

Struct

name

string

wheelsPackages

methods

string

get

Empty:null

controller

string

wheels.public

action

string

packages

redirect

Empty:null

REGEX

string

^wheels\/packages\/([^\.\/]+)\/?$

VARIABLES

string

type

Scope Arguments

pattern

string

/wheels/migrator/templates

constraints

Struct

name

string

wheelsMigratorTemplates

methods

string

get

Empty:null

controller

string

wheels.public

action

string

migratortemplates

redirect

Empty:null

REGEX

string

^wheels\/migrator\/templates\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/migrator/templates

constraints

Struct

name

string

wheelsMigratorTemplatesCreate

methods

string

post

Empty:null

controller

string

wheels.public

action

string

migratortemplatescreate

redirect

Empty:null

REGEX

string

^wheels\/migrator\/templates\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/migrator/sql/[version]

constraints

Struct

name

string

wheelsMigratorSQL

methods

string

get

Empty:null

controller

string

wheels.public

action

string

migratorsql

redirect

Empty:null

REGEX

string

^wheels\/migrator\/sql\/([^\.\/]+)\/?$

VARIABLES

string

version

Scope Arguments

pattern

string

/wheels/migrator/[command]/[version]

constraints

Struct

name

string

wheelsMigratorCommand

methods

string

post

Empty:null

controller

string

wheels.public

action

string

migratorcommand

redirect

Empty:null

REGEX

string

^wheels\/migrator\/([^\.\/]+)\/([^\.\/]+)\/?$

VARIABLES

string

command,version

Scope Arguments

pattern

string

/wheels/migrator

constraints

Struct

name

string

wheelsMigrator

methods

string

get

Empty:null

controller

string

wheels.public

action

string

migrator

redirect

Empty:null

REGEX

string

^wheels\/migrator\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/tests/[type]

constraints

Struct

name

string

wheelsTests

methods

string

get

Empty:null

controller

string

wheels.public

action

string

tests

redirect

Empty:null

REGEX

string

^wheels\/tests\/([^\.\/]+)\/?$

VARIABLES

string

type

Scope Arguments

pattern

string

/wheels/docs

constraints

Struct

name

string

wheelsDocs

methods

string

get

Empty:null

controller

string

wheels.public

action

string

docs

redirect

Empty:null

REGEX

string

^wheels\/docs\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/cli

constraints

Struct

name

string

wheelsCli

methods

string

get

Empty:null

controller

string

wheels.public

action

string

cli

redirect

Empty:null

REGEX

string

^wheels\/cli\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/plugins/[name]

constraints

Struct

name

string

wheelsPluginEntry

methods

string

get

Empty:null

controller

string

wheels.public

action

string

pluginentry

redirect

Empty:null

REGEX

string

^wheels\/plugins\/([^\.\/]+)\/?$

VARIABLES

string

name

Scope Arguments

pattern

string

/wheels/plugins/[name]

constraints

Struct

name

string

wheelsPluginPost

methods

string

post

Empty:null

controller

string

wheels.public

action

string

pluginentry

redirect

Empty:null

REGEX

string

^wheels\/plugins\/([^\.\/]+)\/?$

VARIABLES

string

name

Scope Arguments

pattern

string

/wheels/plugins

constraints

Struct

name

string

wheelsPlugins

methods

string

get

Empty:null

controller

string

wheels.public

action

string

plugins

redirect

Empty:null

REGEX

string

^wheels\/plugins\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/build

constraints

Struct

name

string

wheelsBuild

methods

string

get

Empty:null

controller

string

wheels.public

action

string

build

redirect

Empty:null

REGEX

string

^wheels\/build\/?$

VARIABLES

string

Scope Arguments

pattern

string

/wheels/wheels/[view]

constraints

Struct

name

string

wheelsLegacy

methods

string

get

Empty:null

controller

string

wheels.public

action

string

legacy

redirect

Empty:null

REGEX

string

^wheels\/wheels\/([^\.\/]+)\/?$

VARIABLES

string

view

Scope Arguments

pattern

string

/wheels

constraints

Struct

name

string

wheelsRoot

methods

string

get

Empty:null

mapFormat

boolean

false

CONTROLLER

string

wheels.public

ACTION

string

index

REGEX

string

^wheels\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

constraints

Struct

name

string

home

methods

string

get

package

Empty:null

controller

string

pages

action

string

index

redirect

Empty:null

REGEX

string

^\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

/about-us

constraints

Struct

name

string

about

methods

string

get

package

Empty:null

controller

string

pages

action

string

about

redirect

Empty:null

REGEX

string

^about-us\/?$

VARIABLES

string

Scope Arguments
Entries:12

pattern

string

/services/post-tension

constraints

Struct

name

string

postTension

Empty:null

methods

string

get

package

Empty:null

controller

string

services

action

string

postTension

redirect

Empty:null

REGEX

string

^services\/post-tension\/?$

VARIABLES

string

Scope Arguments
Entries:12

pattern

string

/services/turnkey-concrete-construction

constraints

Struct

name

string

turnKey

Empty:null

methods

string

get

package

Empty:null

controller

string

services

action

string

turnKey

redirect

Empty:null

REGEX

string

^services\/turnkey-concrete-construction\/?$

VARIABLES

string

Scope Arguments
Entries:12

pattern

string

/services/foundation-remediation-helical

constraints

Struct

name

string

foundation

Empty:null

methods

string

get

package

Empty:null

controller

string

services

action

string

foundation

redirect

Empty:null

REGEX

string

^services\/foundation-remediation-helical\/?$

VARIABLES

string

Scope Arguments
Entries:12

pattern

string

/services/pier-drilling

constraints

Struct

name

string

pier

Empty:null

methods

string

get

package

Empty:null

controller

string

services

action

string

piers

redirect

Empty:null

REGEX

string

^services\/pier-drilling\/?$

VARIABLES

string

Scope Arguments
Entries:12

pattern

string

/services/concrete-pumping

constraints

Struct

name

string

concrete

Empty:null

methods

string

get

package

Empty:null

controller

string

services

action

string

concrete

redirect

Empty:null

REGEX

string

^services\/concrete-pumping\/?$

VARIABLES

string

Scope Arguments
Entries:12

pattern

string

/services/site-work

constraints

Struct

name

string

work

Empty:null

methods

string

get

package

Empty:null

controller

string

services

action

string

work

redirect

Empty:null

REGEX

string

^services\/site-work\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

/faq

constraints

Struct

name

string

faq

methods

string

get

package

Empty:null

controller

string

pages

action

string

faq

redirect

Empty:null

REGEX

string

^faq\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

/job-opportunities

constraints

Struct

name

string

jobs

methods

string

get

package

Empty:null

controller

string

pages

action

string

jobs

redirect

Empty:null

REGEX

string

^job-opportunities\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

/job-opportunities

constraints

Struct

name

string

jobs

methods

string

post

package

Empty:null

controller

string

pages

action

string

processJobsForm

redirect

Empty:null

REGEX

string

^job-opportunities\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

/contact-us

constraints

Struct

name

string

contact

methods

string

get

package

Empty:null

controller

string

pages

action

string

contact

redirect

Empty:null

REGEX

string

^contact-us\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

/contact-us

constraints

Struct

name

string

contact

methods

string

post

package

Empty:null

controller

string

pages

action

string

processContactForm

redirect

Empty:null

REGEX

string

^contact-us\/?$

VARIABLES

string

Scope Arguments
Entries:11

pattern

string

constraints

Struct

name

string

root

methods

string

get

package

Empty:null

mapFormat

boolean

false

CONTROLLER

string

pages

ACTION

string

index

REGEX

string

^\/?$

VARIABLES

string

SENDEMAILONERROR

boolean

true

SERVERNAME

string

Lucee

SERVERVERSION

string

5.3.8.206

SERVERVERSIONMAJOR

string

SESSIONMANAGEMENT

boolean

true

SETUPDATEDATONCREATE

boolean

true

SHOWDEBUGINFORMATION

boolean

false

SHOWERRORINFORMATION

boolean

false

SHOWINCOMPATIBLEPLUGINS

boolean

true

SOFTDELETEPROPERTY

string

deletedAt

STYLESHEETPATH

string

stylesheets

TABLENAMEPREFIX

string

TIMESTAMPMODE

string

utc

TIMESTAMPONCREATEPROPERTY

string

createdAt

TIMESTAMPONUPDATEPROPERTY

string

updatedAt

TRANSACTIONMODE

string

commit

UNCOUNTABLES

string

advice,air,blood,deer,equipment,fish,food,furniture,garbage,graffiti,grass,homework,housework,information,knowledge,luggage,mathematics,meat,milk,money,music,pollution,research,rice,sand,series,sheep,soap,software,species,sugar,traffic,transportation,travel,trash,water,feedback

URLREWRITING

string

USEEXPANDEDCOLUMNALIASES

boolean

false

VALIDATETESTPACKAGEMETADATA

boolean

true

VERSION

string

2.5.0

VIEWPATH

string

views

WEBPATH

string

WHEELSCOMPONENTPATH

string

wheels

WRITEMIGRATORSQLFILES

boolean

false

Proven Experience Since 1985

Regional Experts

CIDH Specialists

The Right Equipment for Every Job

Let's Build Something Together

Email

Address:

Phone:

Hours: