Source for file Validate.php
Documentation is available at Validate.php
* Copyright (c) 1997-2006 Pierre-Alain Joye,Tomas V.V.Cox, Amir Saied
* This source file is subject to the New BSD license, That is bundled
* with this package in the file LICENSE, and is available through
* http://www.opensource.org/licenses/bsd-license.php
* If you did not receive a copy of the new BSDlicense and are unable
* to obtain it through the world-wide-web, please send a note to
* pajoye@php.net so we can mail you a copy immediately.
* Author: Tomas V.V.Cox <cox@idecnet.com>
* Pierre-Alain Joye <pajoye@php.net>
* Amir Mohammad Saied <amir@php.net>
* Package to validate various datas. It includes :
* - numbers (min/max, decimal or not)
* - email (syntax, domain check)
* - string (predifined type alpha upper and/or lowercase, numeric,...)
* - date (min, max, rfc822 compliant)
* - possibility valid multiple data with a single method call (::multiple)
* @author Tomas V.V.Cox <cox@idecnet.com>
* @author Pierre-Alain Joye <pajoye@php.net>
* @author Amir Mohammad Saied <amir@php.net>
* @copyright 1997-2006 Pierre-Alain Joye,Tomas V.V.Cox,Amir Mohammad Saied
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version CVS: $Id: Validate.php,v 1.134 2009/01/28 12:27:33 davidc Exp $
* @link http://pear.php.net/package/Validate
* Methods for common data validations
define('VALIDATE_NUM', '0-9');
define('VALIDATE_SPACE', '\s');
define('VALIDATE_ALPHA_LOWER', 'a-z');
define('VALIDATE_ALPHA_UPPER', 'A-Z');
define('VALIDATE_ALPHA', VALIDATE_ALPHA_LOWER . VALIDATE_ALPHA_UPPER );
define('VALIDATE_EALPHA_LOWER', VALIDATE_ALPHA_LOWER . 'áéíóúýàèìòùäëïöüÿâêîôûãñõ¨åæç½ðøþß');
define('VALIDATE_EALPHA_UPPER', VALIDATE_ALPHA_UPPER . 'ÁÉÍÓÚÝÀÈÌÒÙÄËÏÖܾÂÊÎÔÛÃÑÕ¦ÅÆÇ¼ÐØÞ');
define('VALIDATE_EALPHA', VALIDATE_EALPHA_LOWER . VALIDATE_EALPHA_UPPER );
define('VALIDATE_PUNCTUATION', VALIDATE_SPACE . '\.,;\:&"\'\?\!\(\)');
define('VALIDATE_NAME', VALIDATE_EALPHA . VALIDATE_SPACE . "'" . "-");
define('VALIDATE_STREET', VALIDATE_NUM . VALIDATE_NAME . "/\\ºª\.");
define('VALIDATE_ITLD_EMAILS', 1 );
define('VALIDATE_GTLD_EMAILS', 2 );
define('VALIDATE_CCTLD_EMAILS', 4 );
define('VALIDATE_ALL_EMAILS', 8 );
* Package to validate various datas. It includes :
* - numbers (min/max, decimal or not)
* - email (syntax, domain check)
* - string (predifined type alpha upper and/or lowercase, numeric,...)
* - possibility valid multiple data with a single method call (::multiple)
* @author Tomas V.V.Cox <cox@idecnet.com>
* @author Pierre-Alain Joye <pajoye@php.net>
* @author Amir Mohammad Saied <amir@php.net>
* @copyright 1997-2006 Pierre-Alain Joye,Tomas V.V.Cox,Amir Mohammad Saied
* @license http://www.opensource.org/licenses/bsd-license.php New BSD License
* @version Release: @package_version@
* @link http://pear.php.net/package/Validate
* International Top-Level Domain
* This is an array of the known international
* top-level domain names.
* @var array $_iTld (International top-level domains)
* Generic top-level domain
* This is an array of the official
* generic top-level domains.
* @var array $_gTld (Generic top-level domains)
* Country code top-level domains
* This is an array of the official country
* codes top-level domains
* @var array $_ccTld (Country Code Top-Level Domain)
* Validate a tag URI (RFC4151)
* @param string $uri tag URI to validate
* @return boolean true if valid tag URI, false if not
function __uriRFC4151 ($uri)
'/^tag:(?<name>.*),(?<date>\d{4}-?\d{0,2}-?\d{0,2}):(?<specific>.*)(.*:)*$/', $uri, $matches)) {
$date = $matches['date'];
if (self ::email ($matches['name'])) {
$namevalid = self ::email ('info@' . $matches['name']);
return $datevalid && $namevalid;
* @param string $number Number to validate
* @param array $options array where:
* 'decimal' is the decimal char or false when decimal
* i.e. ',.' to allow both ',' and '.'
* 'dec_prec' Number of allowed decimals
* @return boolean true if valid number, false if not
function number($number, $options = array ())
$decimal = $dec_prec = $min = $max = null;
$dec_prec = $dec_prec ? " {1,$dec_prec}" : '+';
$dec_regex = $decimal ? " [$decimal][0-9]$dec_prec" : '';
if (!preg_match(" |^[-+]?\s*[0-9]+($dec_regex)?\$|" , $number)) {
$number = strtr($number, $decimal, '.');
if ($min !== null && $min > $number) {
if ($max !== null && $max < $number) {
* Converting a string to UTF-7 (RFC 2152)
* @param string $string string to be converted
* @return string converted string
function __stringToUtf7 ($string)
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J', 'K',
'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V',
'W', 'X', 'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f', 'g',
'h', 'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r',
's', 't', 'u', 'v', 'w', 'x', 'y', 'z', '0', '1', '2',
'3', '4', '5', '6', '7', '8', '9', '+', ','
while ($i <= strlen($string)) {
$char = substr($string, $i, 1 );
if ((ord($char) >= 0x7F ) || (ord($char) <= 0x1F )) {
} elseif ($char == '&') {
} elseif (($i == strlen($string) ||
!((ord($char) >= 0x7F )) || (ord($char) <= 0x1F ))) {
$return .= $utf7[ord($char)];
$return .= $utf7[ord($char) >> 2 ];
$residue = (ord($char) & 0x03 ) << 4;
$return .= $utf7[$residue | (ord($char) >> 4 )];
$residue = (ord($char) & 0x0F ) << 2;
$return .= $utf7[$residue | (ord($char) >> 6 )];
$return .= $utf7[ord($char) & 0x3F ];
* Validate an email according to full RFC822 (inclusive human readable part)
* @param string $email email to validate,
* will return the address for optional dns validation
* @param array $options email() options
* @return boolean true if valid email, false if not
function __emailRFC822 (&$email, &$options)
static $uncomment = null;
// atom = 1*<any CHAR except specials, SPACE and CTLs>
$atom = '[^][()<>@,;:\\".\s\000-\037\177-\377]+\s*';
// qtext = <any CHAR excepting <">, ; => may be folded
// "\" & CR, and including linear-white-space>
// quoted-pair = "\" CHAR ; may quote any char
// quoted-string = <"> *(qtext/quoted-pair) <">; Regular qtext or
$quoted_string = '"(?:' . $qtext . '|' . $quoted_pair . ')*"\s*';
// word = atom / quoted-string
$word = '(?:' . $atom . '|' . $quoted_string . ')';
// local-part = word *("." word) ; uninterpreted
$local_part = $word . '(?:\.\s*' . $word . ')*';
// dtext = <any CHAR excluding "[", ; => may be folded
// "]", "\" & CR, & including linear-white-space>
// domain-literal = "[" *(dtext / quoted-pair) "]"
$domain_literal = '\[(?:' . $dtext . '|' . $quoted_pair . ')*\]\s*';
// sub-domain = domain-ref / domain-literal
// domain-ref = atom ; symbolic reference
$sub_domain = '(?:' . $atom . '|' . $domain_literal . ')';
// domain = sub-domain *("." sub-domain)
$domain = $sub_domain . '(?:\.\s*' . $sub_domain . ')*';
// addr-spec = local-part "@" domain ; global address
$addr_spec = $local_part . '@\s*' . $domain;
// route = 1#("@" domain) ":" ; path-relative
$route = '@' . $domain . '(?:,@\s*' . $domain . ')*:\s*';
// route-addr = "<" [route] addr-spec ">"
$route_addr = '<\s*(?:' . $route . ')?' . $addr_spec . '>\s*';
// phrase = 1*word ; Sequence of words
// mailbox = addr-spec ; simple address
// / phrase route-addr ; name & addr-spec
$mailbox = '(?:' . $addr_spec . '|' . $phrase . $route_addr . ')';
// group = phrase ":" [#mailbox] ";"
$group = $phrase . ':\s*(?:' . $mailbox . '(?:,\s*' . $mailbox . ')*)?;\s*';
// address = mailbox ; one addressee
$address = '/^\s*(?:' . $mailbox . '|' . $group . ')$/';
'/((?:(?:\\\\"|[^("])*(?:' . $quoted_string .
')?)*)((?<!\\\\)\((?:(?2)|.)*?(?<!\\\\)\))/';
$email = preg_replace ($uncomment, '$1 ', $email);
* Full TLD Validation function
* This function is used to make a much more proficient validation
* against all types of official domain names.
* @param string $email The email address to check.
* @param array $options The options for validation
* @return bool True if validating succeeds
if(!empty ($options["VALIDATE_ITLD_EMAILS"])) array_push($validate, 'itld');
if(!empty ($options["VALIDATE_GTLD_EMAILS"])) array_push($validate, 'gtld');
if(!empty ($options["VALIDATE_CCTLD_EMAILS"])) array_push($validate, 'cctld');
foreach ($validate as $valid) {
$tmpVar = '_' . (string) $valid;
$toValidate[$valid] = $self->{$tmpVar};
$e = $self->executeFullEmailValidation ($email, $toValidate);
* This function will execute the full email vs tld
* validation using an array of tlds passed to it.
* @param string $email The email to validate.
* @param array $arrayOfTLDs The array of the TLDs to validate
* @return true or false (Depending on if it validates or if it does not)
$emailEnding = explode('.', $email);
$emailEnding = $emailEnding[count($emailEnding)-1 ];
foreach ($arrayOfTLDs as $validator => $keys) {
* @param string $email email to validate
* @param mixed boolean (BC) $check_domain Check or not if the domain exists
* array $options associative array of options
* 'check_domain' boolean Check or not if the domain exists
* 'use_rfc822' boolean Apply the full RFC822 grammar
* 'check_domain' => 'true',
* 'fullTLDValidation' => 'true',
* 'use_rfc822' => 'true',
* 'VALIDATE_GTLD_EMAILS' => 'true',
* 'VALIDATE_CCTLD_EMAILS' => 'true',
* 'VALIDATE_ITLD_EMAILS' => 'true',
* @return boolean true if valid email, false if not
function email($email, $options = null )
$check_domain = $options;
* Check for IDN usage so we can encode the domain as Punycode
if (@include_once('Net/IDNA.php')) {
if (strpos($email, '@') !== false ) {
list ($name, $domain) = explode('@', $email, 2 );
// Check if the domain contains characters > 127 which means
// it's an idn domain name.
$idna = & Net_IDNA ::singleton ();
$domain = $idna->encode ($domain);
$email = " $name@$domain";
* @todo Fix bug here.. even if it passes this, it won't be passing
* The regular expression below
if (isset ($fullTLDValidation)) {
//$valid = Validate::_fullTLDValidation($email, $fullTLDValidation);
// the base regexp for address
$regex = '&^(?: # recipient:
("\s*(?:[^"\f\n\r\t\v\b\s]+\s*)+")| #1 quoted name
([-\w!\#\$%\&\'*+~/^`|{}]+(?:\.[-\w!\#\$%\&\'*+~/^`|{}]+)*)) #2 OR dot-atom
@(((\[)? #3 domain, 4 as IPv4, 5 optionally bracketed
(?:(?:(?:(?:25[0-5])|(?:2[0-4][0-9])|(?:[0-1]?[0-9]?[0-9]))\.){3}
(?:(?:25[0-5])|(?:2[0-4][0-9])|(?:[0-1]?[0-9]?[0-9]))))(?(5)\])|
((?:[a-z0-9](?:[-a-z0-9]*[a-z0-9])?\.)*[a-z0-9](?:[-a-z0-9]*[a-z0-9])?) #6 domain as hostname
\.((?:([^- ])[-a-z]*[-a-z]))) #7 TLD
//checks if exists the domain (MX or A)
if ($use_rfc822? Validate::__emailRFC822 ($email, $options) :
list ($account, $domain) = explode('@', $email);
* Validate a string using the given format 'format'
* @param string $string String to validate
* @param array $options Options array where:
* 'format' is the format of the string
* Ex:VALIDATE_NUM . VALIDATE_ALPHA (see constants)
* 'min_length' minimum length
* 'max_length' maximum length
* @return boolean true if valid string, false if not
function string($string, $options)
if ($format && !preg_match(" |^[$format]*\$|s" , $string)) {
if ($min_length && strlen($string) < $min_length) {
if ($max_length && strlen($string) > $max_length) {
* Validate an URI (RFC2396)
* This function will validate 'foobarstring' by default, to get it to validate
* only http, https, ftp and such you have to pass it in the allowed_schemes
* $options = array('allowed_schemes' => array('http', 'https', 'ftp'))
* var_dump(Validate::uri('http://www.example.org', $options));
* NOTE 1: The rfc2396 normally allows middle '-' in the top domain
* e.g. http://example.co-m should be valid
* However, as '-' is not used in any known TLD, it is invalid
* NOTE 2: As double shlashes // are allowed in the path part, only full URIs
* including an authority can be valid, no relative URIs
* the // are mandatory (optionally preceeded by the 'sheme:' )
* NOTE 3: the full complience to rfc2396 is not achieved by default
* the characters ';/?:@$,' will not be accepted in the query part
* if not urlencoded, refer to the option "strict'"
* @param string $url URI to validate
* @param array $options Options used by the validation method.
* 'domain_check' => boolean
* Whether to check the DNS entry or not
* 'allowed_schemes' => array, list of protocols
* List of allowed schemes ('http',
* 'strict' => string the refused chars
* in query and fragment parts
* empty: accept all rfc2396 foreseen chars
* @return boolean true if valid uri, false if not
function uri($url, $options = null )
if (strpos($url, "tag:") === 0 ) {
return self ::__uriRFC4151 ($url);
'&^(?:([a-z][-+.a-z0-9]*):)? # 1. scheme
(?:((?:%[0-9a-f]{2}|[-a-z0-9_.!~*\'();:\&=+$,])*)@)? # 2. authority-userinfo
(?:((?:[a-z0-9](?:[-a-z0-9]*[a-z0-9])?\.)*[a-z](?:[a-z0-9]+)?\.?) # 3. authority-hostname OR
|([0-9]{1,3}(?:\.[0-9]{1,3}){3})) # 4. authority-ipv4
(?::([0-9]*))?) # 5. authority-port
((?:/(?:%[0-9a-f]{2}|[-a-z0-9_.!~*\'():@\&=+$,;])*)*/?)? # 6. path
(?:\?([^#]*))? # 7. query
(?:\#((?:%[0-9a-f]{2}|[-a-z0-9_.!~*\'();/?:@\&=+$,])*))? # 8. fragment
$&xi', $url, $matches)) {
$scheme = isset ($matches[1 ]) ? $matches[1 ] : '';
$authority = isset ($matches[3 ]) ? $matches[3 ] : '' ;
if (!empty ($matches[4 ])) {
$parts = explode('.', $matches[4 ]);
foreach ($parts as $part) {
if ((!empty ($matches[7 ]) && preg_match($strict, $matches[7 ]))
|| (!empty ($matches[8 ]) && preg_match($strict, $matches[8 ]))) {
* Validate date and times. Note that this method need the Date_Calc class
* @param string $date Date to validate
* @param array $options array options where :
* 'format' The format of the date (%d-%m-%Y)
* 'min' The date has to be greater
* than this array($day, $month, $year)
* 'max' The date has to be smaller than
* this array($day, $month, $year)
* @return boolean true if valid date/time, false if not
function date($date, $options)
$preg = '&^(?:(Mon|Tue|Wed|Thu|Fri|Sat|Sun),) \s+
(?:(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)?) \s+
(?:(\d{2}?)):(?:(\d{2}?))(:(?:(\d{2}?)))? \s+
(?:[+-]\d{4}|UT|GMT|EST|EDT|CST|CDT|MST|MDT|PST|PDT|[A-IK-Za-ik-z])$&xi';
$year = (int) $matches[4 ];
$months = array ('Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec');
$month = (int) $month[0 ]+1;
$hour = (int) $matches[6 ];
$minute = (int) $matches[7 ];
isset ($matches[9 ]) ? $second = (int) $matches[9 ] : $second = 0;
($day > 31 || $day < 1 )||
for ($i = 0; $i < $date_len; $i++ ) {
$day = (int) Validate::_substr ($date, 1 , 2 );
$day = (int) Validate::_substr ($date, 0 , 2 );
if ($day < 1 || $day > 31 ) {
$month = (int) Validate::_substr ($date, 0 , 2 );
$month = (int) Validate::_substr ($date, 1 , 2 );
if ($month < 1 || $month > 12 ) {
$year = (int) $year? $year: '';
if (strlen($year) != 4 || $year < 0 || $year > 9999 ) {
if (!preg_match('/^\d+$/', $hour) || $hour < 0 || $hour > 12 ) {
if (!preg_match('/^\d+$/', $hour) || $hour < 0 || $hour > 24 ) {
if (!preg_match('/^\d+$/', $t) || $t < 0 || $t > 59 ) {
trigger_error(" Not supported char `$next' after % in offset " . ($i+2 ), E_USER_WARNING );
if (Validate::_substr ($date, 1 ) != $c) {
// there is remaing data, we don't want it
if (isset ($day) && isset ($month) && isset ($year)) {
if ($weekday != date("D", mktime(0 , 0 , 0 , $month, $day, $year))) {
include_once 'Date/Calc.php';
if (is_a($min, 'Date') &&
(Date_Calc ::compareDates ($day, $month, $year,
$min->getDay (), $min->getMonth (), $min->getYear ()) < 0 )
(Date_Calc ::compareDates ($day, $month, $year,
$min[0 ], $min[1 ], $min[2 ]) < 0 )
include_once 'Date/Calc.php';
if (is_a($max, 'Date') &&
(Date_Calc ::compareDates ($day, $month, $year,
$max->getDay (), $max->getMonth (), $max->getYear ()) > 0 )
(Date_Calc ::compareDates ($day, $month, $year,
$max[0 ], $max[1 ], $max[2 ]) > 0 )
* @param string &$date Date
* @param string $num Length
* @param string $opt Unknown
function _substr (&$date, $num, $opt = false )
if ($opt && strlen($date) >= $opt && preg_match('/^[0-9]{'. $opt. '}/', $date, $m)) {
$ret = substr($date, 0 , $num);
function _modf ($val, $div)
return bcmod ($val, $div);
return intval($val - $i * $div + .1 );
* Calculates sum of product of number digits with weights
* @param string $number number string
* @param array $weights reference to array of weights
* @return int returns product of number digits with weights
if ($count == 0 ) { // empty string or weights array
for ($i = 0; $i < $count; ++ $i) {
* Calculates control digit for a given number
* @param string $number number string
* @param array $weights reference to array of weights
* @param int $modulo (optionsl) number
* @param int $subtract (optional) number
* @param bool $allow_high (optional) true if function can return number higher than 10
* @return int -1 calculated control number is returned
function _getControlNumber($number, &$weights, $modulo = 10 , $subtract = 0 , $allow_high = false )
$mod = Validate::_modf ($sum, $modulo); // calculate control digit
if ($subtract > $mod && $mod > 0 ) {
if ($allow_high === false ) {
$mod %= 10; // change 10 to zero
* @param string $number number to validate
* @param array $weights reference to array of weights
* @param int $modulo (optional) number
* @param int $subtract (optional) number
* @return bool true if valid, false if not
if ($control_digit == -1 ) {
if ($target_digit === 'X' && $control_digit == 10 ) {
if ($control_digit != $target_digit) {
* Bulk data validation for data introduced in the form of an
* assoc array in the form $var_name => $value.
* Can be used on any of Validate subpackages
* @param array $data Ex: array('name' => 'toto', 'email' => 'toto@thing.info');
* @param array $val_type Contains the validation type and all parameters used in.
* 'val_type' is not optional
* others validations properties must have the same name as the function
* Ex: array('toto'=>array('type'=>'string','format'='toto@thing.info','min_length'=>5));
* @param boolean $remove if set, the elements not listed in data will be removed
* @return array value name => true|false the value name comes from the data key
function multiple(&$data, &$val_type, $remove = false )
foreach ($keys as $var_name) {
if (!isset ($val_type[$var_name])) {
$opt = $val_type[$var_name];
$val2check = $data[$var_name];
// core validation method
//$opt[$opt['type']] = $data[$var_name];
$valid[$var_name] = call_user_func(array ('Validate', $method), $val2check, $opt);
* external validation method in the form:
* "<class name><underscore><method name>"
* Ex: us_ssn will include class Validate/US.php and call method ssn()
} elseif (strpos($opt['type'], '_') !== false ) {
$validateType = explode('_', $opt['type']);
$class = implode('_', $validateType);
$classPath = str_replace('_', DIRECTORY_SEPARATOR , $class);
$class = 'Validate_' . $class;
if (!@include_once " Validate/$classPath.php" ) {
trigger_error(" $class isn't installed or you may have some permissoin issues" , E_USER_ERROR );
Documentation generated on Fri, 13 Feb 2009 13:00:23 +0000 by phpDocumentor 1.4.2. PEAR Logo Copyright © PHP Group 2004.
|