Formagic » \Formagic_Rule

Checks if value is between min and max length

If only one numeric value is passed as argument, this value is interpreted as min length value.

Supported arguments are:

(integer)min: Minimum length of submitted value
(integer)max: Maximum length of submitted value

Usage examples: // at least 10 characters $item->addRule('NumericRange', array('min' => 10));


// effectively the same as addRule('mandatory')
$item->addRule('NumericRange', array('min' => 1));
// 0 to 10 characters
$item->addRule('NumericRange', array('max' => 10));

// 5 to 10 characters $item->addRule('NumericRange', array('min' => 5, 'max' => 10));

package	Formagic\Rule
author	Marc Schrader
author	Florian Sonnenburg
since	1.0.0 First time introduced
inherited_from	\Formagic_Rule_RangeComparison_Abstract

Methods

Constructor

__construct(array $arguments = array())

Inherited

The default error message that is displayed if the rule is violated can be overwritten by $errorMessage.

see

Parameters

$arguments

array

The rule options.

Returns translated error message of rule

getMessage() : string

Inherited

Returns

stringMessage string

Returns rule type identification string.

getName() : string

Inherited

Returns

stringThe rule name

Sets the error message property.

setMessage(mixed $message) : \Formagic_Rule_Abstract

Inherited

Usually a rule will have one error message string that is used if the validation fails. If neccessary, Formagic_Rule_Abstract::_errorMessage can hold other variables, eg. an array of error messages for different outcomes of the validation process.

Implements a fluent interface pattern.

see

Parameters

$message

mixed

The error message value.

Returns

\Formagic_Rule_Abstract$this object.

Sets messages array

setMessages(array $messages) : \Formagic_Rule_RangeComparison_Abstract

Inherited

Parameters

$messages

array

Array of messages

Returns

\Formagic_Rule_RangeComparison_Abstract

Abstract of main validate method. Returns boolean value of check success.

validate(string $value) : boolean

_getRange(string $value) : integer

inherited_from	\Formagic_Rule_RangeComparison_Abstract::_getRange()

Parameters

$value

string

Item value

Returns

integerItem value as integer

Returns range check value.

_getRange(string $value) : mixed

Inherited

Parameters

$value

string

Item value

Returns

mixedCheck range value

Allows subclass initialization.

_init(array $arguments) : void

Inherited

Parameters

$arguments

array

Array of arguments passed to __construct()

Checks if value is not entered by a user or if the field has not been assigned to the form.

_isNoUserValue($value) : boolean

Inherited

The value 0 (zero) for example could be something the user entered willingly and would be skipped from rule checks when using empty().

Parameters

$value

mixed Value to be checked

Returns

boolean

Properties

The maximal length

$_max : integer

Default

Message string

$_message : string

Default

'Please enter a valid value'

Default error messages

$_messages : array

Default

array('min' => 'Please enter a value higher than %s', 'max' => 'Please enter a value lower than %s', 'between' => 'Please enter a value between %s and %s')

inherited_from	\Formagic_Rule_RangeComparison_Abstract::_messages

Array of messages

$_messages : array

Default

array('min' => '', 'max' => '', 'between' => '')

The minimal length

$_min : integer

Default

Rule type identifier.

$_name : string