improved validator documentation

fixes #7472
This commit is contained in:
Carsten Brandt
2015-02-26 18:39:39 +01:00
parent c0e0ba0004
commit e83b479dfb
4 changed files with 17 additions and 10 deletions

View File

@@ -28,18 +28,23 @@ class StringValidator extends Validator
* This will overwrite [[min]].
* - an array of two elements: the minimum and maximum lengths that the value should be of.
* For example, `[8, 128]`. This will overwrite both [[min]] and [[max]].
* @see tooShort for the customized message for a too short string.
* @see tooLong for the customized message for a too long string.
* @see notEqual for the customized message for a string that does not match desired length.
*/
public $length;
/**
* @var integer maximum length. If not set, it means no maximum length limit.
* @see tooLong for the customized message for a too long string.
*/
public $max;
/**
* @var integer minimum length. If not set, it means no minimum length limit.
* @see tooShort for the customized message for a too short string.
*/
public $min;
/**
* @var string user-defined error message used when the value is not a string
* @var string user-defined error message used when the value is not a string.
*/
public $message;
/**