validatesLengthOf()

Signature

validatesLengthOf() — returns any

Description

Validates that the value of the specified property matches the length requirements supplied. Use the exactly, maximum, minimum and within arguments to specify the length requirements.

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).
message	string	yes	[property] is the wrong length	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.
exactly	numeric	yes	0	The exact length that the property value must be.
maximum	numeric	yes	0	The maximum length that the property value can be.
minimum	numeric	yes	0	The minimum length that the property value can be.
within	string	yes	—	A list of two values (minimum and maximum) that the length of the property value must fall within.
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 `firstname` and `lastName` properties are not more than
// 50 characters and use square brackets to dynamically insert the property
// name when the error message is displayed to the user. (The `firstName`
// property will be displayed as "first name".)
validatesLengthOf(
    properties="firstName,lastName",
    maximum=50,
    message="Please shorten your [property] please (50 characters max)."
);

// Make sure that the `password` property is between 4 and 15 characters
validatesLengthOf(
    property="password",
    within="4,20",
    message="The password length must be between 4 and 20 characters."
);