Formagic
Back to top  

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: Formagic_Rule_StringLength::__construct(array(

 'min' => (int)$min,
 'max' => (int)$max,
 'messages' => array(
     'min' => (string)$errorMessage,
     'min' => (string)$errorMessage,
     'between' => (string)$errorMessage,
 )

)); Formagic_Rule_StringLength::__construct(array('min' => (int)$min, 'max' => (int)$max));

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
Inherited

Subclasses have to implement their behavior here.

Parameters

$value

string

The value to be validated.

Returns

booleanThe rule check result

Evaluate between range (including limits).

_execBetween(integer $range) : boolean
Inherited

Parameters

$range

integer

Range value

Returns

booleanEvaluation result

Evaluate maximum range (lessers or equals).

_execMax(integer $range) : boolean
Inherited

Parameters

$range

integer

Upper limit

Returns

booleanEvaluation result

Evaluate minimum range (greater or equals).

_execMin(integer $range) : boolean
Inherited

Parameters

$range

integer

Lower limit

Returns

booleanEvaluation result

Returns a translates message string.

_getMessage(string $key) : string
Inherited

Parameters

$key

string

Message type

Returns

stringTranslated filled message

Returns range check value.

_getRange(string $value) : integer
inherited_from \Formagic_Rule_RangeComparison_Abstract::_getRange()

Parameters

$value

string

Item value

Returns

integerRange check value

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 at least %s characters', 'max' => 'Please enter no more than %s characters', 'between' => 'Please enter between %s and %s characters')
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

Default