File Source for Length.php

<?php
/**
* Formagic
*
* LICENCE
*
* This source file is subject to the new BSD license that is bundled
* with this package in the file LICENSE.txt.
* It is also available through the world-wide-web at
* http://formagic.weasle.de/licence.txt
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to licence@weasle.de so we can send you a copy immediately.
*
* @category Formagic
* @package Rule
* @author Marc Schrader
* @author Florian Sonnenburg
* @copyright Copyright (c) 2007 Florian Sonnenburg
* @license http://formagic.weasle.de/licence.txt New BSD License
* @revision $Revision: 17 $
*/
require_once('Rule.php');
/**
* 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:
* - addRule('mandatory')
* // any length will do
*
* - addRule('mandatory', 'errorMessage', 10);
* // at least 10 characters
*
* - addRule('mandatory', 'errorMessage', array('min' => 1));
* // same as addRule('mandatory')
*
* - addRule('mandatory', 'errorMessage', array('max' => 10));
* // 1 to 10 characters
*
* - addRule('mandatory', 'errorMessage', array('min' => 5, 'max' => 10));
* // 5 to 10 characters
*
* @category Formagic
* @package Rule
* @author Marc Schrader
* @author Florian Sonnenburg
* @copyright Copyright (c) 2007 Marc Schrader
* @version $Id: Length.php 17 2007-08-19 20:40:10Z meweasle $
***/
class Formagic_Rule_Length extends Formagic_Rule
{
/**
* Default error messages
* @var array
***/
private $_errorMessages = array(
'min' => 'Bitte mindestens %MIN% Zeichen eingeben',
'max' => 'Bitte maximal %MAX% Zeichen eingeben',
'both' => 'Eingabe muss zwischen %MIN% und %MAX% Zeichen haben',
'mandatory' => 'Bitte Wert eingeben'
);
/**
* Default error code
* @var integer
***/
protected $_errorCode = 1;
/**
* Tells what kind of violation occured
* @var integer
***/
private $_violation;
/**
* Extends parent constructor
*
* @param string $type
* @param array $args
* @return void
***/
public function __construct($type, $errorMessage=null, $args=null)
{
parent::__construct($type, $errorMessage, $args);
if (is_array($errorMessage)) {
if ( !isset($errorMessage['min'])
|| !isset($errorMessage['max'])
|| !isset($errorMessage['both'])
|| !isset($errorMessage['mandatory'])
) {
throw new Formagic_Exception('Error message has to be array with ' .
'keys "min", "max", "both" and "mandatory"');
}
$this->_errorMessages = $errorMessage;
} elseif($errorMessage) {
$this->_errorMessages['min'] = $errorMessage;
$this->_errorMessages['max'] = $errorMessage;
$this->_errorMessages['both'] = $errorMessage;
$this->_errorMessages['mandatory'] = $errorMessage;
}
}
/**
* Performs rule check
*
* Length rule checks if value is between min and max length.
* (integer)_args['min']: Min length
* (integer)_args['max']: Max length
*
* @param Formagic_Item $itemObj
* @return boolean
***/
public function check($item)
{
$this->_violatedType = null;
$value = $item->getValue();
// check if value has to be entered for the rule to be valid
if ( !$value
&& !$item->hasRule('mandatory')
&& !isset($this->_args['mandatory'])
) {
return true;
}
// no arguments --> any length will do
if (is_null($this->_args)) {
$this->_args['min'] = 1;
}
if (!is_array($this->_args)) {
if (is_numeric($this->_args)) {
$this->_args = array('min' => $this->_args);
} else {
throw new Formagic_Exception('Argument has to be array or numeric');
}
}
$length = strlen($value);
// Check min and max length
if ( isset($this->_args['min'])
&& isset($this->_args['max'])
) {
if ( $length >= (int)$this->_args['min']
&& $length <= (int)$this->_args['max']
) {
return true;
} else {
$this->_errorMessage = str_replace(
array('%MIN%', '%MAX%'),
array((int)$this->_args['min'], (int)$this->_args['max']),
$this->_errorMessages['both']);
return false;
}
}
// only max length given
if (isset($this->_args['max'])) {
if ($length <= (int)$this->_args['max']) {
return true;
} else {
$this->_errorMessage = str_replace(
'%MAX%',
(int)$this->_args['max'],
$this->_errorMessages['max']);
return false;
}
}
// only min length given
if (isset($this->_args['min'])) {
if ($length >= (int)$this->_args['min']) {
return true;
} else {
$this->_errorMessage = str_replace(
'%MIN%',
(int)$this->_args['min'],
$this->_errorMessages['min']);
return false;
}
}
// no min, no max --> mandatory rule applies
$this->_errorMessage = $this->_errorMessages['mandatory'];
return false;
}
}

Source for file Length.php