Class: Formagic_Rule_NumericRange

Source Location: /Rule/NumericRange.php

Class Overview

Formagic_Rule_Abstract
   |
   --Formagic_Rule_RangeComparsion_Abstract
      |
      --Formagic_Rule_NumericRange

Checks if value is between min and max length

Author(s):

Florian Sonnenburg
Marc Schrader

Version:

$Id: NumericRange.php 126 2011-05-18 18:41:58Z meweasle $

Copyright:

Variables

$_messages

Methods

_getRange

Inherited Variables

Class: Formagic_Rule_RangeComparsion_Abstract

Formagic_Rule_RangeComparsion_Abstract::$_max
Formagic_Rule_RangeComparsion_Abstract::$_min

Class: Formagic_Rule_Abstract

Formagic_Rule_Abstract::$_message
Formagic_Rule_Abstract::$_name

Inherited Methods

Class: Formagic_Rule_RangeComparsion_Abstract

Formagic_Rule_RangeComparsion_Abstract::setMessage(): setMessage not supported by range comparison rules.
Formagic_Rule_RangeComparsion_Abstract::setMessages(): Sets messages array
Formagic_Rule_RangeComparsion_Abstract::validate(): Performs rule check
Formagic_Rule_RangeComparsion_Abstract::_execBetween()
Formagic_Rule_RangeComparsion_Abstract::_execMax()
Formagic_Rule_RangeComparsion_Abstract::_execMin()
Formagic_Rule_RangeComparsion_Abstract::_getMessage(): Returns a translates message string.
Formagic_Rule_RangeComparsion_Abstract::_getRange(): Returns range check value.
Formagic_Rule_RangeComparsion_Abstract::_init(): Allows subclass initialization.

Class: Formagic_Rule_Abstract

Formagic_Rule_Abstract::__construct(): Constructor
Formagic_Rule_Abstract::getMessage(): Returns translated error message of rule
Formagic_Rule_Abstract::getName(): Returns rule type identification string.
Formagic_Rule_Abstract::setMessage(): Sets the error message property.
Formagic_Rule_Abstract::validate(): Abstract of main validate method. Returns boolean value of check success.
Formagic_Rule_Abstract::_init(): Allows subclass initialization.

Class Details

[line 61]
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));

Tags:

author:	Florian Sonnenburg
author:	Marc Schrader
version:	$Id: NumericRange.php 126 2011-05-18 18:41:58Z meweasle $
copyright:	Copyright (c) 2007-2011 Florian Sonnenburg

[ Top ]

Class Variables

$_messages = 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'
    )

[line 67]

Default error messages

Tags:

access:

protected

Type:	array
Overrides:	Array

[ Top ]

Class Methods

method _getRange [line 79]

integer _getRange(
string
$value)

Returns value as integer.

Tags:

return:	Item value as integer
access:	protected

Overrides Formagic_Rule_RangeComparsion_Abstract::_getRange() (Returns range check value.)

Parameters:

string

$value

Item value

[ Top ]

Documentation generated on Sun, 22 May 2011 22:40:18 +0200 by phpDocumentor 1.4.3

Class: Formagic_Rule_NumericRange

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: Formagic_Rule_RangeComparsion_Abstract

Class: Formagic_Rule_Abstract

Inherited Methods

Class: Formagic_Rule_RangeComparsion_Abstract

Class: Formagic_Rule_Abstract

Class Details

Tags:

Class Variables

$_messages = 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' )

Tags:

Class Methods

method _getRange [line 79]

Tags:

Parameters:

$_messages = 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'
)