Skip to content
v1.4.5
archived
v4.0
current
v3.0.0
archived
v2.5.0
archived
v2.4.0
archived
v2.3.0
archived
v2.2.0
archived
v2.1.0
archived
v2.0.0
archived
v1.4.5
archived
Search
Ctrl
K
Cancel
Home
Guides
API
Blog
Packages
GitHub
↗
Switch version
v4.0
current
v3.0.0
archived
v2.5.0
archived
v2.4.0
archived
v2.3.0
archived
v2.2.0
archived
v2.1.0
archived
v2.0.0
archived
v1.4.5
archived
Overview
v4.0 (current)
configuration
addFormat()
api()
collection()
constraints()
controller()
delete()
end()
env()
get()
group()
health()
mapper()
member()
namespace()
package()
patch()
post()
put()
registerOnError()
resource()
resources()
root()
scope()
set()
switchTenant()
tenant()
version()
whereAlpha()
whereAlphaNumeric()
whereIn()
whereMatch()
whereNumber()
whereSlug()
whereUuid()
wildcard()
Configuration
controller
authenticityToken()
caches()
clearCachableActions()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setFlashStorage()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
generateUUID()
humanize()
hyphenize()
injector()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
publish()
service()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
migrator
addColumn()
addForeignKey()
addIndex()
addRecord()
addReference()
announce()
bigInteger()
binary()
boolean()
change()
changeColumn()
changeTable()
char()
column()
create()
createMigration()
createTable()
createView()
date()
datetime()
decimal()
down()
dropForeignKey()
dropReference()
dropTable()
dropView()
execute()
float()
getAvailableMigrations()
getCurrentMigrationVersion()
integer()
migrateIndividual()
migrateTo()
migrateToLatest()
primaryKey()
redoMigration()
references()
removeColumn()
removeIndex()
removeRecord()
renameColumn()
renameSystemTables()
renameTable()
string()
text()
time()
timestamp()
timestamps()
uniqueidentifier()
up()
updateRecord()
Migrator
miscellaneous
channelSSETag()
closeSSEStream()
getRoutes()
initSSEStream()
inject()
injectedServices()
isSSERequest()
renderSSE()
sendSSEComment()
sendSSEEvent()
subscribeToChannel()
Miscellaneous
model-class
associationInfo()
associationNames()
average()
callbackInfo()
classInfo()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
enumInfo()
exists()
findAll()
findAllKeys()
findByKey()
findEach()
findFirst()
findInBatches()
findLastOne()
findOne()
getTableNamePrefix()
insertAll()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
scopeInfo()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
upsertAll()
validationInfo()
validationTypeForProperty()
withAdvisoryLock()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
enum()
hasMany()
hasOne()
ignoredColumns()
nestedProperties()
property()
protectedProperties()
scope()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
sharedModel()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allAssociationErrors()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
colorField()
colorFieldTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateField()
dateFieldTag()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
emailField()
emailFieldTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
firstPageLink()
flashMessages()
h()
hasManyCheckBox()
hasManyRadioButton()
hAttr()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
lastPageLink()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
nextPageLink()
numberField()
numberFieldTag()
pageNumberLinks()
paginationInfo()
paginationLinks()
paginationNav()
passwordField()
passwordFieldTag()
previousPageLink()
radioButton()
radioButtonTag()
rangeField()
rangeFieldTag()
resetCycle()
searchField()
searchFieldTag()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
telField()
telFieldTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
urlField()
urlFieldTag()
viteAsset()
vitePreloadTag()
viteScriptTag()
viteStyleTag()
yearSelectTag()
View Helpers
Wheels 4.0.0 API Reference
v3.0.0
configuration
addFormat()
collection()
constraints()
controller()
delete()
end()
get()
mapper()
member()
namespace()
package()
patch()
post()
put()
resource()
resources()
root()
scope()
set()
wildcard()
Configuration
controller
authenticityToken()
caches()
clearCachableActions()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setFlashStorage()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
humanize()
hyphenize()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
migrator
addColumn()
addForeignKey()
addIndex()
addRecord()
addReference()
bigInteger()
binary()
boolean()
change()
changeColumn()
changeTable()
char()
column()
create()
createMigration()
createTable()
createView()
date()
datetime()
decimal()
down()
dropForeignKey()
dropReference()
dropTable()
dropView()
execute()
float()
getAvailableMigrations()
getCurrentMigrationVersion()
integer()
migrateTo()
migrateToLatest()
primaryKey()
redoMigration()
references()
removeColumn()
removeIndex()
removeRecord()
renameColumn()
renameTable()
string()
text()
time()
timestamp()
timestamps()
uniqueidentifier()
up()
updateRecord()
Migrator
miscellaneous
announce()
assert()
fail()
getRoutes()
Miscellaneous
model-class
average()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
exists()
findAll()
findAllKeys()
findByKey()
findFirst()
findLastOne()
findOne()
getTableNamePrefix()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
validationTypeForProperty()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
hasMany()
hasOne()
nestedProperties()
property()
protectedProperties()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
test-model
debug()
raised()
Test Model
test-model-configuration
packageSetup()
packageTeardown()
setup()
teardown()
Test Model Configuration
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
flashMessages()
hasManyCheckBox()
hasManyRadioButton()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
paginationLinks()
passwordField()
passwordFieldTag()
radioButton()
radioButtonTag()
resetCycle()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
yearSelectTag()
View Helpers
Wheels 3.0.0 API Reference
v2.5.0
configuration
addFormat()
collection()
constraints()
controller()
delete()
end()
get()
mapper()
member()
namespace()
package()
patch()
post()
put()
resource()
resources()
root()
scope()
set()
wildcard()
Configuration
controller
authenticityToken()
caches()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
humanize()
hyphenize()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
migrator
addColumn()
addForeignKey()
addIndex()
addRecord()
addReference()
bigInteger()
binary()
boolean()
change()
changeColumn()
changeTable()
char()
column()
create()
createMigration()
createTable()
createView()
date()
datetime()
decimal()
down()
dropForeignKey()
dropReference()
dropTable()
dropView()
execute()
float()
getAvailableMigrations()
getCurrentMigrationVersion()
integer()
migrateTo()
migrateToLatest()
primaryKey()
redoMigration()
references()
removeColumn()
removeIndex()
removeRecord()
renameColumn()
renameTable()
string()
text()
time()
timestamp()
timestamps()
uniqueidentifier()
up()
updateRecord()
Migrator
miscellaneous
announce()
assert()
fail()
testExample()
Miscellaneous
model-class
average()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
exists()
findAll()
findAllKeys()
findByKey()
findFirst()
findLastOne()
findOne()
getTableNamePrefix()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
validationTypeForProperty()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
hasMany()
hasOne()
nestedProperties()
property()
protectedProperties()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
test-model
debug()
raised()
Test Model
test-model-configuration
afterAll()
beforeAll()
packageSetup()
packageTeardown()
setup()
teardown()
Test Model Configuration
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
flashMessages()
hasManyCheckBox()
hasManyRadioButton()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
paginationLinks()
passwordField()
passwordFieldTag()
radioButton()
radioButtonTag()
resetCycle()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
yearSelectTag()
View Helpers
Wheels 2.5.0 API Reference
v2.4.0
configuration
addFormat()
collection()
constraints()
controller()
delete()
end()
get()
mapper()
member()
namespace()
package()
patch()
post()
put()
resource()
resources()
root()
scope()
set()
wildcard()
Configuration
controller
authenticityToken()
caches()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
humanize()
hyphenize()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
migrator
addColumn()
addForeignKey()
addIndex()
addRecord()
addReference()
bigInteger()
binary()
boolean()
change()
changeColumn()
changeTable()
char()
column()
create()
createMigration()
createTable()
createView()
date()
datetime()
decimal()
down()
dropForeignKey()
dropReference()
dropTable()
dropView()
execute()
float()
getAvailableMigrations()
getCurrentMigrationVersion()
integer()
migrateTo()
migrateToLatest()
primaryKey()
redoMigration()
references()
removeColumn()
removeIndex()
removeRecord()
renameColumn()
renameTable()
string()
text()
time()
timestamp()
timestamps()
uniqueidentifier()
up()
updateRecord()
Migrator
miscellaneous
announce()
Miscellaneous
model-class
average()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
exists()
findAll()
findAllKeys()
findByKey()
findFirst()
findLastOne()
findOne()
getTableNamePrefix()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
validationTypeForProperty()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
hasMany()
hasOne()
nestedProperties()
property()
protectedProperties()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
flashMessages()
hasManyCheckBox()
hasManyRadioButton()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
paginationLinks()
passwordField()
passwordFieldTag()
radioButton()
radioButtonTag()
resetCycle()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
yearSelectTag()
View Helpers
Wheels 2.4.0 API Reference
v2.3.0
configuration
addFormat()
collection()
constraints()
controller()
delete()
end()
get()
mapper()
member()
namespace()
package()
patch()
post()
put()
resource()
resources()
root()
scope()
set()
wildcard()
Configuration
controller
authenticityToken()
caches()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
humanize()
hyphenize()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
migrator
addColumn()
addForeignKey()
addIndex()
addRecord()
addReference()
bigInteger()
binary()
boolean()
change()
changeColumn()
changeTable()
char()
column()
create()
createMigration()
createTable()
createView()
date()
datetime()
decimal()
down()
dropForeignKey()
dropReference()
dropTable()
dropView()
execute()
float()
getAvailableMigrations()
getCurrentMigrationVersion()
integer()
migrateTo()
migrateToLatest()
primaryKey()
redoMigration()
references()
removeColumn()
removeIndex()
removeRecord()
renameColumn()
renameTable()
string()
text()
time()
timestamp()
timestamps()
uniqueidentifier()
up()
updateRecord()
Migrator
miscellaneous
announce()
Miscellaneous
model-class
average()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
exists()
findAll()
findAllKeys()
findByKey()
findFirst()
findLastOne()
findOne()
getTableNamePrefix()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
validationTypeForProperty()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
hasMany()
hasOne()
nestedProperties()
property()
protectedProperties()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
flashMessages()
hasManyCheckBox()
hasManyRadioButton()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
paginationLinks()
passwordField()
passwordFieldTag()
radioButton()
radioButtonTag()
resetCycle()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
yearSelectTag()
View Helpers
Wheels 2.3.0 API Reference
v2.2.0
configuration
addFormat()
collection()
constraints()
controller()
delete()
end()
get()
mapper()
member()
namespace()
package()
patch()
post()
put()
resource()
resources()
root()
scope()
set()
wildcard()
Configuration
controller
authenticityToken()
caches()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
humanize()
hyphenize()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
migrator
addColumn()
addForeignKey()
addIndex()
addRecord()
addReference()
bigInteger()
binary()
boolean()
change()
changeColumn()
changeTable()
char()
column()
create()
createMigration()
createTable()
createView()
date()
datetime()
decimal()
down()
dropForeignKey()
dropReference()
dropTable()
dropView()
execute()
float()
getAvailableMigrations()
getCurrentMigrationVersion()
integer()
migrateTo()
migrateToLatest()
primaryKey()
redoMigration()
references()
removeColumn()
removeIndex()
removeRecord()
renameColumn()
renameTable()
string()
text()
time()
timestamp()
timestamps()
uniqueidentifier()
up()
updateRecord()
Migrator
miscellaneous
announce()
Miscellaneous
model-class
average()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
exists()
findAll()
findAllKeys()
findByKey()
findFirst()
findLastOne()
findOne()
getTableNamePrefix()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
validationTypeForProperty()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
hasMany()
hasOne()
nestedProperties()
property()
protectedProperties()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
flashMessages()
hasManyCheckBox()
hasManyRadioButton()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
paginationLinks()
passwordField()
passwordFieldTag()
radioButton()
radioButtonTag()
resetCycle()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
yearSelectTag()
View Helpers
Wheels 2.2.0 API Reference
v2.1.0
configuration
addFormat()
collection()
constraints()
controller()
delete()
end()
get()
mapper()
member()
namespace()
package()
patch()
post()
put()
resource()
resources()
root()
scope()
set()
wildcard()
Configuration
controller
authenticityToken()
caches()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
humanize()
hyphenize()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
migrator
addColumn()
addForeignKey()
addIndex()
addRecord()
addReference()
bigInteger()
binary()
boolean()
change()
changeColumn()
changeTable()
char()
column()
create()
createMigration()
createTable()
createView()
date()
datetime()
decimal()
down()
dropForeignKey()
dropReference()
dropTable()
dropView()
execute()
float()
getAvailableMigrations()
getCurrentMigrationVersion()
integer()
migrateTo()
migrateToLatest()
primaryKey()
redoMigration()
references()
removeColumn()
removeIndex()
removeRecord()
renameColumn()
renameTable()
string()
text()
time()
timestamp()
timestamps()
uniqueidentifier()
up()
updateRecord()
Migrator
miscellaneous
announce()
Miscellaneous
model-class
average()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
exists()
findAll()
findAllKeys()
findByKey()
findFirst()
findLast()
findOne()
getTableNamePrefix()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
validationTypeForProperty()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
hasMany()
hasOne()
nestedProperties()
property()
protectedProperties()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
flashMessages()
hasManyCheckBox()
hasManyRadioButton()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
paginationLinks()
passwordField()
passwordFieldTag()
radioButton()
radioButtonTag()
resetCycle()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
yearSelectTag()
View Helpers
Wheels 2.1.0 API Reference
v2.0.0
configuration
addFormat()
collection()
constraints()
controller()
createMigration()
delete()
end()
get()
getAvailableMigrations()
getCurrentMigrationVersion()
mapper()
member()
migrateTo()
migrateToLatest()
namespace()
package()
patch()
post()
put()
redoMigration()
resource()
resources()
root()
scope()
set()
wildcard()
Configuration
controller
caches()
filterChain()
filters()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
getEmails()
getFiles()
getRedirect()
isAjax()
isDelete()
isGet()
isHead()
isOptions()
isPatch()
isPost()
isPut()
isSecure()
onlyProvides()
pagination()
processAction()
processRequest()
protectsFromForgery()
provides()
redirectTo()
renderNothing()
renderPartial()
renderText()
renderView()
renderWith()
response()
sendEmail()
sendFile()
setFilterChain()
setPagination()
setResponse()
setVerificationChain()
usesLayout()
verificationChain()
verifies()
Controller
global-helpers
capitalize()
controller()
deobfuscateParam()
distanceOfTimeInWords()
excerpt()
humanize()
hyphenize()
mimeTypes()
model()
obfuscateParam()
pluginNames()
pluralize()
singularize()
timeAgoInWords()
timeUntilInWords()
titleize()
truncate()
URLFor()
wordTruncate()
Global Helpers
model-class
average()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
count()
create()
deleteAll()
deleteByKey()
deleteOne()
exists()
findAll()
findAllKeys()
findByKey()
findFirst()
findLast()
findOne()
getTableNamePrefix()
invokeWithTransaction()
isClass()
isInstance()
maximum()
minimum()
new()
onMissingMethod()
primaryKey()
primaryKeys()
propertyNames()
save()
sum()
tableName()
updateAll()
updateByKey()
updateOne()
validationTypeForProperty()
Model Class
model-configuration
accessibleProperties()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
automaticValidations()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
dataSource()
hasMany()
hasOne()
nestedProperties()
property()
protectedProperties()
setPrimaryKey()
setPrimaryKeys()
setTableNamePrefix()
table()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
Model Configuration
model-object
addError()
addErrorToBase()
allChanges()
allErrors()
changedFrom()
changedProperties()
clearChangeInformation()
clearErrors()
compareTo()
delete()
errorCount()
errorsOn()
errorsOnBase()
hasChanged()
hasErrors()
hasProperty()
isNew()
isPersisted()
key()
properties()
propertyIsBlank()
propertyIsPresent()
reload()
setProperties()
toggle()
update()
updateProperty()
valid()
Model Object
view-helpers
authenticityTokenField()
autoLink()
buttonTag()
buttonTo()
checkBox()
checkBoxTag()
contentFor()
contentForLayout()
csrfMetaTags()
cycle()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
endFormTag()
errorMessageOn()
errorMessagesFor()
fileField()
fileFieldTag()
flashMessages()
hasManyCheckBox()
hasManyRadioButton()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
javaScriptIncludeTag()
linkTo()
mailTo()
minuteSelectTag()
monthSelectTag()
paginationLinks()
passwordField()
passwordFieldTag()
radioButton()
radioButtonTag()
resetCycle()
secondSelectTag()
select()
selectTag()
simpleFormat()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
textArea()
textAreaTag()
textField()
textFieldTag()
timeSelect()
timeSelectTags()
yearSelectTag()
View Helpers
Wheels 2.0.0 API Reference
v1.4.5
miscellaneous
accessibleProperties()
addDefaultRoutes()
addError()
addErrorToBase()
addFormat()
addRoute()
afterCreate()
afterDelete()
afterFind()
afterInitialization()
afterNew()
afterSave()
afterUpdate()
afterValidation()
afterValidationOnCreate()
afterValidationOnUpdate()
allChanges()
allErrors()
autoLink()
automaticValidations()
average()
beforeCreate()
beforeDelete()
beforeSave()
beforeUpdate()
beforeValidation()
beforeValidationOnCreate()
beforeValidationOnUpdate()
belongsTo()
buttonTag()
buttonTo()
caches()
capitalize()
changedFrom()
changedProperties()
checkBox()
checkBoxTag()
clearChangeInformation()
clearErrors()
columnDataForProperty()
columnForProperty()
columnNames()
columns()
compareTo()
contentFor()
contentForLayout()
controller()
count()
create()
cycle()
dataSource()
dateSelect()
dateSelectTags()
dateTimeSelect()
dateTimeSelectTags()
daySelectTag()
delete()
deleteAll()
deleteByKey()
deleteOne()
deobfuscateParam()
distanceOfTimeInWords()
endFormTag()
errorCount()
errorMessageOn()
errorMessagesFor()
errorsOn()
errorsOnBase()
excerpt()
exists()
fileField()
fileFieldTag()
filterChain()
filters()
findAll()
findAllKeys()
findByKey()
findFirst()
findLast()
findOne()
findOrCreateBy[Property]()
flash()
flashClear()
flashCount()
flashDelete()
flashInsert()
flashIsEmpty()
flashKeep()
flashKeyExists()
flashMessages()
get()
getTableNamePrefix()
hasChanged()
hasErrors()
hasMany()
hasManyCheckBox()
hasManyRadioButton()
hasOne()
hasProperty()
hiddenField()
hiddenFieldTag()
highlight()
hourSelectTag()
humanize()
hyphenize()
imageTag()
includeContent()
includedInObject()
includeLayout()
includePartial()
invokeWithTransaction()
isAjax()
isClass()
isGet()
isInstance()
isNew()
isPost()
isSecure()
javaScriptIncludeTag()
key()
linkTo()
mailTo()
maximum()
mimeTypes()
minimum()
minuteSelectTag()
model()
monthSelectTag()
nestedProperties()
new()
obfuscateParam()
onlyProvides()
pagination()
paginationLinks()
passwordField()
passwordFieldTag()
pluginNames()
pluralize()
primaryKey()
primaryKeys()
properties()
property()
propertyIsPresent()
propertyNames()
protectedProperties()
provides()
radioButton()
radioButtonTag()
redirectTo()
reload()
renderNothing()
renderPage()
renderPartial()
renderText()
renderWith()
resetCycle()
response()
save()
secondSelectTag()
select()
selectTag()
sendEmail()
sendFile()
set()
setFilterChain()
setPagination()
setPrimaryKey()
setPrimaryKeys()
setProperties()
setResponse()
setTableNamePrefix()
setVerificationChain()
simpleFormat()
singularize()
startFormTag()
stripLinks()
stripTags()
styleSheetLinkTag()
submitTag()
sum()
table()
tableName()
textArea()
textAreaTag()
textField()
textFieldTag()
timeAgoInWords()
timeSelect()
timeSelectTags()
timeUntilInWords()
titleize()
toggle()
toXHTML()
truncate()
update()
updateAll()
updateByKey()
updateOne()
updateProperties()
updateProperty()
urlFor()
usesLayout()
valid()
validate()
validateOnCreate()
validateOnUpdate()
validatesConfirmationOf()
validatesExclusionOf()
validatesFormatOf()
validatesInclusionOf()
validatesLengthOf()
validatesNumericalityOf()
validatesPresenceOf()
validatesUniquenessOf()
validationTypeForProperty()
verificationChain()
verifies()
wordTruncate()
yearSelectTag()
Miscellaneous
Wheels 1.4.5 API Reference
Select theme
Dark
Light
Auto
V1 4 5
Wheels 1.4.5 API Reference
All 219 functions available in Wheels 1.4.5, grouped by section.
Miscellaneous
— 219 functions
