/mvc/components/validation
[return to app]1
<?php
/**
* Validation Class. Used for validation of model data
*
* PHP versions 5
*
* This is CakePHP's validation class updated to PHP5 syntax for Vork. It also has
* some imported methods as functions from multibyte class (see end of file).
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @package cake
* @subpackage cake.cake.libs
* @since CakePHP(tm) v 1.2.0.3830
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
/**
* Offers different validation methods.
*
* @package cake
* @subpackage cake.cake.libs
* @since CakePHP v 1.2.0.3830
*/
class validationComponent {
/**
* Set the value of methods $check param.
*
* @var string
* @access public
*/
public $check = null;
/**
* Set to a valid regular expression in the class methods.
* Can be set from $regex param also
*
* @var string
* @access public
*/
public $regex = null;
/**
* Some complex patterns needed in multiple places
*
* @var array
* @access private
*/
protected $_pattern = array(
'hostname' =>
'(?:[a-z\d][-a-z\d]*\.)*(?:[a-z\d][-a-z\d]{0,62})\.(?:(?:[a-z]{2}\.)?[a-z]{2,4}|museum|travel)'
);
/**
* Some class methods use a country to determine proper validation.
* This can be passed to methods in the $country param
*
* @var string
* @access public
*/
public $country = null;
/**
* Some class methods use a deeper validation when set to true
*
* @var string
* @access public
*/
public $deep = null;
/**
* Some class methods use the $type param to determine which validation to perfom in the method
*
* @var string
* @access public
*/
public $type = null;
/**
* Holds an array of errors messages set in this class.
* These are used for debugging purposes
*
* @var array
* @access public
*/
public $errors = array();
/**
* Checks that a string contains something other than whitespace
*
* Returns true if string contains something other than whitespace
*
* $check can be passed as an array:
* array('check' => 'valueToCheck');
*
* @param mixed $check Value to check
* @return boolean Success
* @access public
*/
public function notEmpty($check) {
$this->_reset();
$this->check = $check;
if (is_array($check)) {
$this->_extract($check);
}
if (empty($this->check) && $this->check != '0') {
return false;
}
$this->regex = '/[^\s]+/m';
return $this->_check();
}
/**
* Checks that a string contains only integer or letters
*
* Returns true if string contains only integer or letters
*
* $check can be passed as an array:
* array('check' => 'valueToCheck');
*
* @param mixed $check Value to check
* @return boolean Success
* @access public
*/
public function alphaNumeric($check) {
$this->_reset();
$this->check = $check;
if (is_array($check)) {
$this->_extract($check);
}
if (empty($this->check) && $this->check != '0') {
return false;
}
$this->regex = '/^[\p{Ll}\p{Lm}\p{Lo}\p{Lt}\p{Lu}\p{Nd}]+$/mu';
return $this->_check();
}
/**
* Checks that a string length is within s specified range.
* Spaces are included in the character count.
* Returns true is string matches value min, max, or between min and max,
*
* @param string $check Value to check for length
* @param integer $min Minimum value in range (inclusive)
* @param integer $max Maximum value in range (inclusive)
* @return boolean Success
* @access public
*/
public function between($check, $min, $max) {
$length = self::mb_strlen($check);
return ($length >= $min && $length <= $max);
}
/**
* Returns true if field is left blank -OR- only whitespace characters are present in it's value
* Whitespace characters include Space, Tab, Carriage Return, Newline
*
* $check can be passed as an array:
* array('check' => 'valueToCheck');
*
* @param mixed $check Value to check
* @return boolean Success
* @access public
*/
public function blank($check) {
$this->_reset();
$this->check = $check;
if (is_array($check)) {
$this->_extract($check);
}
$this->regex = '/[^\\s]/';
return !$this->_check();
}
/**
* Validation of credit card numbers.
* Returns true if $check is in the proper credit card format.
*
* @param mixed $check credit card number to validate
* @param mixed $type 'all' may be passed as a sting, defaults to fast which checks format of most major
credit
* cards if an array is used only the values of the array are checked.
* Example: array('amex', 'bankcard', 'maestro')
* @param boolean $deep set to true this will check the Luhn algorithm of the credit card.
* @param string $regex A custom regex can also be passed, this will be used instead of the defined regex
values
* @return boolean Success
* @access public
* @see validationComponent::_luhn()
*/
public function cc($check, $type = 'fast', $deep = false, $regex = null) {
$this->_reset();
$this->check = $check;
$this->type = $type;
$this->deep = $deep;
$this->regex = $regex;
if (is_array($check)) {
$this->_extract($check);
}
$this->check = str_replace(array('-', ' '), '', $this->check);
if (self::mb_strlen($this->check) < 13) {
return false;
}
if (!is_null($this->regex)) {
if ($this->_check()) {
return $this->_luhn();
}
}
$cards = array(
'all' => array(
'amex' => '/^3[4|7]\\d{13}$/',
'bankcard' => '/^56(10\\d\\d|022[1-5])\\d{10}$/',
'diners' => '/^(?:3(0[0-5]|[68]\\d)\\d{11})|(?:5[1-5]\\d{14})$/',
'disc' => '/^(?:6011|650\\d)\\d{12}$/',
'electron' => '/^(?:417500|4917\\d{2}|4913\\d{2})\\d{10}$/',
'enroute' => '/^2(?:014|149)\\d{11}$/',
'jcb' => '/^(3\\d{4}|2100|1800)\\d{11}$/',
'maestro' => '/^(?:5020|6\\d{3})\\d{12}$/',
'mc' => '/^5[1-5]\\d{14}$/',
'solo' => '/^(6334[5-9][0-9]|6767[0-9]{2})\\d{10}(\\d{2,3})?$/',
'switch' => '/^(?:49(03(0[2-9]|3[5-9])|11(0[1-2]|7[4-9]|8[1-2])' .
'|36[0-9]{2})\\d{10}(\\d{2,3})?)|(?:564182\\d{10}' .
'(\\d{2,3})?)|(6(3(33[0-4][0-9])|759[0-9]{2})\\d{10}(\\d{2,3})?)$/',
'visa' => '/^4\\d{12}(\\d{3})?$/',
'voyager' => '/^8699[0-9]{11}$/'
),
'fast' => '/^(?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|6011[0-9]{12}' .
'|3(?:0[0-5]|[68][0-9])[0-9]{11}|3[47][0-9]{13})$/'
);
if (is_array($this->type)) {
foreach ($this->type as $value) {
$this->regex = $cards['all'][strtolower($value)];
if ($this->_check()) {
return $this->_luhn();
}
}
} elseif ($this->type == 'all') {
foreach ($cards['all'] as $value) {
$this->regex = $value;
if ($this->_check()) {
return $this->_luhn();
}
}
} else {
$this->regex = $cards['fast'];
if ($this->_check()) {
return $this->_luhn();
}
}
}
/**
* Used to compare 2 numeric values.
*
* @param mixed $check1 if string is passed for a string must also be passed for $check2
* used as an array it must be passed as array('check1' => value, 'operator' => 'value', 'check2' -> value)
* @param string $operator Can be either a word or operand
* is greater >, is less <, greater or equal >=
* less or equal <=, is less <, equal to ==, not equal !=
* @param integer $check2 only needed if $check1 is a string
* @return boolean Success
* @access public
*/
public function comparison($check1, $operator = null, $check2 = null) {
if (is_array($check1)) {
extract($check1, EXTR_OVERWRITE);
}
$operator = str_replace(array(' ', "\t", "\n", "\r", "\0", "\x0B"), '', strtolower($operator));
switch ($operator) {
case 'isgreater':
case '>':
if ($check1 > $check2) {
return true;
}
break;
case 'isless':
case '<':
if ($check1 < $check2) {
return true;
}
break;
case 'greaterorequal':
case '>=':
if ($check1 >= $check2) {
return true;
}
break;
case 'lessorequal':
case '<=':
if ($check1 <= $check2) {
return true;
}
break;
case 'equalto':
case '==':
if ($check1 == $check2) {
return true;
}
break;
case 'notequal':
case '!=':
if ($check1 != $check2) {
return true;
}
break;
default:
$this->errors[] = 'You must define the $operator parameter for ' .
'validationComponent::comparison()';
break;
}
return false;
}
/**
* Used when a custom regular expression is needed.
*
* @param mixed $check When used as a string, $regex must also be a valid regular expression.
* As and array: array('check' => value, 'regex' => 'valid regular expression')
* @param string $regex If $check is passed as a string, $regex must also be set to valid regular expression
* @return boolean Success
* @access public
*/
public function custom($check, $regex = null) {
$this->_reset();
$this->check = $check;
$this->regex = $regex;
if (is_array($check)) {
$this->_extract($check);
}
if ($this->regex === null) {
$this->errors[] = 'You must define a regular expression for validationComponent::custom()';
return false;
}
return $this->_check();
}
/**
* Date validation, determines if the string passed is a valid date.
* keys that expect full month, day and year will validate leap years
*
* @param string $check a valid date string
* @param mixed $format Use a string or an array of the keys below.
* Arrays should be passed as array('dmy', 'mdy', etc)
* Keys: dmy 27-12-2006 or 27-12-06 separators can be a space, period, dash, forward slash
* mdy 12-27-2006 or 12-27-06 separators can be a space, period, dash, forward slash
* ymd 2006-12-27 or 06-12-27 separators can be a space, period, dash, forward slash
* dMy 27 December 2006 or 27 Dec 2006
* Mdy December 27, 2006 or Dec 27, 2006 comma is optional
* My December 2006 or Dec 2006
* my 12/2006 separators can be a space, period, dash, forward slash
* @param string $regex If a custom regular expression is used this is the only validation that will occur.
* @return boolean Success
* @access public
*/
public function date($check, $format = 'ymd', $regex = null) {
$this->_reset();
$this->check = $check;
$this->regex = $regex;
if (!is_null($this->regex)) {
return $this->_check();
}
$regex['dmy'] = '%^(?:(?:31(\\/|-|\\.|\\x20)(?:0?[13578]|1[02]))\\1|(?:(?:29|30)(\\/|-|\\.|\\x20)' .
'(?:0?[1,3-9]|1[0-2])\\2))(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$|^(?:29(\\/|-|\\.|\\x20)0?2' .
'\\3(?:(?:(?:1[6-9]|[2-9]\\d)?(?:0[48]|[2468][048]|[13579][26])|(?:(?:16|[2468][048]' .
'|[3579][26])00))))$|^(?:0?[1-9]|1\\d|2[0-8])(\\/|-|\\.|\\x20)(?:(?:0?[1-9])' .
'|(?:1[0-2]))\\4(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$%';
$regex['mdy'] = '%^(?:(?:(?:0?[13578]|1[02])(\\/|-|\\.|\\x20)31)\\1|(?:(?:0?[13-9]|1[0-2])' .
'(\\/|-|\\.|\\x20)(?:29|30)\\2))(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$' .
'|^(?:0?2(\\/|-|\\.|\\x20)29\\3(?:(?:(?:1[6-9]|[2-9]\\d)?(?:0[48]' .
'|[2468][048]|[13579][26])|(?:(?:16|[2468][048]|[3579][26])00))))$|' .
'^(?:(?:0?[1-9])|(?:1[0-2]))(\\/|-|\\.|\\x20)(?:0?[1-9]|1\\d|2[0-8])' .
'\\4(?:(?:1[6-9]|[2-9]\\d)?\\d{2})$%';
$regex['ymd'] = '%^(?:(?:(?:(?:(?:1[6-9]|[2-9]\\d)?(?:0[48]|[2468][048]|[13579][26])' .
'|(?:(?:16|[2468][048]|[3579][26])00)))(\\/|-|\\.|\\x20)(?:0?2\\1(?:29)))' .
'|(?:(?:(?:1[6-9]|[2-9]\\d)?\\d{2})(\\/|-|\\.|\\x20)(?:(?:(?:0?[13578]|1[02])' .
'\\2(?:31))|(?:(?:0?[1,3-9]|1[0-2])\\2(29|30))|(?:(?:0?[1-9])|(?:1[0-2]))\\2' .
'(?:0?[1-9]|1\\d|2[0-8]))))$%';
$regex['dMy'] = '/^((31(?!\\ (Feb(ruary)?|Apr(il)?|June?|(Sep(?=\\b|t)t?|Nov)(ember)?)))' .
'|((30|29)(?!\\ Feb(ruary)?))' .
'|(29(?=\\ Feb(ruary)?\\ (((1[6-9]|[2-9]\\d)(0[48]|[2468][048]|[13579][26])' .
'|((16|[2468][048]|[3579][26])00)))))|(0?[1-9])|1\\d|2[0-8])\\ ' .
'(Jan(uary)?|Feb(ruary)?|Ma(r(ch)?|y)|Apr(il)?|Ju((ly?)|(ne?))|Aug(ust)?' .
'|Oct(ober)?|(Sep(?=\\b|t)t?|Nov|Dec)(ember)?)\\ ((1[6-9]|[2-9]\\d)\\d{2})$/';
$regex['Mdy'] = '/^(?:(((Jan(uary)?|Ma(r(ch)?|y)|Jul(y)?|Aug(ust)?|Oct(ober)?|Dec(ember)?)\\ 31)' .
'|((Jan(uary)?|Ma(r(ch)?|y)|Apr(il)?|Ju((ly?)|(ne?))|Aug(ust)?|Oct(ober)?' .
'|(Sept|Nov|Dec)(ember)?)\\ (0?[1-9]|([12]\\d)|30))|(Feb(ruary)?\\ ' .
'(0?[1-9]|1\\d|2[0-8]|(29(?=,?\\ ((1[6-9]|[2-9]\\d)(0[48]|[2468][048]|[13579][26])' .
'|((16|[2468][048]|[3579][26])00)))))))\\,?\\ ((1[6-9]|[2-9]\\d)\\d{2}))$/';
$regex['My'] = '%^(Jan(uary)?|Feb(ruary)?|Ma(r(ch)?|y)|Apr(il)?|Ju((ly?)|(ne?))|Aug(ust)?|Oct(ober)?|' .
'(Sep(?=\\b|t)t?|Nov|Dec)(ember)?)[ /]((1[6-9]|[2-9]\\d)\\d{2})$%';
$regex['my'] = '%^(((0[123456789]|10|11|12)([- /.])(([1][9][0-9][0-9])|([2][0-9][0-9][0-9]))))$%';
$format = (is_array($format)) ? array_values($format) : array($format);
foreach ($format as $key) {
$this->regex = $regex[$key];
if ($this->_check() === true) {
return true;
}
}
return false;
}
/**
* Time validation, determines if the string passed is a valid time.
* Validates time as 24hr (HH:MM) or am/pm ([H]H:MM[a|p]m)
* Does not allow/validate seconds.
*
* @param string $check a valid time string
* @return boolean Success
* @access public
*/
public function time($check) {
$this->_reset();
$this->check = $check;
$this->regex = '%^((0?[1-9]|1[012])(:[0-5]\d){0,2}([AP]M|[ap]m))$|^([01]\d|2[0-3])(:[0-5]\d){0,2}$%';
return $this->_check();
}
/**
* Boolean validation, determines if value passed is a boolean integer or true/false.
*
* @param string $check a valid boolean
* @return boolean Success
* @access public
*/
public function boolean($check) {
$booleanList = array(0, 1, '0', '1', true, false);
return in_array($check, $booleanList, true);
}
/**
* Checks that a value is a valid decimal. If $places is null, the $check is allowed to be a scientific float
* If no decimal point is found a false will be returned. Both the sign and exponent are optional.
*
* @param integer $check The value the test for decimal
* @param integer $places if set $check value must have exactly $places after the decimal point
* @param string $regex If a custom regular expression is used this is the only validation that will occur.
* @return boolean Success
* @access public
*/
public function decimal($check, $places = null, $regex = null) {
$this->_reset();
$this->regex = $regex;
$this->check = $check;
if (is_null($this->regex)) {
if (is_null($places)) {
$this->regex = '/^[-+]?[0-9]*\\.{1}[0-9]+(?:[eE][-+]?[0-9]+)?$/';
} else {
$this->regex = '/^[-+]?[0-9]*\\.{1}[0-9]{'.$places.'}$/';
}
}
return $this->_check();
}
/**
* Validates for an email address.
*
* @param string $check Value to check
* @param boolean $deep Perform a deeper validation (if true), by also checking availability of host
* @param string $regex Regex to use (if none it will use built in regex)
* @return boolean Success
* @access public
*/
public function email($check, $deep = false, $regex = null) {
$this->_reset();
$this->check = $check;
$this->regex = $regex;
$this->deep = $deep;
if (is_array($check)) {
$this->_extract($check);
}
if (is_null($this->regex)) {
$this->regex = '/^[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&\'*+\/=?^_`{|}~-]+)*@'
. $this->_pattern['hostname'] . '$/i';
}
$return = $this->_check();
if ($this->deep === false || $this->deep === null) {
return $return;
}
if ($return === true && preg_match('/@(' . $this->_pattern['hostname'] . ')$/i', $this->check, $regs)) {
if (function_exists('getmxrr') && getmxrr($regs[1], $mxhosts)) {
return true;
}
if (function_exists('checkdnsrr') && checkdnsrr($regs[1], 'MX')) {
return true;
}
return is_array(gethostbynamel($regs[1]));
}
return false;
}
/**
* Check that value is exactly $comparedTo.
*
* @param mixed $check Value to check
* @param mixed $comparedTo Value to compare
* @return boolean Success
* @access public
*/
public function equalTo($check, $comparedTo) {
return ($check === $comparedTo);
}
/**
* Check that value has a valid file extension.
*
* @param mixed $check Value to check
* @param array $extensions file extenstions to allow
* @return boolean Success
* @access public
*/
public function extension($check, $extensions = array('gif', 'jpeg', 'png', 'jpg')) {
if (is_array($check)) {
return self::extension(array_shift($check), $extensions);
}
$extension = strtolower(array_pop(explode('.', $check)));
foreach ($extensions as $value) {
if ($extension == strtolower($value)) {
return true;
}
}
return false;
}
/**
* Validation of an IP address.
*
* Valid IP version strings for type restriction are:
* - both: Check both IPv4 and IPv6, return true if the supplied address matches either version
* - IPv4: Version 4 (Eg: 127.0.0.1, 192.168.10.123, 203.211.24.8)
* - IPv6: Version 6 (Eg: ::1, 2001:0db8::1428:57ab)
*
* @param string $check The string to test.
* @param string $type The IP Version to test against
* @return boolean Success
* @access public
*/
public function ip($check, $type = 'both') {
$success = false;
$type = strtolower($type);
if ($type === 'ipv4' || $type === 'both') {
$success |= $this->_ipv4($check);
}
if ($type === 'ipv6' || $type === 'both') {
$success |= $this->_ipv6($check);
}
return $success;
}
/**
* Validation of IPv4 addresses.
*
* @param string $check IP Address to test
* @return boolean Success
* @access protected
*/
protected function _ipv4($check) {
if (function_exists('filter_var')) {
return filter_var($check, FILTER_VALIDATE_IP, array('flags' => FILTER_FLAG_IPV4)) !== false;
}
$this->_populateIp();
$this->check = $check;
$this->regex = '/^' . $this->_pattern['IPv4'] . '$/';
return $this->_check();
}
/**
* Validation of IPv6 addresses.
*
* @param string $check IP Address to test
* @return boolean Success
* @access protected
*/
protected function _ipv6($check) {
if (function_exists('filter_var')) {
return filter_var($check, FILTER_VALIDATE_IP, array('flags' => FILTER_FLAG_IPV6)) !== false;
}
$this->_populateIp();
$this->check = $check;
$this->regex = '/^' . $this->_pattern['IPv6'] . '$/';
return $this->_check();
}
/**
* Checks whether the length of a string is greater or equal to a minimal length.
*
* @param string $check The string to test
* @param integer $min The minimal string length
* @return boolean Success
* @access public
*/
public function minLength($check, $min) {
$length = self::mb_strlen($check);
return ($length >= $min);
}
/**
* Checks whether the length of a string is smaller or equal to a maximal length..
*
* @param string $check The string to test
* @param integer $max The maximal string length
* @return boolean Success
* @access public
*/
public function maxLength($check, $max) {
$length = self::mb_strlen($check);
return ($length <= $max);
}
/**
* Checks that a value is a monetary amount.
*
* @param string $check Value to check
* @param string $symbolPosition Where symbol is located (left/right)
* @return boolean Success
* @access public
*/
public function money($check, $symbolPosition = 'left') {
$this->check = $check;
if ($symbolPosition == 'right') {
$this->regex = '/^(?!0,?\d)(?:\d{1,3}(?:([, .])\d{3})?(?:\1\d{3})*' .
'|(?:\d+))((?!\1)[,.]\d{2})?(?<!\x{00a2})\p{Sc}?$/u';
} else {
$this->regex = '/^(?!\x{00a2})\p{Sc}?(?!0,?\d)(?:\d{1,3}(?:([, .])\d{3})?' .
'(?:\1\d{3})*|(?:\d+))((?!\1)[,.]\d{2})?$/u';
}
return $this->_check();
}
/**
* Validate a multiple select.
*
* Valid Options
*
* - in => provide a list of choices that selections must be made from
* - max => maximun number of non-zero choices that can be made
* - min => minimum number of non-zero choices that can be made
*
* @param mixed $check Value to check
* @param mixed $options Options for the check.
* @return boolean Success
* @access public
*/
public function multiple($check, $options = array()) {
$defaults = array('in' => null, 'max' => null, 'min' => null);
$options = array_merge($defaults, $options);
$check = array_filter((array)$check);
if (empty($check)) {
return false;
}
if ($options['max'] && count($check) > $options['max']) {
return false;
}
if ($options['min'] && count($check) < $options['min']) {
return false;
}
if ($options['in'] && is_array($options['in'])) {
foreach ($check as $val) {
if (!in_array($val, $options['in'])) {
return false;
}
}
}
return true;
}
/**
* Checks if a value is numeric.
*
* @param string $check Value to check
* @return boolean Succcess
* @access public
*/
public function numeric($check) {
return is_numeric($check);
}
/**
* Check that a value is a valid phone number.
*
* @param mixed $check Value to check (string or array)
* @param string $regex Regular expression to use
* @param string $country Country code (defaults to 'all')
* @return boolean Success
* @access public
*/
public function phone($check, $regex = null, $country = 'all') {
$this->check = $check;
$this->regex = $regex;
$this->country = $country;
if (is_array($check)) {
$this->_extract($check);
}
if (is_null($this->regex)) {
switch ($this->country) {
case 'us':
case 'all':
case 'can':
// includes all NANPA members. see
// http://en.wikipedia.org/wiki/North_American_Numbering_Plan#List_of_NANPA_countries_and_territories
$this->regex = '/^(?:\+?1)?[-. ]?\\(?[2-9][0-8][0-9]\\)?[-. ]?[2-9][0-9]{2}[-. ]?[0-9]{4}$/';
break;
}
}
if (empty($this->regex)) {
return $this->_pass('phone', $check, $country);
}
return $this->_check();
}
/**
* Checks that a given value is a valid postal code.
*
* @param mixed $check Value to check
* @param string $regex Regular expression to use
* @param string $country Country to use for formatting
* @return boolean Success
* @access public
*/
public function postal($check, $regex = null, $country = null) {
$this->check = $check;
$this->regex = $regex;
$this->country = $country;
if (is_array($check)) {
$this->_extract($check);
}
if (empty($country)) {
$this->country = 'us';
}
if (is_null($this->regex)) {
switch ($this->country) {
case 'uk':
$this->regex = '/\\A\\b[A-Z]{1,2}[0-9][A-Z0-9]? [0-9][ABD-HJLNP-UW-Z]{2}\\b\\z/i';
break;
case 'ca':
$this->regex = '/\\A\\b[ABCEGHJKLMNPRSTVXY][0-9][A-Z] ?[0-9][A-Z][0-9]\\b\\z/i';
break;
case 'it':
case 'de':
$this->regex = '/^[0-9]{5}$/i';
break;
case 'be':
$this->regex = '/^[1-9]{1}[0-9]{3}$/i';
break;
case 'us':
$this->regex = '/\\A\\b[0-9]{5}(?:-[0-9]{4})?\\b\\z/i';
break;
}
}
if (empty($this->regex)) {
return $this->_pass('postal', $check, $country);
}
return $this->_check();
}
/**
* Validate that a number is in specified range.
* if $lower and $upper are not set, will return true if
* $check is a legal finite on this platform
*
* @param string $check Value to check
* @param integer $lower Lower limit
* @param integer $upper Upper limit
* @return boolean Success
* @access public
*/
public function range($check, $lower = null, $upper = null) {
if (!is_numeric($check)) {
return false;
}
if (isset($lower) && isset($upper)) {
return ($check > $lower && $check < $upper);
}
return is_finite($check);
}
/**
* Checks that a value is a valid Social Security Number.
*
* @param mixed $check Value to check
* @param string $regex Regular expression to use
* @param string $country Country
* @return boolean Success
* @access public
*/
public function ssn($check, $regex = null, $country = null) {
$this->check = $check;
$this->regex = $regex;
$this->country = $country;
if (is_array($check)) {
$this->_extract($check);
}
if (is_null($this->regex)) {
switch ($this->country) {
case 'dk':
$this->regex = '/\\A\\b[0-9]{6}-[0-9]{4}\\b\\z/i';
break;
case 'nl':
$this->regex = '/\\A\\b[0-9]{9}\\b\\z/i';
break;
case 'us':
$this->regex = '/\\A\\b[0-9]{3}-[0-9]{2}-[0-9]{4}\\b\\z/i';
break;
}
}
if (empty($this->regex)) {
return $this->_pass('ssn', $check, $country);
}
return $this->_check();
}
/**
* Checks that a value is a valid uuid - http://tools.ietf.org/html/rfc4122
*
* @param string $check Value to check
* @return boolean Success
* @access public
*/
public function uuid($check) {
$this->check = $check;
$this->regex = '/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i';
return $this->_check();
}
/**
* Checks that a value is a valid URL according to http://www.w3.org/Addressing/URL/url-spec.txt
*
* The regex checks for the following component parts:
*
* - a valid, optional, scheme
* - a valid ip address OR
* a valid domain name as defined by section 2.3.1 of http://www.ietf.org/rfc/rfc1035.txt
* with an optional port number
* - an optional valid path
* - an optional query string (get parameters)
* - an optional fragment (anchor tag)
*
* @param string $check Value to check
* @param boolean $strict Require URL to be prefixed by a valid scheme (one of
http(s)/ftp(s)/file/news/gopher)
* @return boolean Success
* @access public
*/
public function url($check, $strict = false) {
$this->_populateIp();
$this->check = $check;
$validChars = '([' . preg_quote('!"$&\'()*+,-.@_:;=~') . '\/0-9a-z]|(%[0-9a-f]{2}))';
$this->regex = '/^(?:(?:https?|ftps?|file|news|gopher):\/\/)' . (!empty($strict) ? '' : '?') .
'(?:' . $this->_pattern['IPv4'] . '|\[' . $this->_pattern['IPv6'] . '\]|' .
$this->_pattern['hostname'] . ')' .
'(?::[1-9][0-9]{0,4})?' .
'(?:\/?|\/' . $validChars . '*)?' .
'(?:\?' . $validChars . '*)?' .
'(?:#' . $validChars . '*)?$/i';
return $this->_check();
}
/**
* Checks if a value is in a given list.
*
* @param string $check Value to check
* @param array $list List to check against
* @return boolean Succcess
* @access public
*/
public function inList($check, $list) {
return in_array($check, $list);
}
/**
* Runs an user-defined validation.
*
* @param mixed $check value that will be validated in user-defined methods.
* @param object $object class that holds validation method
* @param string $method class method name for validation to run
* @param array $args arguments to send to method
* @return mixed user-defined class class method returns
* @access public
*/
public function userDefined($check, $object, $method, $args = null) {
return call_user_func_array(array(&$object, $method), array($check, $args));
}
/**
* Attempts to pass unhandled Validation locales to a class starting with $classPrefix
* and ending with ValidationComponent. For example $classPrefix = 'nl', the class would be
* `NlValidationComponent`.
*
* @param string $method The method to call on the other class.
* @param mixed $check The value to check or an array of parameters for the method to be called.
* @param string $classPrefix The prefix for the class to do the validation.
* @return mixed Return of Passed method, false on failure
* @access protected
**/
protected function _pass($method, $check, $classPrefix) {
$className = ucwords($classPrefix) . 'ValidationComponent';
if (!class_exists($className)) {
trigger_error(sprintf('Could not find %s class, unable to complete validation.',
$className),
E_USER_WARNING);
return false;
}
if (!is_callable(array($className, $method))) {
trigger_error(sprintf('Method %s does not exist on %s unable to complete validation.',
$method, $className),
E_USER_WARNING);
return false;
}
$check = (array)$check;
return call_user_func_array(array($className, $method), $check);
}
/**
* Runs a regular expression match.
*
* @return boolean Success of match
* @access protected
*/
protected function _check() {
if (preg_match($this->regex, $this->check)) {
$this->error[] = false;
return true;
} else {
$this->error[] = true;
return false;
}
}
/**
* Get the values to use when value sent to validation method is
* an array.
*
* @param array $params Parameters sent to validation method
* @return void
* @access protected
*/
protected function _extract($params) {
extract($params, EXTR_OVERWRITE);
if (isset($check)) {
$this->check = $check;
}
if (isset($regex)) {
$this->regex = $regex;
}
if (isset($country)) {
$this->country = mb_strtolower($country);
}
if (isset($deep)) {
$this->deep = $deep;
}
if (isset($type)) {
$this->type = $type;
}
}
/**
* Luhn algorithm
*
* @see http://en.wikipedia.org/wiki/Luhn_algorithm
* @return boolean Success
* @access protected
*/
protected function _luhn() {
if ($this->deep !== true) {
return true;
}
if ($this->check == 0) {
return false;
}
$sum = 0;
$length = strlen($this->check);
for ($position = 1 - ($length % 2); $position < $length; $position += 2) {
$sum += $this->check[$position];
}
for ($position = ($length % 2); $position < $length; $position += 2) {
$number = $this->check[$position] * 2;
$sum += ($number < 10) ? $number : $number - 9;
}
return ($sum % 10 == 0);
}
/*
* Lazily populate the IP address patterns used for validations
*
* @return void
* @access private
*/
protected function _populateIp() {
if (!isset($this->_pattern['IPv6'])) {
$pattern = '((([0-9A-Fa-f]{1,4}:){7}(([0-9A-Fa-f]{1,4})|:))|(([0-9A-Fa-f]{1,4}:){6}';
$pattern .= '(:|((25[0-5]|2[0-4]\d|[01]?\d{1,2})(\.(25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})';
$pattern .= '|(:[0-9A-Fa-f]{1,4})))|(([0-9A-Fa-f]{1,4}:){5}((:((25[0-5]|2[0-4]\d|[01]?\d{1,2})';
$pattern .=
'(\.(25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|((:[0-9A-Fa-f]{1,4}){1,2})))|(([0-9A-Fa-f]{1,4}:)';
$pattern .= '{4}(:[0-9A-Fa-f]{1,4}){0,1}((:((25[0-5]|2[0-4]\d|[01]?\d{1,2})(\.(25[0-5]|2[0-4]\d' .
'|[01]?\d{1,2}))';
$pattern .= '{3})?)|((:[0-9A-Fa-f]{1,4}){1,2})))|(([0-9A-Fa-f]{1,4}:){3}(:[0-9A-Fa-f]{1,4}){0,2}';
$pattern .= '((:((25[0-5]|2[0-4]\d|[01]?\d{1,2})(\.(25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|';
$pattern .= '((:[0-9A-Fa-f]{1,4}){1,2})))|(([0-9A-Fa-f]{1,4}:){2}(:[0-9A-Fa-f]{1,4}){0,3}';
$pattern .= '((:((25[0-5]|2[0-4]\d|[01]?\d{1,2})(\.(25[0-5]|2[0-4]\d|[01]?\d{1,2}))';
$pattern .= '{3})?)|((:[0-9A-Fa-f]{1,4}){1,2})))|(([0-9A-Fa-f]{1,4}:)(:[0-9A-Fa-f]{1,4})';
$pattern .= '{0,4}((:((25[0-5]|2[0-4]\d|[01]?\d{1,2})(\.(25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)';
$pattern .= '|((:[0-9A-Fa-f]{1,4}){1,2})))|(:(:[0-9A-Fa-f]{1,4}){0,5}((:((25[0-5]|2[0-4]';
$pattern .= '\d|[01]?\d{1,2})(\.(25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})?)|((:[0-9A-Fa-f]{1,4})';
$pattern .=
'{1,2})))|(((25[0-5]|2[0-4]\d|[01]?\d{1,2})(\.(25[0-5]|2[0-4]\d|[01]?\d{1,2})){3})))(%.+)?';
$this->_pattern['IPv6'] = $pattern;
}
if (!isset($this->_pattern['IPv4'])) {
$pattern = '(?:(?:25[0-5]|2[0-4][0-9]|(?:(?:1[0-9])?|[1-9]?)[0-9])\.){3}' .
'(?:25[0-5]|2[0-4][0-9]|(?:(?:1[0-9])?|[1-9]?)[0-9])';
$this->_pattern['IPv4'] = $pattern;
}
}
/**
* Reset internal variables for another validation run.
*
* @return void
* @access private
*/
protected function _reset() {
$this->check = null;
$this->regex = null;
$this->country = null;
$this->deep = null;
$this->type = null;
$this->error = array();
$this->errors = array();
}
/**
* mb_strlen() wrapper, in case mbstring module is not loaded
*
* @param string $string String to check for length
* @param string $encoding String encoding
* @return integer String length
* @access public
*/
public function mb_strlen($string, $encoding = null) {
if (function_exists('mb_strlen')) {
return mb_strlen($string, $encoding);
}
if ($this->mb_checkmultibyte($string)) {
$string = $this->mb_utf8($string);
return count($string);
}
return strlen($string);
}
/**
* Check if a string is a multibyte string
*
* @param string $string String to check for
* @return boolean True if it's multibyte
* @access public
*/
public function mb_checkmultibyte($string) {
$length = strlen($string);
for ($i = 0; $i < $length; $i++ ) {
$value = ord(($string[$i]));
if ($value > 128) {
return true;
}
}
return false;
}
/**
* Converts a multibyte string into an array,
* each character as an item of the array.
*
* @param string $string String to convert
* @return array The characters of the string
* @access public
*/
public function mb_utf8($string) {
$map = array();
$values = array();
$find = 1;
$length = strlen($string);
for ($i = 0; $i < $length; $i++) {
$value = ord($string[$i]);
if ($value < 128) {
$map[] = $value;
} else {
if (empty($values)) {
$find = ($value < 224) ? 2 : 3;
}
$values[] = $value;
if (count($values) === $find) {
if ($find == 3) {
$map[] = (($values[0] % 16) * 4096) + (($values[1] % 64) * 64) + ($values[2] % 64);
} else {
$map[] = (($values[0] % 32) * 64) + ($values[1] % 64);
}
$values = array();
$find = 1;
}
}
}
return $map;
}
}