validatesInclusionOf()

Signature

validatesInclusionOf() — returns any

Description

Validates that the value of the specified property exists in the supplied list.

Parameters

Name	Type	Required	Default	Description
properties	string	yes	—	Name of property or list of property names to validate against (can also be called with the property argument).
list	string	yes	—	List of allowed values.
message	string	yes	[property] is not included in the list	Supply a custom error message here to override the built-in one.
when	string	yes	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	yes	false	If set to true, validation will be skipped if the property value is an empty string or doesn’t exist at all. This is useful if you only want to run this validation after it passes the validatesPresenceOf test, thus avoiding duplicate error messages if it doesn’t.
condition	string	yes	—	String expression to be evaluated that decides if validation will be run (if the expression returns true validation will run).
unless	string	yes	—	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 user selects either "CFWheels" or "Rails" as their framework validatesInclusionOf( property="frameworkOfChoice", list="cfwheels,rails", message="Please try again, and this time, select a decent framework!" );