<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
*
*/
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,
+ 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;
- CONST
- TWO = 2,
- FOUR = 4,
- SIX = 6,
- EIGHT = 8,
- TWELVE = 12,
- SIXTEEN = 16,
- TWENTY = 20,
- MEDIUM = 20,
- THIRTY = 30,
- BIG = 30,
+ // @todo What's the point of these constants? Backwards compatibility?
+ 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;
+ HUGE = 45;
/**
- * Convert Constant Data type to String
+ * Gets the string representation for a data type.
*
- * @param $type integer datatype
+ * @param int $type
+ * Integer number identifying the data type.
*
- * @return string $string String datatype respective to integer datatype@access public
- * @static
+ * @return string
+ * String identifying the data type, e.g. 'Int' or 'String'.
*/
- static function typeToString($type) {
+ 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';
$string = 'Blob';
break;
- // CRM-10404
+ // CRM-10404
case 12:
case 256:
$string = 'Timestamp';
}
/**
- * Verify that a variable is of a given type
+ * Verify that a variable is of a given type, and apply a bit of processing.
*
- * @param mixed $data The variable
- * @param string $type The type
- * @param boolean $abort Should we abort if invalid
+ * @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
- * @access public
- * @static
+ * @return mixed
+ * The data, escaped if necessary.
*/
public static function escape($data, $type, $abort = TRUE) {
switch ($type) {
break;
case 'Positive':
- // CRM-8925 the 3 below are for custom fields of this type
+ // CRM-8925 the 3 below are for custom fields of this type
case 'Country':
case 'StateProvince':
// Checked for multi valued state/country value
if (is_array($data)) {
$returnData = TRUE;
+ // @todo Reuse of the $data variable = asking for trouble.
+ // @todo This code will always return the last item in the array. Intended?
foreach ($data as $data) {
if (CRM_Utils_Rule::positiveInteger($data) || CRM_Core_DAO::escapeString($data)) {
$returnData = TRUE;
return $data;
}
}
- elseif (!is_numeric($data) && CRM_Core_DAO::escapeString($data)) {
+ elseif (!is_numeric($data) && CRM_Core_DAO::escapeString($data)) {
return $data;
}
elseif (CRM_Utils_Rule::positiveInteger($data)) {
break;
default:
- CRM_Core_Error::fatal("Cannot recognize $type for $data");
+ 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");
}
/**
- * Verify that a variable is of a given type
+ * Verify that a variable is of a given type.
*
- * @param mixed $data The variable
- * @param string $type The type
- * @param boolean $abort Should we abort if invalid
- * @name string $name The name of the attribute
+ * @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
- * @access public
- * @static
+ * @return mixed
+ * The data, escaped if necessary
*/
public static function validate($data, $type, $abort = TRUE, $name = 'One of parameters ') {
switch ($type) {
return NULL;
}
-}
+}
projects / civicrm-core.git / blobdiff