spunQ_ArrayLengthValidator Class Reference

Ensures that a returned array's size is within given limits. More...

Inheritance diagram for spunQ_ArrayLengthValidator:

List of all members.

Public Member Functions
	__construct ($min=NULL, $max=NULL, $messageKey= 'InvalidLength')
	Constructor.
	validate ($messagePrefix, $value)
	Does the validation.
	showJsValidationString ($typePath, $messagePrefix)
	Prints javascript for this validator.
Protected Attributes
	$min
	Minimum array length.
	$max
	Maximum array length.
	$messageKey
	Translation key for the error message.

---

Detailed Description

Ensures that a returned array's size is within given limits.

Definition at line 6 of file ArrayLengthValidator.class.php.

---

Constructor & Destructor Documentation

spunQ_ArrayLengthValidator::__construct	(	$	min = NULL,
		$	max = NULL,
		$	messageKey = 'InvalidLength'
	)

Constructor.

Parameters:

	$min	Minimum array length.
	$max	Maximum array length.
	$messageKey	Translation key for the error message to be displayed if the value is invalid. The translation will recieve three parameters: actual array length, minimum array length and maximum array length.

Definition at line 29 of file ArrayLengthValidator.class.php.

---

Member Function Documentation

spunQ_FieldValidator::showJsValidationString	(	$	typePath,
		$	messagePrefix
	)			[inherited]

Prints javascript for this validator.

Should make use a call to the spunQ javascript function spunQ.form.registerValidator().

Parameters:

$messagePrefix

A string to prepend to the error message key.

Returns:

boolean Whether any validation javascript was displayed.

Implements spunQ_IFieldValidator.

Reimplemented in spunQ_StringLengthValidator.

Definition at line 29 of file FieldValidator.class.php.

spunQ_ArrayLengthValidator::validate	(	$	messagePrefix,
		$	value
	)

Does the validation.

Parameters:

	$messagePrefix	A string to prepend to the error message key.
	$value	The spunQ value to validate.

Returns:

string Error message for the validated field, or NULL if the value was valid.

Implements spunQ_IFieldValidator.

Definition at line 39 of file ArrayLengthValidator.class.php.

---

Member Data Documentation

spunQ_ArrayLengthValidator::$max [protected]

Maximum array length.

Type:

integer

Definition at line 18 of file ArrayLengthValidator.class.php.

spunQ_FieldValidator::$messageKey [protected, inherited]

Translation key for the error message.

Type:

string

Definition at line 14 of file FieldValidator.class.php.

spunQ_ArrayLengthValidator::$min [protected]

Minimum array length.

Type:

integer

Definition at line 12 of file ArrayLengthValidator.class.php.

---

The documentation for this class was generated from the following file:

• ArrayLengthValidator.class.php