class CRM_Utils_Type in CiviCRM Entity 8.3
@package CRM @copyright CiviCRM LLC (c) 2004-2017
Hierarchy
- class \CRM_Utils_Type
Expanded class hierarchy of CRM_Utils_Type
1 string reference to 'CRM_Utils_Type'
- CRM_Utils_Type::escape in tests/
src/ Type.php - Verify that a variable is of a given type, and apply a bit of processing.
File
- tests/
src/ Type.php, line 34
View source
class CRM_Utils_Type {
const T_INT = 1, T_STRING = 2, T_ENUM = 2, T_DATE = 4, T_TIME = 8, T_BOOLEAN = 16, T_TEXT = 32, T_LONGTEXT = 32, T_BLOB = 64, T_TIMESTAMP = 256, T_FLOAT = 512, T_MONEY = 1024, T_EMAIL = 2048, T_URL = 4096, T_CCNUM = 8192, T_MEDIUMBLOB = 16384;
// @TODO What's the point of these constants? Backwards compatibility?
//
// These are used for field size (<input type=text size=2>), but redundant TWO=2
// usages are rare and should be eliminated. See CRM-18810.
const TWO = 2, FOUR = 4, SIX = 6, EIGHT = 8, TWELVE = 12, SIXTEEN = 16, TWENTY = 20, MEDIUM = 20, THIRTY = 30, BIG = 30, FORTYFIVE = 45, HUGE = 45;
/**
* Gets the string representation for a data type.
*
* @param int $type
* Integer number identifying the data type.
*
* @return string
* String identifying the data type, e.g. 'Int' or 'String'.
*/
public static function typeToString($type) {
// @todo Use constants in the case statements, e.g. "case T_INT:".
// @todo return directly, instead of assigning a value.
// @todo Use a lookup array, as a property or as a local variable.
switch ($type) {
case 1:
$string = 'Int';
break;
case 2:
$string = 'String';
break;
case 3:
$string = 'Enum';
break;
case 4:
$string = 'Date';
break;
case 8:
$string = 'Time';
break;
case 16:
$string = 'Boolean';
break;
case 32:
$string = 'Text';
break;
case 64:
$string = 'Blob';
break;
// CRM-10404
case 12:
case 256:
$string = 'Timestamp';
break;
case 512:
$string = 'Float';
break;
case 1024:
$string = 'Money';
break;
case 2048:
$string = 'Date';
break;
case 4096:
$string = 'Email';
break;
case 16384:
$string = 'Mediumblob';
break;
}
return isset($string) ? $string : "";
}
/**
* Get the data_type for the field.
*
* @param array $fieldMetadata
* Metadata about the field.
*
* @return string
*/
public static function getDataTypeFromFieldMetadata($fieldMetadata) {
if (isset($fieldMetadata['data_type'])) {
return $fieldMetadata['data_type'];
}
if (empty($fieldMetadata['type'])) {
// I would prefer to throw an e-notice but there is some,
// probably unnecessary logic, that only retrieves activity fields
// if they are 'in the profile' and probably they are not 'in'
// until they are added - which might lead to ? who knows!
return '';
}
return self::typeToString($fieldMetadata['type']);
}
/**
* Helper function to call escape on arrays.
*
* @see escape
*/
public static function escapeAll($data, $type, $abort = TRUE) {
foreach ($data as $key => $value) {
$data[$key] = CRM_Utils_Type::escape($value, $type, $abort);
}
return $data;
}
/**
* Helper function to call validate on arrays
*
* @see validate
*/
public static function validateAll($data, $type, $abort = TRUE) {
foreach ($data as $key => $value) {
$data[$key] = CRM_Utils_Type::validate($value, $type, $abort);
}
return $data;
}
/**
* Verify that a variable is of a given type, and apply a bit of processing.
*
* @param mixed $data
* The value to be verified/escaped.
* @param string $type
* The type to verify against.
* @param bool $abort
* If TRUE, the operation will CRM_Core_Error::fatal() on invalid data.
*
* @return mixed
* The data, escaped if necessary.
*/
public static function escape($data, $type, $abort = TRUE) {
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 (int) $data;
}
break;
// CRM-8925 for custom fields of this type
case 'Country':
case 'StateProvince':
// Handle multivalued data in delimited or array format
if (is_array($data) || strpos($data, CRM_Core_DAO::VALUE_SEPARATOR) !== FALSE) {
$valid = TRUE;
foreach (CRM_Utils_Array::explodePadded($data) as $item) {
if (!CRM_Utils_Rule::positiveInteger($item)) {
$valid = FALSE;
}
}
if ($valid) {
return $data;
}
}
elseif (CRM_Utils_Rule::positiveInteger($data)) {
return (int) $data;
}
break;
case 'File':
if (CRM_Utils_Rule::positiveInteger($data)) {
return (int) $data;
}
break;
case 'Link':
if (CRM_Utils_Rule::url($data = trim($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 'String':
case 'Memo':
case 'Text':
return CRM_Core_DAO::escapeString($data);
case 'Date':
case 'Timestamp':
// a null date or timestamp is valid
if (strlen(trim($data)) == 0) {
return trim($data);
}
if ((preg_match('/^\\d{8}$/', $data) || preg_match('/^\\d{14}$/', $data)) && CRM_Utils_Rule::mysqlDate($data)) {
return $data;
}
break;
case 'ContactReference':
if (strlen(trim($data)) == 0) {
return trim($data);
}
if (CRM_Utils_Rule::validContact($data)) {
return (int) $data;
}
break;
case 'MysqlColumnNameOrAlias':
if (CRM_Utils_Rule::mysqlColumnNameOrAlias($data)) {
$data = str_replace('`', '', $data);
$parts = explode('.', $data);
$data = '`' . implode('`.`', $parts) . '`';
return $data;
}
break;
case 'MysqlOrderByDirection':
if (CRM_Utils_Rule::mysqlOrderByDirection($data)) {
return strtolower($data);
}
break;
case 'MysqlOrderBy':
if (CRM_Utils_Rule::mysqlOrderBy($data)) {
$parts = explode(',', $data);
// The field() syntax is tricky here because it uses commas & when
// we separate by them we break it up. But we want to keep the clauses in order.
// so we just clumsily re-assemble it. Test cover exists.
$fieldClauseStart = NULL;
foreach ($parts as $index => &$part) {
if (substr($part, 0, 6) === 'field(') {
// Looking to escape a string like 'field(contribution_status_id,3,4,5) asc'
// to 'field(`contribution_status_id`,3,4,5) asc'
$fieldClauseStart = $index;
continue;
}
if ($fieldClauseStart !== NULL) {
// this is part of the list of field options. Concatenate it back on.
$parts[$fieldClauseStart] .= ',' . $part;
unset($parts[$index]);
if (!strstr($parts[$fieldClauseStart], ')')) {
// we have not reached the end of the list.
continue;
}
// We have the last piece of the field() clause, time to escape it.
$parts[$fieldClauseStart] = self::mysqlOrderByFieldFunctionCallback($parts[$fieldClauseStart]);
$fieldClauseStart = NULL;
continue;
}
// Normal clause.
$part = preg_replace_callback('/^(?:(?:((?:`[\\w-]{1,64}`|[\\w-]{1,64}))(?:\\.))?(`[\\w-]{1,64}`|[\\w-]{1,64})(?: (asc|desc))?)$/i', array(
'CRM_Utils_Type',
'mysqlOrderByCallback',
), trim($part));
}
return implode(', ', $parts);
}
break;
default:
CRM_Core_Error::fatal($type . " is not a recognised (camel cased) data type.");
break;
}
// @todo Use exceptions instead of CRM_Core_Error::fatal().
if ($abort) {
$data = htmlentities($data);
CRM_Core_Error::fatal("{$data} is not of the type {$type}");
}
return NULL;
}
/**
* 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 (int) $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;
case 'MysqlColumnNameOrAlias':
if (CRM_Utils_Rule::mysqlColumnNameOrAlias($data)) {
return $data;
}
break;
case 'MysqlOrderByDirection':
if (CRM_Utils_Rule::mysqlOrderByDirection($data)) {
return strtolower($data);
}
break;
case 'MysqlOrderBy':
if (CRM_Utils_Rule::mysqlOrderBy($data)) {
return $data;
}
break;
case 'ExtensionKey':
if (CRM_Utils_Rule::checkExtesnionKeyIsValid($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;
}
/**
* Preg_replace_callback for mysqlOrderByFieldFunction escape.
*
* Add backticks around the field name.
*
* @param string $clause
*
* @return string
*/
public static function mysqlOrderByFieldFunctionCallback($clause) {
return preg_replace('/field\\((\\w*)/', 'field(`${1}`', $clause);
}
/**
* preg_replace_callback for MysqlOrderBy escape.
*/
public static function mysqlOrderByCallback($matches) {
$output = '';
$matches = str_replace('`', '', $matches);
// Table name.
if (isset($matches[1]) && $matches[1]) {
$output .= '`' . $matches[1] . '`.';
}
// Column name.
if (isset($matches[2]) && $matches[2]) {
$output .= '`' . $matches[2] . '`';
}
// Sort order.
if (isset($matches[3]) && $matches[3]) {
$output .= ' ' . $matches[3];
}
return $output;
}
/**
* Get list of avaliable Data Tupes for Option Groups
*
* @return array
*/
public static function dataTypes() {
$types = array(
'Integer',
'String',
'Date',
'Time',
'Timestamp',
'Money',
'Email',
);
return array_combine($types, $types);
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
CRM_Utils_Type:: |
public static | function | Get list of avaliable Data Tupes for Option Groups | |
|
CRM_Utils_Type:: |
public static | function | Verify that a variable is of a given type, and apply a bit of processing. | |
|
CRM_Utils_Type:: |
public static | function | Helper function to call escape on arrays. | |
|
CRM_Utils_Type:: |
public static | function | Get the data_type for the field. | |
|
CRM_Utils_Type:: |
public static | function | preg_replace_callback for MysqlOrderBy escape. | |
|
CRM_Utils_Type:: |
public static | function | Preg_replace_callback for mysqlOrderByFieldFunction escape. | |
|
CRM_Utils_Type:: |
constant | |||
|
CRM_Utils_Type:: |
public static | function | Gets the string representation for a data type. | |
|
CRM_Utils_Type:: |
constant | |||
|
CRM_Utils_Type:: |
public static | function | Verify that a variable is of a given type. | |
|
CRM_Utils_Type:: |
public static | function | Helper function to call validate on arrays |