| 1 | <?php |
| 2 | /* |
| 3 | +--------------------------------------------------------------------+ |
| 4 | | CiviCRM version 4.7 | |
| 5 | +--------------------------------------------------------------------+ |
| 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
| 7 | +--------------------------------------------------------------------+ |
| 8 | | This file is a part of CiviCRM. | |
| 9 | | | |
| 10 | | CiviCRM is free software; you can copy, modify, and distribute it | |
| 11 | | under the terms of the GNU Affero General Public License | |
| 12 | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | |
| 13 | | | |
| 14 | | CiviCRM is distributed in the hope that it will be useful, but | |
| 15 | | WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 16 | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | |
| 17 | | See the GNU Affero General Public License for more details. | |
| 18 | | | |
| 19 | | You should have received a copy of the GNU Affero General Public | |
| 20 | | License and the CiviCRM Licensing Exception along | |
| 21 | | with this program; if not, contact CiviCRM LLC | |
| 22 | | at info[AT]civicrm[DOT]org. If you have questions about the | |
| 23 | | GNU Affero General Public License or the licensing of CiviCRM, | |
| 24 | | see the CiviCRM license FAQ at http://civicrm.org/licensing | |
| 25 | +--------------------------------------------------------------------+ |
| 26 | */ |
| 27 | |
| 28 | /** |
| 29 | * |
| 30 | * @package CRM |
| 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
| 32 | * $Id$ |
| 33 | * |
| 34 | */ |
| 35 | class CRM_Core_BAO_CustomValueTable { |
| 36 | |
| 37 | /** |
| 38 | * @param array $customParams |
| 39 | * |
| 40 | * @throws Exception |
| 41 | */ |
| 42 | public static function create(&$customParams) { |
| 43 | if (empty($customParams) || |
| 44 | !is_array($customParams) |
| 45 | ) { |
| 46 | return; |
| 47 | } |
| 48 | |
| 49 | foreach ($customParams as $tableName => $tables) { |
| 50 | foreach ($tables as $index => $fields) { |
| 51 | $sqlOP = NULL; |
| 52 | $hookID = NULL; |
| 53 | $hookOP = NULL; |
| 54 | $entityID = NULL; |
| 55 | $isMultiple = FALSE; |
| 56 | $set = array(); |
| 57 | $params = array(); |
| 58 | $count = 1; |
| 59 | foreach ($fields as $field) { |
| 60 | if (!$sqlOP) { |
| 61 | $entityID = $field['entity_id']; |
| 62 | $hookID = $field['custom_group_id']; |
| 63 | $isMultiple = $field['is_multiple']; |
| 64 | if (array_key_exists('id', $field)) { |
| 65 | $sqlOP = "UPDATE $tableName "; |
| 66 | $where = " WHERE id = %{$count}"; |
| 67 | $params[$count] = array($field['id'], 'Integer'); |
| 68 | $count++; |
| 69 | $hookOP = 'edit'; |
| 70 | } |
| 71 | else { |
| 72 | $sqlOP = "INSERT INTO $tableName "; |
| 73 | $where = NULL; |
| 74 | $hookOP = 'create'; |
| 75 | } |
| 76 | } |
| 77 | |
| 78 | // fix the value before we store it |
| 79 | $value = $field['value']; |
| 80 | $type = $field['type']; |
| 81 | switch ($type) { |
| 82 | case 'StateProvince': |
| 83 | $type = 'Integer'; |
| 84 | if (is_array($value)) { |
| 85 | $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $value) . CRM_Core_DAO::VALUE_SEPARATOR; |
| 86 | $type = 'String'; |
| 87 | } |
| 88 | elseif (!is_numeric($value) && !strstr($value, CRM_Core_DAO::VALUE_SEPARATOR)) { |
| 89 | //fix for multi select state, CRM-3437 |
| 90 | $mulValues = explode(',', $value); |
| 91 | $validStates = array(); |
| 92 | foreach ($mulValues as $key => $stateVal) { |
| 93 | $states = array(); |
| 94 | $states['state_province'] = trim($stateVal); |
| 95 | |
| 96 | CRM_Utils_Array::lookupValue($states, 'state_province', |
| 97 | CRM_Core_PseudoConstant::stateProvince(), TRUE |
| 98 | ); |
| 99 | if (empty($states['state_province_id'])) { |
| 100 | CRM_Utils_Array::lookupValue($states, 'state_province', |
| 101 | CRM_Core_PseudoConstant::stateProvinceAbbreviation(), TRUE |
| 102 | ); |
| 103 | } |
| 104 | $validStates[] = CRM_Utils_Array::value('state_province_id', $states); |
| 105 | } |
| 106 | $value = implode(CRM_Core_DAO::VALUE_SEPARATOR, |
| 107 | $validStates |
| 108 | ); |
| 109 | $type = 'String'; |
| 110 | } |
| 111 | elseif (!$value) { |
| 112 | // CRM-3415 |
| 113 | // using type of timestamp allows us to sneak in a null into db |
| 114 | // gross but effective hack |
| 115 | $value = NULL; |
| 116 | $type = 'Timestamp'; |
| 117 | } |
| 118 | else { |
| 119 | $type = 'String'; |
| 120 | } |
| 121 | break; |
| 122 | |
| 123 | case 'Country': |
| 124 | $type = 'Integer'; |
| 125 | $mulValues = explode(',', $value); |
| 126 | if (is_array($value)) { |
| 127 | $value = CRM_Core_DAO::VALUE_SEPARATOR . implode(CRM_Core_DAO::VALUE_SEPARATOR, $value) . CRM_Core_DAO::VALUE_SEPARATOR; |
| 128 | $type = 'String'; |
| 129 | } |
| 130 | elseif (!is_numeric($value) && !strstr($value, CRM_Core_DAO::VALUE_SEPARATOR)) { |
| 131 | //fix for multi select country, CRM-3437 |
| 132 | $mulValues = explode(',', $value); |
| 133 | $validCountries = array(); |
| 134 | foreach ($mulValues as $key => $countryVal) { |
| 135 | $countries = array(); |
| 136 | $countries['country'] = trim($countryVal); |
| 137 | CRM_Utils_Array::lookupValue($countries, 'country', |
| 138 | CRM_Core_PseudoConstant::country(), TRUE |
| 139 | ); |
| 140 | if (empty($countries['country_id'])) { |
| 141 | CRM_Utils_Array::lookupValue($countries, 'country', |
| 142 | CRM_Core_PseudoConstant::countryIsoCode(), TRUE |
| 143 | ); |
| 144 | } |
| 145 | $validCountries[] = CRM_Utils_Array::value('country_id', $states); |
| 146 | } |
| 147 | $value = implode(CRM_Core_DAO::VALUE_SEPARATOR, |
| 148 | $validCountries |
| 149 | ); |
| 150 | $type = 'String'; |
| 151 | } |
| 152 | elseif (!$value) { |
| 153 | // CRM-3415 |
| 154 | // using type of timestamp allows us to sneak in a null into db |
| 155 | // gross but effective hack |
| 156 | $value = NULL; |
| 157 | $type = 'Timestamp'; |
| 158 | } |
| 159 | else { |
| 160 | $type = 'String'; |
| 161 | } |
| 162 | break; |
| 163 | |
| 164 | case 'File': |
| 165 | if (!$field['file_id']) { |
| 166 | CRM_Core_Error::fatal(); |
| 167 | } |
| 168 | |
| 169 | // need to add/update civicrm_entity_file |
| 170 | $entityFileDAO = new CRM_Core_DAO_EntityFile(); |
| 171 | $entityFileDAO->file_id = $field['file_id']; |
| 172 | $entityFileDAO->find(TRUE); |
| 173 | |
| 174 | $entityFileDAO->entity_table = $field['table_name']; |
| 175 | $entityFileDAO->entity_id = $field['entity_id']; |
| 176 | $entityFileDAO->file_id = $field['file_id']; |
| 177 | $entityFileDAO->save(); |
| 178 | $entityFileDAO->free(); |
| 179 | $value = $field['file_id']; |
| 180 | $type = 'String'; |
| 181 | break; |
| 182 | |
| 183 | case 'Date': |
| 184 | $value = CRM_Utils_Date::isoToMysql($value); |
| 185 | break; |
| 186 | |
| 187 | case 'Int': |
| 188 | if (is_numeric($value)) { |
| 189 | $type = 'Integer'; |
| 190 | } |
| 191 | else { |
| 192 | $type = 'Timestamp'; |
| 193 | } |
| 194 | break; |
| 195 | |
| 196 | case 'ContactReference': |
| 197 | if ($value == NULL) { |
| 198 | $type = 'Timestamp'; |
| 199 | } |
| 200 | else { |
| 201 | $type = 'Integer'; |
| 202 | } |
| 203 | break; |
| 204 | |
| 205 | case 'RichTextEditor': |
| 206 | $type = 'String'; |
| 207 | break; |
| 208 | |
| 209 | case 'Boolean': |
| 210 | //fix for CRM-3290 |
| 211 | $value = CRM_Utils_String::strtoboolstr($value); |
| 212 | if ($value === FALSE) { |
| 213 | $type = 'Timestamp'; |
| 214 | } |
| 215 | break; |
| 216 | |
| 217 | default: |
| 218 | break; |
| 219 | } |
| 220 | if (strtolower($value) === "null") { |
| 221 | // when unsetting a value to null, we don't need to validate the type |
| 222 | // https://projectllr.atlassian.net/browse/VGQBMP-20 |
| 223 | $set[$field['column_name']] = $value; |
| 224 | } |
| 225 | else { |
| 226 | $set[$field['column_name']] = "%{$count}"; |
| 227 | $params[$count] = array($value, $type); |
| 228 | $count++; |
| 229 | } |
| 230 | } |
| 231 | |
| 232 | if (!empty($set)) { |
| 233 | $setClause = array(); |
| 234 | foreach ($set as $n => $v) { |
| 235 | $setClause[] = "$n = $v"; |
| 236 | } |
| 237 | $setClause = implode(',', $setClause); |
| 238 | if (!$where) { |
| 239 | // do this only for insert |
| 240 | $set['entity_id'] = "%{$count}"; |
| 241 | $params[$count] = array($entityID, 'Integer'); |
| 242 | $count++; |
| 243 | |
| 244 | $fieldNames = implode(',', array_keys($set)); |
| 245 | $fieldValues = implode(',', array_values($set)); |
| 246 | $query = "$sqlOP ( $fieldNames ) VALUES ( $fieldValues )"; |
| 247 | // for multiple values we dont do on duplicate key update |
| 248 | if (!$isMultiple) { |
| 249 | $query .= " ON DUPLICATE KEY UPDATE $setClause"; |
| 250 | } |
| 251 | } |
| 252 | else { |
| 253 | $query = "$sqlOP SET $setClause $where"; |
| 254 | } |
| 255 | $dao = CRM_Core_DAO::executeQuery($query, $params); |
| 256 | |
| 257 | CRM_Utils_Hook::custom($hookOP, |
| 258 | $hookID, |
| 259 | $entityID, |
| 260 | $fields |
| 261 | ); |
| 262 | } |
| 263 | } |
| 264 | } |
| 265 | } |
| 266 | |
| 267 | /** |
| 268 | * Given a field return the mysql data type associated with it. |
| 269 | * |
| 270 | * @param string $type |
| 271 | * @param int $maxLength |
| 272 | * |
| 273 | * @return string |
| 274 | * the mysql data store placeholder |
| 275 | */ |
| 276 | public static function fieldToSQLType($type, $maxLength = 255) { |
| 277 | if (!isset($maxLength) || |
| 278 | !is_numeric($maxLength) || |
| 279 | $maxLength <= 0 |
| 280 | ) { |
| 281 | $maxLength = 255; |
| 282 | } |
| 283 | |
| 284 | switch ($type) { |
| 285 | case 'String': |
| 286 | case 'Link': |
| 287 | return "varchar($maxLength)"; |
| 288 | |
| 289 | case 'Boolean': |
| 290 | return 'tinyint'; |
| 291 | |
| 292 | case 'Int': |
| 293 | return 'int'; |
| 294 | |
| 295 | // the below three are FK's, and have constraints added to them |
| 296 | |
| 297 | case 'ContactReference': |
| 298 | case 'StateProvince': |
| 299 | case 'Country': |
| 300 | case 'File': |
| 301 | return 'int unsigned'; |
| 302 | |
| 303 | case 'Float': |
| 304 | return 'double'; |
| 305 | |
| 306 | case 'Money': |
| 307 | return 'decimal(20,2)'; |
| 308 | |
| 309 | case 'Memo': |
| 310 | case 'RichTextEditor': |
| 311 | return 'text'; |
| 312 | |
| 313 | case 'Date': |
| 314 | return 'datetime'; |
| 315 | |
| 316 | default: |
| 317 | CRM_Core_Error::fatal(); |
| 318 | } |
| 319 | } |
| 320 | |
| 321 | /** |
| 322 | * @param array $params |
| 323 | * @param $entityTable |
| 324 | * @param int $entityID |
| 325 | */ |
| 326 | public static function store(&$params, $entityTable, $entityID) { |
| 327 | $cvParams = array(); |
| 328 | foreach ($params as $fieldID => $param) { |
| 329 | foreach ($param as $index => $customValue) { |
| 330 | $cvParam = array( |
| 331 | 'entity_table' => $entityTable, |
| 332 | 'entity_id' => $entityID, |
| 333 | 'value' => $customValue['value'], |
| 334 | 'type' => $customValue['type'], |
| 335 | 'custom_field_id' => $customValue['custom_field_id'], |
| 336 | 'custom_group_id' => $customValue['custom_group_id'], |
| 337 | 'table_name' => $customValue['table_name'], |
| 338 | 'column_name' => $customValue['column_name'], |
| 339 | 'is_multiple' => CRM_Utils_Array::value('is_multiple', $customValue), |
| 340 | 'file_id' => $customValue['file_id'], |
| 341 | ); |
| 342 | |
| 343 | // Fix Date type to be timestamp, since that is how we store in db. |
| 344 | if ($cvParam['type'] == 'Date') { |
| 345 | $cvParam['type'] = 'Timestamp'; |
| 346 | } |
| 347 | |
| 348 | if (!empty($customValue['id'])) { |
| 349 | $cvParam['id'] = $customValue['id']; |
| 350 | } |
| 351 | if (!array_key_exists($customValue['table_name'], $cvParams)) { |
| 352 | $cvParams[$customValue['table_name']] = array(); |
| 353 | } |
| 354 | |
| 355 | if (!array_key_exists($index, $cvParams[$customValue['table_name']])) { |
| 356 | $cvParams[$customValue['table_name']][$index] = array(); |
| 357 | } |
| 358 | |
| 359 | $cvParams[$customValue['table_name']][$index][] = $cvParam; |
| 360 | } |
| 361 | } |
| 362 | if (!empty($cvParams)) { |
| 363 | self::create($cvParams); |
| 364 | } |
| 365 | } |
| 366 | |
| 367 | /** |
| 368 | * Post process function. |
| 369 | * |
| 370 | * @param array $params |
| 371 | * @param $entityTable |
| 372 | * @param int $entityID |
| 373 | * @param $customFieldExtends |
| 374 | */ |
| 375 | public static function postProcess(&$params, $entityTable, $entityID, $customFieldExtends) { |
| 376 | $customData = CRM_Core_BAO_CustomField::postProcess($params, |
| 377 | $entityID, |
| 378 | $customFieldExtends |
| 379 | ); |
| 380 | |
| 381 | if (!empty($customData)) { |
| 382 | self::store($customData, $entityTable, $entityID); |
| 383 | } |
| 384 | } |
| 385 | |
| 386 | /** |
| 387 | * Return an array of all custom values associated with an entity. |
| 388 | * |
| 389 | * @param int $entityID |
| 390 | * Identification number of the entity. |
| 391 | * @param string $entityType |
| 392 | * Type of entity that the entityID corresponds to, specified. |
| 393 | * as a string with format "'<EntityName>'". Comma separated |
| 394 | * list may be used to specify OR matches. Allowable values |
| 395 | * are enumerated types in civicrm_custom_group.extends field. |
| 396 | * Optional. Default value assumes entityID references a |
| 397 | * contact entity. |
| 398 | * @param array $fieldIDs |
| 399 | * Optional list of fieldIDs that we want to retrieve. If this. |
| 400 | * is set the entityType is ignored |
| 401 | * |
| 402 | * @param bool $formatMultiRecordField |
| 403 | * |
| 404 | * @return array |
| 405 | * Array of custom values for the entity with key=>value |
| 406 | * pairs specified as civicrm_custom_field.id => custom value. |
| 407 | * Empty array if no custom values found. |
| 408 | */ |
| 409 | public static function &getEntityValues($entityID, $entityType = NULL, $fieldIDs = NULL, $formatMultiRecordField = FALSE) { |
| 410 | if (!$entityID) { |
| 411 | // adding this here since an empty contact id could have serious repurcussions |
| 412 | // like looping forever |
| 413 | CRM_Core_Error::fatal('Please file an issue with the backtrace'); |
| 414 | return NULL; |
| 415 | } |
| 416 | |
| 417 | $cond = array(); |
| 418 | if ($entityType) { |
| 419 | $cond[] = "cg.extends IN ( '$entityType' )"; |
| 420 | } |
| 421 | if ($fieldIDs && |
| 422 | is_array($fieldIDs) |
| 423 | ) { |
| 424 | $fieldIDList = implode(',', $fieldIDs); |
| 425 | $cond[] = "cf.id IN ( $fieldIDList )"; |
| 426 | } |
| 427 | if (empty($cond)) { |
| 428 | $cond[] = "cg.extends IN ( 'Contact', 'Individual', 'Household', 'Organization' )"; |
| 429 | } |
| 430 | $cond = implode(' AND ', $cond); |
| 431 | |
| 432 | // First find all the fields that extend this type of entity. |
| 433 | $query = " |
| 434 | SELECT cg.table_name, |
| 435 | cg.id as groupID, |
| 436 | cg.is_multiple, |
| 437 | cf.column_name, |
| 438 | cf.id as fieldID, |
| 439 | cf.data_type as fieldDataType |
| 440 | FROM civicrm_custom_group cg, |
| 441 | civicrm_custom_field cf |
| 442 | WHERE cf.custom_group_id = cg.id |
| 443 | AND cg.is_active = 1 |
| 444 | AND cf.is_active = 1 |
| 445 | AND $cond |
| 446 | "; |
| 447 | $dao = CRM_Core_DAO::executeQuery($query); |
| 448 | |
| 449 | $select = $fields = $isMultiple = array(); |
| 450 | |
| 451 | while ($dao->fetch()) { |
| 452 | if (!array_key_exists($dao->table_name, $select)) { |
| 453 | $fields[$dao->table_name] = array(); |
| 454 | $select[$dao->table_name] = array(); |
| 455 | } |
| 456 | $fields[$dao->table_name][] = $dao->fieldID; |
| 457 | $select[$dao->table_name][] = "{$dao->column_name} AS custom_{$dao->fieldID}"; |
| 458 | $isMultiple[$dao->table_name] = $dao->is_multiple ? TRUE : FALSE; |
| 459 | $file[$dao->table_name][$dao->fieldID] = $dao->fieldDataType; |
| 460 | } |
| 461 | |
| 462 | $result = array(); |
| 463 | foreach ($select as $tableName => $clauses) { |
| 464 | $query = "SELECT id, " . implode(', ', $clauses) . " FROM $tableName WHERE entity_id = $entityID"; |
| 465 | $dao = CRM_Core_DAO::executeQuery($query); |
| 466 | while ($dao->fetch()) { |
| 467 | foreach ($fields[$tableName] as $fieldID) { |
| 468 | $fieldName = "custom_{$fieldID}"; |
| 469 | if ($isMultiple[$tableName]) { |
| 470 | if ($formatMultiRecordField) { |
| 471 | $result["{$dao->id}"]["{$fieldID}"] = $dao->$fieldName; |
| 472 | } |
| 473 | else { |
| 474 | $result["{$fieldID}_{$dao->id}"] = $dao->$fieldName; |
| 475 | } |
| 476 | } |
| 477 | else { |
| 478 | $result[$fieldID] = $dao->$fieldName; |
| 479 | } |
| 480 | } |
| 481 | } |
| 482 | } |
| 483 | return $result; |
| 484 | } |
| 485 | |
| 486 | /** |
| 487 | * Take in an array of entityID, custom_XXX => value |
| 488 | * and set the value in the appropriate table. Should also be able |
| 489 | * to set the value to null. Follows api parameter/return conventions |
| 490 | * |
| 491 | * @array $params |
| 492 | * |
| 493 | * @param array $params |
| 494 | * |
| 495 | * @throws Exception |
| 496 | * @return array |
| 497 | */ |
| 498 | public static function setValues(&$params) { |
| 499 | |
| 500 | if (!isset($params['entityID']) || |
| 501 | CRM_Utils_Type::escape($params['entityID'], 'Integer', FALSE) === NULL |
| 502 | ) { |
| 503 | return CRM_Core_Error::createAPIError(ts('entityID needs to be set and of type Integer')); |
| 504 | } |
| 505 | |
| 506 | // first collect all the id/value pairs. The format is: |
| 507 | // custom_X => value or custom_X_VALUEID => value (for multiple values), VALUEID == -1, -2 etc for new insertions |
| 508 | $values = array(); |
| 509 | $fieldValues = array(); |
| 510 | foreach ($params as $n => $v) { |
| 511 | if ($customFieldInfo = CRM_Core_BAO_CustomField::getKeyID($n, TRUE)) { |
| 512 | $fieldID = (int ) $customFieldInfo[0]; |
| 513 | if (CRM_Utils_Type::escape($fieldID, 'Integer', FALSE) === NULL) { |
| 514 | return CRM_Core_Error::createAPIError(ts('field ID needs to be of type Integer for index %1', |
| 515 | array(1 => $fieldID) |
| 516 | )); |
| 517 | } |
| 518 | if (!array_key_exists($fieldID, $fieldValues)) { |
| 519 | $fieldValues[$fieldID] = array(); |
| 520 | } |
| 521 | $id = -1; |
| 522 | if ($customFieldInfo[1]) { |
| 523 | $id = (int ) $customFieldInfo[1]; |
| 524 | } |
| 525 | $fieldValues[$fieldID][] = array( |
| 526 | 'value' => $v, |
| 527 | 'id' => $id, |
| 528 | ); |
| 529 | } |
| 530 | } |
| 531 | |
| 532 | $fieldIDList = implode(',', array_keys($fieldValues)); |
| 533 | |
| 534 | // format it so that we can just use create |
| 535 | $sql = " |
| 536 | SELECT cg.table_name as table_name , |
| 537 | cg.id as cg_id , |
| 538 | cg.is_multiple as is_multiple, |
| 539 | cf.column_name as column_name, |
| 540 | cf.id as cf_id , |
| 541 | cf.data_type as data_type |
| 542 | FROM civicrm_custom_group cg, |
| 543 | civicrm_custom_field cf |
| 544 | WHERE cf.custom_group_id = cg.id |
| 545 | AND cf.id IN ( $fieldIDList ) |
| 546 | "; |
| 547 | |
| 548 | $dao = CRM_Core_DAO::executeQuery($sql); |
| 549 | $cvParams = array(); |
| 550 | |
| 551 | while ($dao->fetch()) { |
| 552 | $dataType = $dao->data_type == 'Date' ? 'Timestamp' : $dao->data_type; |
| 553 | foreach ($fieldValues[$dao->cf_id] as $fieldValue) { |
| 554 | // Format null values correctly |
| 555 | if ($fieldValue['value'] === NULL || $fieldValue['value'] === '') { |
| 556 | switch ($dataType) { |
| 557 | case 'String': |
| 558 | case 'Int': |
| 559 | case 'Link': |
| 560 | case 'Boolean': |
| 561 | $fieldValue['value'] = ''; |
| 562 | break; |
| 563 | |
| 564 | case 'Timestamp': |
| 565 | $fieldValue['value'] = NULL; |
| 566 | break; |
| 567 | |
| 568 | case 'StateProvince': |
| 569 | case 'Country': |
| 570 | case 'Money': |
| 571 | case 'Float': |
| 572 | $fieldValue['value'] = (int) 0; |
| 573 | break; |
| 574 | } |
| 575 | } |
| 576 | // Ensure that value is of the right data type |
| 577 | elseif (CRM_Utils_Type::escape($fieldValue['value'], $dataType, FALSE) === NULL) { |
| 578 | return CRM_Core_Error::createAPIError(ts('value: %1 is not of the right field data type: %2', |
| 579 | array( |
| 580 | 1 => $fieldValue['value'], |
| 581 | 2 => $dao->data_type, |
| 582 | ) |
| 583 | )); |
| 584 | } |
| 585 | |
| 586 | $cvParam = array( |
| 587 | 'entity_id' => $params['entityID'], |
| 588 | 'value' => $fieldValue['value'], |
| 589 | 'type' => $dataType, |
| 590 | 'custom_field_id' => $dao->cf_id, |
| 591 | 'custom_group_id' => $dao->cg_id, |
| 592 | 'table_name' => $dao->table_name, |
| 593 | 'column_name' => $dao->column_name, |
| 594 | 'is_multiple' => $dao->is_multiple, |
| 595 | ); |
| 596 | |
| 597 | if ($cvParam['type'] == 'File') { |
| 598 | $cvParam['file_id'] = $fieldValue['value']; |
| 599 | } |
| 600 | |
| 601 | if (!array_key_exists($dao->table_name, $cvParams)) { |
| 602 | $cvParams[$dao->table_name] = array(); |
| 603 | } |
| 604 | |
| 605 | if (!array_key_exists($fieldValue['id'], $cvParams[$dao->table_name])) { |
| 606 | $cvParams[$dao->table_name][$fieldValue['id']] = array(); |
| 607 | } |
| 608 | |
| 609 | if ($fieldValue['id'] > 0) { |
| 610 | $cvParam['id'] = $fieldValue['id']; |
| 611 | } |
| 612 | $cvParams[$dao->table_name][$fieldValue['id']][] = $cvParam; |
| 613 | } |
| 614 | } |
| 615 | |
| 616 | if (!empty($cvParams)) { |
| 617 | self::create($cvParams); |
| 618 | return array('is_error' => 0, 'result' => 1); |
| 619 | } |
| 620 | |
| 621 | return CRM_Core_Error::createAPIError(ts('Unknown error')); |
| 622 | } |
| 623 | |
| 624 | /** |
| 625 | * Take in an array of entityID, custom_ID |
| 626 | * and gets the value from the appropriate table. |
| 627 | * |
| 628 | * To get the values of custom fields with IDs 13 and 43 for contact ID 1327, use: |
| 629 | * $params = array( 'entityID' => 1327, 'custom_13' => 1, 'custom_43' => 1 ); |
| 630 | * |
| 631 | * Entity Type will be inferred by the custom fields you request |
| 632 | * Specify $params['entityType'] if you do not supply any custom fields to return |
| 633 | * and entity type is other than Contact |
| 634 | * |
| 635 | * @array $params |
| 636 | * |
| 637 | * @param array $params |
| 638 | * |
| 639 | * @throws Exception |
| 640 | * @return array |
| 641 | */ |
| 642 | public static function &getValues(&$params) { |
| 643 | if (empty($params)) { |
| 644 | return NULL; |
| 645 | } |
| 646 | if (!isset($params['entityID']) || |
| 647 | CRM_Utils_Type::escape($params['entityID'], |
| 648 | 'Integer', FALSE |
| 649 | ) === NULL |
| 650 | ) { |
| 651 | return CRM_Core_Error::createAPIError(ts('entityID needs to be set and of type Integer')); |
| 652 | } |
| 653 | |
| 654 | // first collect all the ids. The format is: |
| 655 | // custom_ID |
| 656 | $fieldIDs = array(); |
| 657 | foreach ($params as $n => $v) { |
| 658 | $key = $idx = NULL; |
| 659 | if (substr($n, 0, 7) == 'custom_') { |
| 660 | $idx = substr($n, 7); |
| 661 | if (CRM_Utils_Type::escape($idx, 'Integer', FALSE) === NULL) { |
| 662 | return CRM_Core_Error::createAPIError(ts('field ID needs to be of type Integer for index %1', |
| 663 | array(1 => $idx) |
| 664 | )); |
| 665 | } |
| 666 | $fieldIDs[] = (int ) $idx; |
| 667 | } |
| 668 | } |
| 669 | |
| 670 | $default = array('Contact', 'Individual', 'Household', 'Organization'); |
| 671 | if (!($type = CRM_Utils_Array::value('entityType', $params)) || |
| 672 | in_array($params['entityType'], $default) |
| 673 | ) { |
| 674 | $type = NULL; |
| 675 | } |
| 676 | else { |
| 677 | $entities = CRM_Core_SelectValues::customGroupExtends(); |
| 678 | if (!array_key_exists($type, $entities)) { |
| 679 | if (in_array($type, $entities)) { |
| 680 | $type = $entities[$type]; |
| 681 | if (in_array($type, $default)) { |
| 682 | $type = NULL; |
| 683 | } |
| 684 | } |
| 685 | else { |
| 686 | return CRM_Core_Error::createAPIError(ts('Invalid entity type') . ': "' . $type . '"'); |
| 687 | } |
| 688 | } |
| 689 | } |
| 690 | |
| 691 | $values = self::getEntityValues($params['entityID'], |
| 692 | $type, |
| 693 | $fieldIDs |
| 694 | ); |
| 695 | if (empty($values)) { |
| 696 | // note that this behaviour is undesirable from an API point of view - it should return an empty array |
| 697 | // since this is also called by the merger code & not sure the consequences of changing |
| 698 | // are just handling undoing this in the api layer. ie. converting the error back into a success |
| 699 | $result = array( |
| 700 | 'is_error' => 1, |
| 701 | 'error_message' => 'No values found for the specified entity ID and custom field(s).', |
| 702 | ); |
| 703 | return $result; |
| 704 | } |
| 705 | else { |
| 706 | $result = array( |
| 707 | 'is_error' => 0, |
| 708 | 'entityID' => $params['entityID'], |
| 709 | ); |
| 710 | foreach ($values as $id => $value) { |
| 711 | $result["custom_{$id}"] = $value; |
| 712 | } |
| 713 | return $result; |
| 714 | } |
| 715 | } |
| 716 | |
| 717 | } |