3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
35 class CRM_Core_BAO_CustomValueTable
{
38 * @param array $customParams
42 public static function create(&$customParams) {
43 if (empty($customParams) ||
44 !is_array($customParams)
49 foreach ($customParams as $tableName => $tables) {
50 foreach ($tables as $index => $fields) {
59 foreach ($fields as $field) {
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');
72 $sqlOP = "INSERT INTO $tableName ";
78 // fix the value before we store it
79 $value = $field['value'];
80 $type = $field['type'];
84 if (is_array($value)) {
85 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $value) . CRM_Core_DAO
::VALUE_SEPARATOR
;
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) {
94 $states['state_province'] = trim($stateVal);
96 CRM_Utils_Array
::lookupValue($states, 'state_province',
97 CRM_Core_PseudoConstant
::stateProvince(), TRUE
99 if (empty($states['state_province_id'])) {
100 CRM_Utils_Array
::lookupValue($states, 'state_province',
101 CRM_Core_PseudoConstant
::stateProvinceAbbreviation(), TRUE
104 $validStates[] = CRM_Utils_Array
::value('state_province_id', $states);
106 $value = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
113 // using type of timestamp allows us to sneak in a null into db
114 // gross but effective hack
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
;
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
140 if (empty($countries['country_id'])) {
141 CRM_Utils_Array
::lookupValue($countries, 'country',
142 CRM_Core_PseudoConstant
::countryIsoCode(), TRUE
145 $validCountries[] = CRM_Utils_Array
::value('country_id', $states);
147 $value = implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
154 // using type of timestamp allows us to sneak in a null into db
155 // gross but effective hack
165 if (!$field['file_id']) {
166 CRM_Core_Error
::fatal();
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);
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'];
184 $value = CRM_Utils_Date
::isoToMysql($value);
188 if (is_numeric($value)) {
196 case 'ContactReference':
197 if ($value == NULL) {
205 case 'RichTextEditor':
211 $value = CRM_Utils_String
::strtoboolstr($value);
212 if ($value === FALSE) {
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;
226 $set[$field['column_name']] = "%{$count}";
227 $params[$count] = array($value, $type);
233 $setClause = array();
234 foreach ($set as $n => $v) {
235 $setClause[] = "$n = $v";
237 $setClause = implode(',', $setClause);
239 // do this only for insert
240 $set['entity_id'] = "%{$count}";
241 $params[$count] = array($entityID, 'Integer');
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
249 $query .= " ON DUPLICATE KEY UPDATE $setClause";
253 $query = "$sqlOP SET $setClause $where";
255 $dao = CRM_Core_DAO
::executeQuery($query, $params);
257 CRM_Utils_Hook
::custom($hookOP,
268 * Given a field return the mysql data type associated with it.
270 * @param string $type
271 * @param int $maxLength
274 * the mysql data store placeholder
276 public static function fieldToSQLType($type, $maxLength = 255) {
277 if (!isset($maxLength) ||
278 !is_numeric($maxLength) ||
287 return "varchar($maxLength)";
295 // the below three are FK's, and have constraints added to them
297 case 'ContactReference':
298 case 'StateProvince':
301 return 'int unsigned';
307 return 'decimal(20,2)';
310 case 'RichTextEditor':
317 CRM_Core_Error
::fatal();
322 * @param array $params
323 * @param $entityTable
324 * @param int $entityID
326 public static function store(&$params, $entityTable, $entityID) {
328 foreach ($params as $fieldID => $param) {
329 foreach ($param as $index => $customValue) {
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'],
343 // Fix Date type to be timestamp, since that is how we store in db.
344 if ($cvParam['type'] == 'Date') {
345 $cvParam['type'] = 'Timestamp';
348 if (!empty($customValue['id'])) {
349 $cvParam['id'] = $customValue['id'];
351 if (!array_key_exists($customValue['table_name'], $cvParams)) {
352 $cvParams[$customValue['table_name']] = array();
355 if (!array_key_exists($index, $cvParams[$customValue['table_name']])) {
356 $cvParams[$customValue['table_name']][$index] = array();
359 $cvParams[$customValue['table_name']][$index][] = $cvParam;
362 if (!empty($cvParams)) {
363 self
::create($cvParams);
368 * Post process function.
370 * @param array $params
371 * @param $entityTable
372 * @param int $entityID
373 * @param $customFieldExtends
375 public static function postProcess(&$params, $entityTable, $entityID, $customFieldExtends) {
376 $customData = CRM_Core_BAO_CustomField
::postProcess($params,
381 if (!empty($customData)) {
382 self
::store($customData, $entityTable, $entityID);
387 * Return an array of all custom values associated with an entity.
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
398 * @param array $fieldIDs
399 * Optional list of fieldIDs that we want to retrieve. If this.
400 * is set the entityType is ignored
402 * @param bool $formatMultiRecordField
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.
409 public static function &getEntityValues($entityID, $entityType = NULL, $fieldIDs = NULL, $formatMultiRecordField = FALSE) {
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');
419 $cond[] = "cg.extends IN ( '$entityType' )";
424 $fieldIDList = implode(',', $fieldIDs);
425 $cond[] = "cf.id IN ( $fieldIDList )";
428 $cond[] = "cg.extends IN ( 'Contact', 'Individual', 'Household', 'Organization' )";
430 $cond = implode(' AND ', $cond);
432 // First find all the fields that extend this type of entity.
434 SELECT cg.table_name,
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
447 $dao = CRM_Core_DAO
::executeQuery($query);
449 $select = $fields = $isMultiple = array();
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();
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
;
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;
474 $result["{$fieldID}_{$dao->id}"] = $dao->$fieldName;
478 $result[$fieldID] = $dao->$fieldName;
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
493 * @param array $params
498 public static function setValues(&$params) {
500 if (!isset($params['entityID']) ||
501 CRM_Utils_Type
::escape($params['entityID'], 'Integer', FALSE) === NULL
503 return CRM_Core_Error
::createAPIError(ts('entityID needs to be set and of type Integer'));
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
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',
518 if (!array_key_exists($fieldID, $fieldValues)) {
519 $fieldValues[$fieldID] = array();
522 if ($customFieldInfo[1]) {
523 $id = (int ) $customFieldInfo[1];
525 $fieldValues[$fieldID][] = array(
532 $fieldIDList = implode(',', array_keys($fieldValues));
534 // format it so that we can just use create
536 SELECT cg.table_name as table_name ,
538 cg.is_multiple as is_multiple,
539 cf.column_name as column_name,
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 )
548 $dao = CRM_Core_DAO
::executeQuery($sql);
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'] === '') {
561 $fieldValue['value'] = '';
565 $fieldValue['value'] = NULL;
568 case 'StateProvince':
572 $fieldValue['value'] = (int) 0;
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',
580 1 => $fieldValue['value'],
581 2 => $dao->data_type
,
587 'entity_id' => $params['entityID'],
588 'value' => $fieldValue['value'],
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
,
597 if ($cvParam['type'] == 'File') {
598 $cvParam['file_id'] = $fieldValue['value'];
601 if (!array_key_exists($dao->table_name
, $cvParams)) {
602 $cvParams[$dao->table_name
] = array();
605 if (!array_key_exists($fieldValue['id'], $cvParams[$dao->table_name
])) {
606 $cvParams[$dao->table_name
][$fieldValue['id']] = array();
609 if ($fieldValue['id'] > 0) {
610 $cvParam['id'] = $fieldValue['id'];
612 $cvParams[$dao->table_name
][$fieldValue['id']][] = $cvParam;
616 if (!empty($cvParams)) {
617 self
::create($cvParams);
618 return array('is_error' => 0, 'result' => 1);
621 return CRM_Core_Error
::createAPIError(ts('Unknown error'));
625 * Take in an array of entityID, custom_ID
626 * and gets the value from the appropriate table.
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 );
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
637 * @param array $params
642 public static function &getValues(&$params) {
643 if (empty($params)) {
646 if (!isset($params['entityID']) ||
647 CRM_Utils_Type
::escape($params['entityID'],
651 return CRM_Core_Error
::createAPIError(ts('entityID needs to be set and of type Integer'));
654 // first collect all the ids. The format is:
657 foreach ($params as $n => $v) {
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',
666 $fieldIDs[] = (int ) $idx;
670 $default = array('Contact', 'Individual', 'Household', 'Organization');
671 if (!($type = CRM_Utils_Array
::value('entityType', $params)) ||
672 in_array($params['entityType'], $default)
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)) {
686 return CRM_Core_Error
::createAPIError(ts('Invalid entity type') . ': "' . $type . '"');
691 $values = self
::getEntityValues($params['entityID'],
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
701 'error_message' => 'No values found for the specified entity ID and custom field(s).',
708 'entityID' => $params['entityID'],
710 foreach ($values as $id => $value) {
711 $result["custom_{$id}"] = $value;