/**
* Validate a value against a CustomField type.
*
* @param string $type
* The type of the data.
* @param string $value
* The data to be validated.
*
* @return bool
* True if the value is of the specified type
*/
public static function typecheck($type, $value)
{
switch ($type) {
case 'Memo':
return TRUE;
case 'String':
return CRM_Utils_Rule::string($value);
case 'Int':
return CRM_Utils_Rule::integer($value);
case 'Float':
case 'Money':
return CRM_Utils_Rule::numeric($value);
case 'Date':
if (is_numeric($value)) {
return CRM_Utils_Rule::dateTime($value);
} else {
return CRM_Utils_Rule::date($value);
}
case 'Boolean':
return CRM_Utils_Rule::boolean($value);
case 'ContactReference':
return CRM_Utils_Rule::validContact($value);
case 'StateProvince':
//fix for multi select state, CRM-3437
$valid = FALSE;
$mulValues = explode(',', $value);
foreach ($mulValues as $key => $state) {
$valid = array_key_exists(strtolower(trim($state)), array_change_key_case(array_flip(CRM_Core_PseudoConstant::stateProvinceAbbreviation()), CASE_LOWER)) || array_key_exists(strtolower(trim($state)), array_change_key_case(array_flip(CRM_Core_PseudoConstant::stateProvince()), CASE_LOWER));
if (!$valid) {
break;
}
}
return $valid;
case 'Country':
//fix multi select country, CRM-3437
$valid = FALSE;
$mulValues = explode(',', $value);
foreach ($mulValues as $key => $country) {
$valid = array_key_exists(strtolower(trim($country)), array_change_key_case(array_flip(CRM_Core_PseudoConstant::countryIsoCode()), CASE_LOWER)) || array_key_exists(strtolower(trim($country)), array_change_key_case(array_flip(CRM_Core_PseudoConstant::country()), CASE_LOWER));
if (!$valid) {
break;
}
}
return $valid;
case 'Link':
return CRM_Utils_Rule::url($value);
}
return FALSE;
}
/**
* Validate a value against a CustomField type
*
* @param string $type The type of the data
* @param string $value The data to be validated
*
* @return boolean True if the value is of the specified type
* @access public
* @static
*/
function typecheck($type, $value)
{
switch ($type) {
case 'Memo':
return true;
case 'String':
return CRM_Utils_Rule::string($value);
case 'Int':
return CRM_Utils_Rule::integer($value);
case 'Float':
case 'Money':
return CRM_Utils_Rule::numeric($value);
case 'Date':
return CRM_Utils_Rule::date($value);
case 'Boolean':
return CRM_Utils_Rule::boolean($value);
case 'StateProvince':
return array_key_exists(strtolower($value), array_change_key_case(array_flip(CRM_Core_PseudoConstant::stateProvinceAbbreviation()), CASE_LOWER)) || array_key_exists(strtolower($value), array_change_key_case(array_flip(CRM_Core_PseudoConstant::stateProvince()), CASE_LOWER));
case 'Country':
return array_key_exists(strtolower($value), array_change_key_case(array_flip(CRM_Core_PseudoConstant::countryIsoCode()), CASE_LOWER)) || array_key_exists(strtolower($value), array_change_key_case(array_flip(CRM_Core_PseudoConstant::country()), CASE_LOWER));
}
return false;
}
/**
* function to check if an error in Core( non-custom fields ) field
*
* @param String $errorMessage A string containing all the error-fields.
*
* @access public
*/
function isErrorInCoreData($params, &$errorMessage)
{
require_once 'CRM/Core/OptionGroup.php';
foreach ($params as $key => $value) {
if ($value) {
$session =& CRM_Core_Session::singleton();
$dateType = $session->get("dateTypes");
switch ($key) {
case 'birth_date':
if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
if (!CRM_Utils_Rule::date($params[$key])) {
self::addToErrorMsg(ts('Birth Date'), $errorMessage);
}
} else {
self::addToErrorMsg(ts('Birth-Date'), $errorMessage);
}
break;
case 'deceased_date':
if (CRM_Utils_Date::convertToDefaultDate($params, $dateType, $key)) {
if (!CRM_Utils_Rule::date($params[$key])) {
self::addToErrorMsg(ts('Deceased Date'), $errorMessage);
}
} else {
self::addToErrorMsg(ts('Deceased Date'), $errorMessage);
}
break;
case 'is_deceased':
if (CRM_Utils_String::strtoboolstr($value) === false) {
self::addToErrorMsg(ts('Is Deceased'), $errorMessage);
}
break;
case 'gender':
if (!self::checkGender($value)) {
self::addToErrorMsg(ts('Gender'), $errorMessage);
}
break;
case 'preferred_communication_method':
$preffComm = array();
$preffComm = explode(',', $value);
foreach ($preffComm as $v) {
if (!self::in_value(trim($v), CRM_Core_PseudoConstant::pcm())) {
self::addToErrorMsg(ts('Preferred Communication Method'), $errorMessage);
}
}
break;
case 'preferred_mail_format':
if (!array_key_exists(strtolower($value), array_change_key_case(CRM_Core_SelectValues::pmf(), CASE_LOWER))) {
self::addToErrorMsg(ts('Preferred Mail Format'), $errorMessage);
}
break;
case 'individual_prefix':
if (!self::in_value($value, CRM_Core_PseudoConstant::individualPrefix())) {
self::addToErrorMsg(ts('Individual Prefix'), $errorMessage);
}
break;
case 'individual_suffix':
if (!self::in_value($value, CRM_Core_PseudoConstant::individualSuffix())) {
self::addToErrorMsg(ts('Individual Suffix'), $errorMessage);
}
break;
case 'state_province':
if (!empty($value)) {
foreach ($value as $stateValue) {
if ($stateValue['state_province']) {
if (self::in_value($stateValue['state_province'], CRM_Core_PseudoConstant::stateProvinceAbbreviation()) || self::in_value($stateValue['state_province'], CRM_Core_PseudoConstant::stateProvince())) {
continue;
} else {
self::addToErrorMsg(ts('State / Province'), $errorMessage);
}
}
}
}
break;
case 'country':
if (!empty($value)) {
foreach ($value as $stateValue) {
if ($stateValue['country']) {
CRM_Core_PseudoConstant::populate($countryNames, 'CRM_Core_DAO_Country', true, 'name', 'is_active');
CRM_Core_PseudoConstant::populate($countryIsoCodes, 'CRM_Core_DAO_Country', true, 'iso_code');
$config =& CRM_Core_Config::singleton();
$limitCodes = $config->countryLimit();
//If no country is selected in
//localization then take all countries
if (empty($limitCodes)) {
$limitCodes = $countryIsoCodes;
}
if (self::in_value($stateValue['country'], $limitCodes) || self::in_value($stateValue['country'], CRM_Core_PseudoConstant::country())) {
continue;
} else {
if (self::in_value($stateValue['country'], $countryIsoCodes) || self::in_value($stateValue['country'], $countryNames)) {
self::addToErrorMsg(ts('Country input value is in table but not "available": "This Country is valid but is NOT in the list of Available Countries currently configured for your site. This can be viewed and modifed from Global Settings >> Localization." '), $errorMessage);
} else {
self::addToErrorMsg(ts('Country input value not in country table: "The Country value appears to be invalid. It does not match any value in CiviCRM table of countries."'), $errorMessage);
}
}
}
}
}
break;
case 'geo_code_1':
if (!empty($value)) {
foreach ($value as $codeValue) {
if ($codeValue['geo_code_1']) {
if (CRM_Utils_Rule::numeric($codeValue['geo_code_1'])) {
continue;
} else {
self::addToErrorMsg(ts('Geo code 1'), $errorMessage);
}
}
}
}
break;
case 'geo_code_2':
if (!empty($value)) {
foreach ($value as $codeValue) {
if ($codeValue['geo_code_2']) {
if (CRM_Utils_Rule::numeric($codeValue['geo_code_2'])) {
continue;
} else {
self::addToErrorMsg(ts('Geo code 2'), $errorMessage);
}
}
}
}
break;
//check for any error in email/postal greeting, addressee,
//custom email/postal greeting, custom addressee, CRM-4575
//check for any error in email/postal greeting, addressee,
//custom email/postal greeting, custom addressee, CRM-4575
case 'email_greeting':
$emailGreetingFilter = array('contact_type' => $this->_contactType, 'greeting_type' => 'email_greeting');
if (!self::in_value($value, CRM_Core_PseudoConstant::greeting($emailGreetingFilter))) {
self::addToErrorMsg(ts('Email Greeting must be one of the configured format options. Check Administer >> Option Lists >> Email Greetings for valid values'), $errorMessage);
}
break;
case 'postal_greeting':
$postalGreetingFilter = array('contact_type' => $this->_contactType, 'greeting_type' => 'postal_greeting');
if (!self::in_value($value, CRM_Core_PseudoConstant::greeting($postalGreetingFilter))) {
self::addToErrorMsg(ts('Postal Greeting must be one of the configured format options. Check Administer >> Option Lists >> Postal Greetings for valid values'), $errorMessage);
}
break;
case 'addressee':
$addresseeFilter = array('contact_type' => $this->_contactType, 'greeting_type' => 'addressee');
if (!self::in_value($value, CRM_Core_PseudoConstant::greeting($addresseeFilter))) {
self::addToErrorMsg(ts('Addressee must be one of the configured format options. Check Administer >> Option Lists >> Addressee for valid values'), $errorMessage);
}
break;
case 'email_greeting_custom':
if (array_key_exists('email_greeting', $params)) {
$emailGreetingLabel = key(CRM_Core_OptionGroup::values('email_greeting', true, null, null, 'AND v.name = "Customized"'));
if (CRM_Utils_Array::value('email_greeting', $params) != $emailGreetingLabel) {
self::addToErrorMsg(ts('Email Greeting - Custom'), $errorMessage);
}
}
break;
case 'postal_greeting_custom':
if (array_key_exists('postal_greeting', $params)) {
$postalGreetingLabel = key(CRM_Core_OptionGroup::values('postal_greeting', true, null, null, 'AND v.name = "Customized"'));
if (CRM_Utils_Array::value('postal_greeting', $params) != $postalGreetingLabel) {
self::addToErrorMsg(ts('Postal Greeting - Custom'), $errorMessage);
}
}
break;
case 'addressee_custom':
if (array_key_exists('addressee', $params)) {
$addresseeLabel = key(CRM_Core_OptionGroup::values('addressee', true, null, null, 'AND v.name = "Customized"'));
if (CRM_Utils_Array::value('addressee', $params) != $addresseeLabel) {
self::addToErrorMsg(ts('Addressee - Custom'), $errorMessage);
}
}
break;
case 'home_URL':
if (CRM_Utils_Rule::url($value) === false) {
self::addToErrorMsg(ts('Website'), $errorMessage);
}
break;
case 'do_not_email':
case 'do_not_phone':
case 'do_not_mail':
case 'do_not_sms':
case 'do_not_trade':
if (CRM_Utils_Rule::boolean($value) == false) {
$key = ucwords(str_replace("_", " ", $key));
self::addToErrorMsg($key, $errorMessage);
}
break;
case 'email':
if (is_array($value)) {
foreach ($value as $values) {
if (CRM_Utils_Array::value('email', $values) && !CRM_Utils_Rule::email($values['email'])) {
self::addToErrorMsg($key, $errorMessage);
break;
}
}
}
break;
default:
if (is_array($params[$key]) && isset($params[$key]["contact_type"])) {
//check for any relationship data ,FIX ME
self::isErrorInCoreData($params[$key], $errorMessage);
}
}
}
}
}
/**
* Validate & convert settings input - translate True False to 0 or 1
*
* @value mixed value of the setting to be set
* @fieldSpec array Metadata for given field (drawn from the xml)
*/
public static function validateBoolSetting(&$value, $fieldSpec)
{
if (!CRM_Utils_Rule::boolean($value)) {
throw new api_Exception("Boolean value required for {$fieldSpec['name']}");
}
if (!$value) {
$value = 0;
} else {
$value = 1;
}
return TRUE;
}
/**
* Verify that a variable is of a given type.
*
* @param mixed $data
* The value to validate.
* @param string $type
* The type to validate against.
* @param bool $abort
* If TRUE, the operation will CRM_Core_Error::fatal() on invalid data.
* @name string $name
* The name of the attribute
*
* @return mixed
* The data, escaped if necessary
*/
public static function validate($data, $type, $abort = TRUE, $name = 'One of parameters ')
{
switch ($type) {
case 'Integer':
case 'Int':
if (CRM_Utils_Rule::integer($data)) {
return (int) $data;
}
break;
case 'Positive':
if (CRM_Utils_Rule::positiveInteger($data)) {
return $data;
}
break;
case 'Boolean':
if (CRM_Utils_Rule::boolean($data)) {
return $data;
}
break;
case 'Float':
case 'Money':
if (CRM_Utils_Rule::numeric($data)) {
return $data;
}
break;
case 'Text':
case 'String':
case 'Link':
case 'Memo':
return $data;
case 'Date':
// a null date is valid
if (strlen(trim($data)) == 0) {
return trim($data);
}
if (preg_match('/^\\d{8}$/', $data) && CRM_Utils_Rule::mysqlDate($data)) {
return $data;
}
break;
case 'Timestamp':
// a null timestamp is valid
if (strlen(trim($data)) == 0) {
return trim($data);
}
if ((preg_match('/^\\d{14}$/', $data) || preg_match('/^\\d{8}$/', $data)) && CRM_Utils_Rule::mysqlDate($data)) {
return $data;
}
break;
case 'ContactReference':
// null is valid
if (strlen(trim($data)) == 0) {
return trim($data);
}
if (CRM_Utils_Rule::validContact($data)) {
return $data;
}
break;
default:
CRM_Core_Error::fatal("Cannot recognize {$type} for {$data}");
break;
}
if ($abort) {
$data = htmlentities($data);
CRM_Core_Error::fatal("{$name} (value: {$data}) is not of the type {$type}");
}
return NULL;
}
