`validatesNumericalityOf()`

Description

Validates that the value of the specified property is numeric.

Function Syntax

validatesNumericalityOf([ properties, message, when, allowBlank, onlyInteger, if, unless ])

Parameters

Parameter	Type	Required	Default	Description
`properties`	`string`	No		Name of property or list of property names to validate against (can also be called with the `property` argument).
`message`	`string`	No	`[property] is not a number`	Supply a custom error message here to override the built-in one.
`when`	`string`	No	`onSave`	Pass in `onCreate` or `onUpdate` to limit when this validation occurs (by default validation will occur on both create and update, i.e. `onSave`).
`allowBlank`	`boolean`	No	`false`	If set to `true`, validation will be skipped if the property value is an empty string or doesn't exist at all.
`onlyInteger`	`boolean`	No	`false`	Specifies whether the property value has to be an integer.
`if`	`string`	No		String expression to be evaluated that decides if validation will be run (if the expression returns `true` validation will run).
`unless`	`string`	No		String expression to be evaluated that decides if validation will be run (if the expression returns `false` validation will run).

Examples

<!--- Make sure that the score is a number with no decimals but only when a score is supplied (setting `allowBlank` to `true` means that objects are allowed to be saved without scores, typically resulting in `NULL` values being inserted in the database table) --->
<cfset validatesNumericalityOf(property="score", onlyInteger=true, allowBlank=true, message="Please enter a correct score.")>