3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * Business objects for managing custom data fields.
40 class CRM_Core_BAO_CustomField
extends CRM_Core_DAO_CustomField
{
43 * Array for valid combinations of data_type & descriptions
48 public static $_dataType = NULL;
51 * Array for valid combinations of data_type & html_type
56 public static $_dataToHtml = NULL;
59 * Array to hold (formatted) fields for import
64 public static $_importFields = NULL;
67 * Build and retrieve the list of data types and descriptions
71 * @return array Data type => Description
75 static function &dataType() {
76 if (!(self
::$_dataType)) {
77 self
::$_dataType = array(
78 'String' => ts('Alphanumeric'),
79 'Int' => ts('Integer'),
80 'Float' => ts('Number'),
81 'Money' => ts('Money'),
84 'Boolean' => ts('Yes or No'),
85 'StateProvince' => ts('State/Province'),
86 'Country' => ts('Country'),
89 'ContactReference' => ts('Contact Reference'),
92 return self
::$_dataType;
95 static function dataToHtml() {
96 if (!self
::$_dataToHtml) {
97 self
::$_dataToHtml = array(
99 'Text' => 'Text', 'Select' => 'Select',
100 'Radio' => 'Radio', 'CheckBox' => 'CheckBox',
101 'Multi-Select' => 'Multi-Select',
102 'AdvMulti-Select' => 'AdvMulti-Select',
103 'Autocomplete-Select' => 'Autocomplete-Select',
105 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
106 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
107 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
108 array('TextArea' => 'TextArea', 'RichTextEditor' => 'RichTextEditor'),
109 array('Date' => 'Select Date'),
110 array('Radio' => 'Radio'),
111 array('StateProvince' => 'Select State/Province', 'Multi-Select' => 'Multi-Select State/Province'),
112 array('Country' => 'Select Country', 'Multi-Select' => 'Multi-Select Country'),
113 array('File' => 'File'),
114 array('Link' => 'Link'),
115 array('ContactReference' => 'Autocomplete-Select'),
118 return self
::$_dataToHtml;
122 * takes an associative array and creates a custom field object
124 * This function is invoked from within the web form layer and also from the api layer
126 * @param array $params (reference) an assoc array of name/value pairs
128 * @return CRM_Core_DAO_CustomField object
132 static function create(&$params) {
133 $origParams = array_merge(array(), $params);
135 if (!isset($params['id'])) {
136 if (!isset($params['column_name'])) {
137 // if add mode & column_name not present, calculate it.
138 $params['column_name'] = strtolower(CRM_Utils_String
::munge($params['label'], '_', 32));
140 if (!isset($params['name'])) {
141 $params['name'] = CRM_Utils_String
::munge($params['label'], '_', 64);
145 $params['column_name'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
150 $columnName = $params['column_name'];
153 //as during create if field is_searchable we had created index.
154 if (!empty($params['id'])) {
155 $indexExist = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $params['id'], 'is_searchable');
158 switch (CRM_Utils_Array
::value('html_type', $params)){
160 if(empty($params['date_format'])){
161 $config = CRM_Core_Config
::singleton();
162 $params['date_format'] = $config->dateInputFormat
;
166 case 'AdvMulti-Select':
168 if (isset($params['default_checkbox_option'])) {
169 $tempArray = array_keys($params['default_checkbox_option']);
170 $defaultArray = array();
171 foreach ($tempArray as $k => $v) {
172 if ($params['option_value'][$v]) {
173 $defaultArray[] = $params['option_value'][$v];
177 if (!empty($defaultArray)) {
178 // also add the seperator before and after the value per new conventio (CRM-1604)
179 $params['default_value'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $defaultArray) . CRM_Core_DAO
::VALUE_SEPARATOR
;
183 if (!empty($params['default_option']) && isset($params['option_value'][$params['default_option']])
185 $params['default_value'] = $params['option_value'][$params['default_option']];
191 $transaction = new CRM_Core_Transaction();
192 // create any option group & values if required
193 if ($params['html_type'] != 'Text' &&
194 in_array($params['data_type'], array(
195 'String', 'Int', 'Float', 'Money'))
198 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup',
199 $params['custom_group_id'],
204 if ($params['option_type'] == 1) {
205 // first create an option group for this custom group
206 $optionGroup = new CRM_Core_DAO_OptionGroup();
207 $optionGroup->name
= "{$columnName}_" . date('YmdHis');
208 $optionGroup->title
= $params['label'];
209 $optionGroup->is_active
= 1;
210 $optionGroup->save();
211 $params['option_group_id'] = $optionGroup->id
;
212 if(!empty($params['option_value']) && is_array($params['option_value'])){
213 foreach ($params['option_value'] as $k => $v) {
214 if (strlen(trim($v))) {
215 $optionValue = new CRM_Core_DAO_OptionValue();
216 $optionValue->option_group_id
= $optionGroup->id
;
217 $optionValue->label
= $params['option_label'][$k];
218 $optionValue->name
= CRM_Utils_String
::titleToVar($params['option_label'][$k]);
219 switch ($params['data_type']) {
221 $optionValue->value
= CRM_Utils_Rule
::cleanMoney($v);
225 $optionValue->value
= intval($v);
229 $optionValue->value
= floatval($v);
233 $optionValue->value
= trim($v);
236 $optionValue->weight
= $params['option_weight'][$k];
237 $optionValue->is_active
= CRM_Utils_Array
::value($k, $params['option_status'], FALSE);
238 $optionValue->save();
245 // check for orphan option groups
246 if (!empty($params['option_group_id'])) {
247 if (!empty($params['id'])) {
248 self
::fixOptionGroups($params['id'], $params['option_group_id']);
251 // if we dont have a default value
252 // retrive it from one of the other custom fields which use this option group
253 if (empty($params['default_value'])) {
254 //don't insert only value separator as default value, CRM-4579
255 $defaultValue = self
::getOptionGroupDefault($params['option_group_id'],
259 if (!CRM_Utils_System
::isNull(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
262 $params['default_value'] = $defaultValue;
267 // since we need to save option group id :)
268 if (!isset($params['attributes']) && strtolower($params['html_type']) == 'textarea') {
269 $params['attributes'] = 'rows=4, cols=60';
272 $customField = new CRM_Core_DAO_CustomField();
273 $customField->copyValues($params);
274 $customField->is_required
= CRM_Utils_Array
::value('is_required', $params, FALSE);
275 $customField->is_searchable
= CRM_Utils_Array
::value('is_searchable', $params, FALSE);
276 $customField->is_search_range
= CRM_Utils_Array
::value('is_search_range', $params, FALSE);
277 $customField->is_active
= CRM_Utils_Array
::value('is_active', $params, FALSE);
278 $customField->is_view
= CRM_Utils_Array
::value('is_view', $params, FALSE);
279 $customField->save();
281 // make sure all values are present in the object for further processing
282 $customField->find(TRUE);
284 //create/drop the index when we toggle the is_searchable flag
285 if (!empty($params['id'])) {
286 self
::createField($customField, 'modify', $indexExist);
289 if (!isset($origParams['column_name'])) {
290 $columnName .= "_{$customField->id}";
291 $params['column_name'] = $columnName;
293 $customField->column_name
= $columnName;
294 $customField->save();
295 // make sure all values are present in the object
296 $customField->find(TRUE);
298 self
::createField($customField, 'add');
301 // complete transaction
302 $transaction->commit();
304 CRM_Utils_System
::flushCache();
310 * Takes a bunch of params that are needed to match certain criteria and
311 * retrieves the relevant objects. Typically the valid params are only
312 * contact_id. We'll tweak this function to be more full featured over a period
313 * of time. This is the inverse function of create. It also stores all the retrieved
314 * values in the default array
316 * @param array $params (reference ) an assoc array of name/value pairs
317 * @param array $defaults (reference ) an assoc array to hold the flattened values
319 * @return object CRM_Core_DAO_CustomField object
323 static function retrieve(&$params, &$defaults) {
324 return CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
328 * update the is_active flag in the db
330 * @param int $id Id of the database record
331 * @param boolean $is_active Value we want to set the is_active field
333 * @return Object DAO object on sucess, null otherwise
338 static function setIsActive($id, $is_active) {
340 CRM_Utils_System
::flushCache();
342 //enable-disable CustomField
343 CRM_Core_BAO_UFField
::setUFField($id, $is_active);
344 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_CustomField', $id, 'is_active', $is_active);
348 * Get the field title.
350 * @param int $id id of field.
352 * @return string name
358 public static function getTitle($id) {
359 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $id, 'label');
363 * Store and return an array of all active custom fields.
365 * @param string $customDataType type of Custom Data; empty is a synonym for "all contact data types"
366 * @param boolean $showAll If true returns all fields (includes disabled fields)
367 * @param boolean $inline If true returns all inline fields (includes disabled fields)
368 * @param int $customDataSubType Custom Data sub type value
369 * @param int $customDataSubName Custom Data sub name value
370 * @param boolean $onlyParent return only top level custom data, for eg, only Participant and ignore subname and subtype
371 * @param boolean $onlySubType return only custom data for subtype
372 * @param boolean $checkPermission if false, do not include permissioning clause
374 * @return array $fields - an array of active custom fields.
379 public static function &getFields($customDataType = 'Individual',
382 $customDataSubType = NULL,
383 $customDataSubName = NULL,
385 $onlySubType = FALSE,
386 $checkPermission = TRUE
388 if (empty($customDataType)) {
389 $customDataType = array('Contact', 'Individual', 'Organization', 'Household');
391 if ($customDataType && !is_array($customDataType)) {
393 if (in_array($customDataType, CRM_Contact_BAO_ContactType
::subTypes())) {
394 // This is the case when getFieldsForImport() requires fields
395 // limited strictly to a subtype.
396 $customDataSubType = $customDataType;
397 $customDataType = CRM_Contact_BAO_ContactType
::getBasicType($customDataType);
401 if (in_array($customDataType, array_keys(CRM_Core_SelectValues
::customGroupExtends()))) {
402 // this makes the method flexible to support retrieving fields
403 // for multiple extends value.
404 $customDataType = array($customDataType);
408 if ($customDataSubType && !is_array($customDataSubType)) {
409 $customDataSubType = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
410 trim($customDataSubType, CRM_Core_DAO
::VALUE_SEPARATOR
)
414 if (is_array($customDataType)) {
415 $cacheKey = implode('_', $customDataType);
418 $cacheKey = $customDataType;
421 $cacheKey .= !empty($customDataSubType) ?
('_' . implode('_', $customDataSubType)) : '_0';
422 $cacheKey .= $customDataSubName ?
"{$customDataSubName}_" : '_0';
423 $cacheKey .= $showAll ?
'_1' : '_0';
424 $cacheKey .= $inline ?
'_1_' : '_0_';
425 $cacheKey .= $onlyParent ?
'_1_' : '_0_';
426 $cacheKey .= $onlySubType ?
'_1_' : '_0_';
427 $cacheKey .= $checkPermission ?
'_1_' : '_0_';
429 $cgTable = CRM_Core_DAO_CustomGroup
::getTableName();
431 // also get the permission stuff here
432 if ($checkPermission) {
433 $permissionClause = CRM_Core_Permission
::customGroupClause(CRM_Core_Permission
::VIEW
,
438 $permissionClause = '(1)';
441 // lets md5 permission clause and take first 8 characters
442 $cacheKey .= substr(md5($permissionClause), 0, 8);
444 if (strlen($cacheKey) > 40) {
445 $cacheKey = md5($cacheKey);
448 if (!self
::$_importFields ||
449 CRM_Utils_Array
::value($cacheKey, self
::$_importFields) === NULL
451 if (!self
::$_importFields) {
452 self
::$_importFields = array();
455 // check if we can retrieve from database cache
456 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', "custom importableFields $cacheKey");
458 if ($fields === NULL) {
459 $cfTable = self
::getTableName();
462 if (is_array($customDataType)) {
464 foreach ($customDataType as $dataType) {
465 if (in_array($dataType, array_keys(CRM_Core_SelectValues
::customGroupExtends()))) {
466 if (in_array($dataType, array('Individual', 'Household', 'Organization'))) {
467 $val = "'" . CRM_Utils_Type
::escape($dataType, 'String') . "', 'Contact' ";
470 $val = "'" . CRM_Utils_Type
::escape($dataType, 'String') . "'";
472 $value = $value ?
$value . ", {$val}" : $val;
476 $extends = "AND $cgTable.extends IN ( $value ) ";
480 if (!empty($customDataType) && empty($extends)) {
481 // $customDataType specified a filter, but there is no corresponding SQL ($extends)
482 self
::$_importFields[$cacheKey] = array();
483 return self
::$_importFields[$cacheKey];
487 $extends .= " AND $cgTable.extends_entity_column_value IS NULL AND $cgTable.extends_entity_column_id IS NULL ";
490 $query = "SELECT $cfTable.id, $cfTable.label,
494 $cfTable.default_value,
495 $cfTable.options_per_line, $cfTable.text_length,
496 $cfTable.custom_group_id,
497 $cgTable.extends, $cfTable.is_search_range,
498 $cgTable.extends_entity_column_value,
499 $cgTable.extends_entity_column_id,
501 $cfTable.option_group_id,
502 $cfTable.date_format,
503 $cfTable.time_format,
507 ON $cfTable.custom_group_id = $cgTable.id
511 $query .= " AND $cfTable.is_active = 1 AND $cgTable.is_active = 1 ";
515 $query .= " AND $cgTable.style = 'Inline' ";
518 //get the custom fields for specific type in
519 //combination with fields those support any type.
520 if (!empty($customDataSubType)) {
521 $subtypeClause = array();
522 foreach ($customDataSubType as $subtype) {
523 $subtype = CRM_Core_DAO
::VALUE_SEPARATOR
. $subtype . CRM_Core_DAO
::VALUE_SEPARATOR
;
524 $subtypeClause[] = "$cgTable.extends_entity_column_value LIKE '%{$subtype}%'";
527 $subtypeClause[] = "$cgTable.extends_entity_column_value IS NULL";
529 $query .= " AND ( " . implode(' OR ', $subtypeClause) . " )";
532 if ($customDataSubName) {
533 $query .= " AND ( $cgTable.extends_entity_column_id = $customDataSubName ) ";
536 // also get the permission stuff here
537 if ($checkPermission) {
538 $permissionClause = CRM_Core_Permission
::customGroupClause(CRM_Core_Permission
::VIEW
,
543 $permissionClause = '(1)';
546 $query .= " $extends AND $permissionClause
547 ORDER BY $cgTable.weight, $cgTable.title,
548 $cfTable.weight, $cfTable.label";
550 $dao = CRM_Core_DAO
::executeQuery($query);
553 while (($dao->fetch()) != NULL) {
554 $fields[$dao->id
]['label'] = $dao->label
;
555 $fields[$dao->id
]['groupTitle'] = $dao->title
;
556 $fields[$dao->id
]['data_type'] = $dao->data_type
;
557 $fields[$dao->id
]['html_type'] = $dao->html_type
;
558 $fields[$dao->id
]['default_value'] = $dao->default_value
;
559 $fields[$dao->id
]['text_length'] = $dao->text_length
;
560 $fields[$dao->id
]['options_per_line'] = $dao->options_per_line
;
561 $fields[$dao->id
]['custom_group_id'] = $dao->custom_group_id
;
562 $fields[$dao->id
]['extends'] = $dao->extends;
563 $fields[$dao->id
]['is_search_range'] = $dao->is_search_range
;
564 $fields[$dao->id
]['extends_entity_column_value'] = $dao->extends_entity_column_value
;
565 $fields[$dao->id
]['extends_entity_column_id'] = $dao->extends_entity_column_id
;
566 $fields[$dao->id
]['is_view'] = $dao->is_view
;
567 $fields[$dao->id
]['is_multiple'] = $dao->is_multiple
;
568 $fields[$dao->id
]['option_group_id'] = $dao->option_group_id
;
569 $fields[$dao->id
]['date_format'] = $dao->date_format
;
570 $fields[$dao->id
]['time_format'] = $dao->time_format
;
573 CRM_Core_BAO_Cache
::setItem($fields,
575 "custom importableFields $cacheKey"
578 self
::$_importFields[$cacheKey] = $fields;
581 return self
::$_importFields[$cacheKey];
585 * Return the field ids and names (with groups) for import purpose.
587 * @param int $contactType Contact type
588 * @param boolean $showAll If true returns all fields (includes disabled fields)
589 * @param boolean $onlyParent return fields ONLY related to basic types
590 * @param boolean $search when called from search and multiple records need to be returned
591 * @param boolean $checkPermission if false, do not include permissioning clause
593 * @return array $fields -
598 public static function &getFieldsForImport($contactType = 'Individual',
602 $checkPermission = TRUE,
603 $withMultiple = FALSE
605 // Note: there are situations when we want getFieldsForImport() return fields related
606 // ONLY to basic contact types, but NOT subtypes. And thats where $onlyParent is helpful
607 $fields = &self
::getFields($contactType,
617 $importableFields = array();
618 foreach ($fields as $id => $values) {
619 // for now we should not allow multiple fields in profile / export etc, hence unsetting
621 (!empty($values['is_multiple']) && !$withMultiple)
626 /* generate the key for the fields array */
630 $regexp = preg_replace('/[.,;:!?]/', '', CRM_Utils_Array
::value(0, $values));
631 $importableFields[$key] = array(
633 'title' => CRM_Utils_Array
::value('label', $values),
634 'headerPattern' => '/' . preg_quote($regexp, '/') . '/',
636 'custom_field_id' => $id,
637 'options_per_line' => CRM_Utils_Array
::value('options_per_line', $values),
638 'data_type' => CRM_Utils_Array
::value('data_type', $values),
639 'html_type' => CRM_Utils_Array
::value('html_type', $values),
640 'is_search_range' => CRM_Utils_Array
::value('is_search_range', $values),
643 // CRM-6681, pass date and time format when html_type = Select Date
644 if (CRM_Utils_Array
::value('html_type', $values) == 'Select Date') {
645 $importableFields[$key]['date_format'] = CRM_Utils_Array
::value('date_format', $values);
646 $importableFields[$key]['time_format'] = CRM_Utils_Array
::value('time_format', $values);
650 return $importableFields;
654 * Get the field id from an import key
656 * @param string $key The key to parse
658 * @return int|null The id (if exists)
662 public static function getKeyID($key, $all = FALSE) {
664 if (preg_match('/^custom_(\d+)_?(-?\d+)?$/', $key, $match)) {
671 CRM_Utils_Array
::value(2, $match),
680 * Use the cache to get all values of a specific custom field
682 * @param int $fieldID the custom field ID
684 * @return object $field the field object
688 static function getFieldObject($fieldID) {
689 $field = new CRM_Core_DAO_CustomField();
691 // check if we can get the field values from the system cache
692 $cacheKey = "CRM_Core_DAO_CustomField_{$fieldID}";
693 $cache = CRM_Utils_Cache
::singleton();
694 $fieldValues = $cache->get($cacheKey);
695 if (empty($fieldValues)) {
696 $field->id
= $fieldID;
697 if (!$field->find(TRUE)) {
698 CRM_Core_Error
::fatal();
701 $fieldValues = array();
702 CRM_Core_DAO
::storeValues($field, $fieldValues);
704 $cache->set($cacheKey, $fieldValues);
707 $field->copyValues($fieldValues);
714 * This function for building custom fields
716 * @param object $qf form object (reference)
717 * @param string $elementName name of the custom field
718 * @param boolean $inactiveNeeded
719 * @param boolean $userRequired true if required else false
720 * @param boolean $search true if used for search else false
721 * @param string $label label for custom field
726 public static function addQuickFormElement(&$qf,
729 $inactiveNeeded = FALSE,
734 // we use $_POST directly, since we dont want to use session memory, CRM-4677
735 if (isset($_POST['_qf_Relationship_refresh']) &&
736 ($_POST['_qf_Relationship_refresh'] == 'Search' ||
737 $_POST['_qf_Relationship_refresh'] == 'Search Again'
740 $useRequired = FALSE;
743 $field = self
::getFieldObject($fieldId);
745 // Custom field HTML should indicate group+field name
746 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id
);
747 $dataCrmCustomVal = $groupName.':'.$field->name
;
748 $dataCrmCustomAttr = 'data-crm-custom="'.$dataCrmCustomVal.'"';
749 $field->attributes
.= $dataCrmCustomAttr;
751 // Fixed for Issue CRM-2183
752 if ($field->html_type
== 'TextArea' && $search) {
753 $field->html_type
= 'Text';
756 if (!isset($label)) {
757 $label = $field->label
;
761 * at some point in time we might want to split the below into small functions
764 switch ($field->html_type
) {
766 if ($field->is_search_range
&& $search) {
767 $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes
);
768 $qf->add('text', $elementName . '_to', ts('To'), $field->attributes
);
771 $element = &$qf->add(strtolower($field->html_type
), $elementName, $label,
773 $useRequired && !$search
779 $attributes = $dataCrmCustomAttr;
780 if ($field->note_rows
) {
781 $attributes .= 'rows=' . $field->note_rows
;
784 $attributes .= 'rows=4';
786 if ($field->note_columns
) {
787 $attributes .= ' cols=' . $field->note_columns
;
790 $attributes .= ' cols=60';
792 if ($field->text_length
) {
793 $attributes .= ' maxlength=' . $field->text_length
;
795 $element = &$qf->add(strtolower($field->html_type
),
799 $useRequired && !$search
804 if ($field->is_search_range
&& $search) {
805 $qf->addDate($elementName . '_from', $label . ' - ' . ts('From'), FALSE,
807 'format' => $field->date_format
,
808 'timeFormat' => $field->time_format
,
809 'startOffset' => $field->start_date_years
,
810 'endOffset' => $field->end_date_years
,
811 'data-crm-custom' => $dataCrmCustomVal,
815 $qf->addDate($elementName . '_to', ts('To'), FALSE,
817 'format' => $field->date_format
,
818 'timeFormat' => $field->time_format
,
819 'startOffset' => $field->start_date_years
,
820 'endOffset' => $field->end_date_years
,
821 'data-crm-custom' => $dataCrmCustomVal,
826 $required = $useRequired && !$search;
828 $qf->addDate($elementName, $label, $required, array(
829 'format' => $field->date_format
,
830 'timeFormat' => $field->time_format
,
831 'startOffset' => $field->start_date_years
,
832 'endOffset' => $field->end_date_years
,
833 'data-crm-custom' => $dataCrmCustomVal,
840 if ($field->data_type
!= 'Boolean') {
841 $customOption = &CRM_Core_BAO_CustomOption
::valuesByID($field->id
,
842 $field->option_group_id
844 foreach ($customOption as $v => $l) {
845 $choice[] = $qf->createElement('radio', NULL, '', $l, (string)$v, $field->attributes
);
847 $qf->addGroup($choice, $elementName, $label);
850 $choice[] = $qf->createElement('radio', NULL, '', ts('Yes'), '1', $field->attributes
);
851 $choice[] = $qf->createElement('radio', NULL, '', ts('No'), '0', $field->attributes
);
852 $qf->addGroup($choice, $elementName, $label);
854 if ($useRequired && !$search) {
855 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
860 $selectOption = &CRM_Core_BAO_CustomOption
::valuesByID($field->id
,
861 $field->option_group_id
863 $qf->add('select', $elementName, $label,
865 '' => ts('- select -')) +
$selectOption,
866 $useRequired && !$search,
871 //added for select multiple
873 case 'AdvMulti-Select':
874 $selectOption = &CRM_Core_BAO_CustomOption
::valuesByID($field->id
,
875 $field->option_group_id
878 count($selectOption) > 1
880 $selectOption['CiviCRM_OP_OR'] = ts('Select to match ANY; unselect to match ALL');
883 $include =& $qf->addElement(
886 $label, $selectOption,
890 'class' => 'advmultiselect',
891 'data-crm-custom' => $dataCrmCustomVal,
895 $include->setButtonAttributes('add', array('value' => ts('Add >>')));
896 $include->setButtonAttributes('remove', array('value' => ts('<< Remove')));
898 if ($useRequired && !$search) {
899 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
904 $selectOption = &CRM_Core_BAO_CustomOption
::valuesByID($field->id
,
905 $field->option_group_id
908 count($selectOption) > 1
910 $selectOption['CiviCRM_OP_OR'] = ts('Select to match ANY; unselect to match ALL');
912 $qf->addElement('select', $elementName, $label, $selectOption, array('size' => '5', 'multiple', 'data-crm-custom' => $dataCrmCustomVal));
914 if ($useRequired && !$search) {
915 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
920 $customOption = CRM_Core_BAO_CustomOption
::valuesByID($field->id
,
921 $field->option_group_id
924 foreach ($customOption as $v => $l) {
925 $check[] = &$qf->addElement('advcheckbox', $v, NULL, $l, array('data-crm-custom' => $dataCrmCustomVal));
930 $check[] = &$qf->addElement('advcheckbox', 'CiviCRM_OP_OR', NULL, ts('Check to match ANY; uncheck to match ALL'), array('data-crm-custom' => $dataCrmCustomVal));
932 $qf->addGroup($check, $elementName, $label);
933 if ($useRequired && !$search) {
934 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
939 // we should not build upload file in search mode
944 strtolower($field->html_type
),
948 $useRequired && !$search
950 $qf->addUploadElement($elementName);
953 case 'Select State/Province':
955 $stateOption = array('' => ts('- select -')) + CRM_Core_PseudoConstant
::stateProvince();
956 $qf->add('select', $elementName, $label, $stateOption,
957 $useRequired && !$search,
960 $qf->_stateCountryMap
['state_province'][] = $elementName;
963 case 'Multi-Select State/Province':
964 //Add Multi-select State/Province
965 $stateOption = CRM_Core_PseudoConstant
::stateProvince();
967 $qf->addElement('select', $elementName, $label, $stateOption, array('size' => '5', 'multiple', 'data-crm-custom' => $dataCrmCustomVal));
968 if ($useRequired && !$search) {
969 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
973 case 'Select Country':
975 $countryOption = array('' => ts('- select -')) + CRM_Core_PseudoConstant
::country();
976 $qf->add('select', $elementName, $label, $countryOption,
977 $useRequired && !$search,
980 $qf->_stateCountryMap
['country'][] = $elementName;
983 case 'Multi-Select Country':
985 $countryOption = CRM_Core_PseudoConstant
::country();
986 $qf->addElement('select', $elementName, $label, $countryOption, array('size' => '5', 'multiple', 'data-crm-custom' => $dataCrmCustomVal));
987 if ($useRequired && !$search) {
988 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
992 case 'RichTextEditor':
993 $attributes = array('rows' => $field->note_rows
, 'cols' => $field->note_columns
, 'data-crm-custom' => $dataCrmCustomVal);
994 if ($field->text_length
) {
995 $attributes['maxlength'] = $field->text_length
;
997 $qf->addWysiwyg($elementName, $label, $attributes, $search);
1000 case 'Autocomplete-Select':
1001 $qf->add('text', $elementName, $label, $field->attributes
,
1002 $useRequired && !$search
1005 $hiddenEleName = $elementName . '_id';
1006 if (substr($elementName, -1) == ']') {
1007 $hiddenEleName = substr($elementName, 0, -1) . '_id]';
1009 $qf->addElement('hidden', $hiddenEleName, '', array('id' => str_replace(array(']', '['), array('', '_'), $hiddenEleName)));
1011 static $customUrls = array();
1012 if ($field->data_type
== 'ContactReference') {
1013 //$urlParams = "className=CRM_Contact_Page_AJAX&fnName=getContactList&json=1&reset=1&context=customfield&id={$field->id}";
1014 $urlParams = "context=customfield&id={$field->id}";
1016 $customUrls[$elementName] = CRM_Utils_System
::url('civicrm/ajax/contactref',
1021 $actualElementValue = $qf->getSubmitValue($hiddenEleName);
1022 $qf->addRule($elementName, ts('Select a valid contact for %1.', array(1 => $label)), 'validContact', $actualElementValue);
1025 $customUrls[$elementName] = CRM_Utils_System
::url('civicrm/ajax/auto',
1026 "reset=1&ogid={$field->option_group_id}&cfid={$field->id}",
1029 $qf->addRule($elementName, ts('Select a valid value for %1.', array(1 => $label)),
1030 'autocomplete', array(
1031 'fieldID' => $field->id
,
1032 'optionGroupID' => $field->option_group_id
,
1037 $qf->assign('customUrls', $customUrls);
1041 switch ($field->data_type
) {
1043 // integers will have numeric rule applied to them.
1044 if ($field->is_search_range
&& $search) {
1045 $qf->addRule($elementName . '_from', ts('%1 From must be an integer (whole number).', array(1 => $label)), 'integer');
1046 $qf->addRule($elementName . '_to', ts('%1 To must be an integer (whole number).', array(1 => $label)), 'integer');
1049 $qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'integer');
1054 if ($field->is_search_range
&& $search) {
1055 $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1056 $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1059 $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1064 if ($field->is_search_range
&& $search) {
1065 $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1066 $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1069 $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1079 'onfocus' => "if (!this.value) { this.value='http://';} else return false",
1080 'onblur' => "if ( this.value == 'http://') { this.value='';} else return false",
1081 'data-crm-custom' => $dataCrmCustomVal,
1083 $useRequired && !$search
1085 $qf->addRule($elementName, ts('Enter a valid Website.'), 'wikiURL');
1088 if ($field->is_view
&& !$search) {
1089 $qf->freeze($elementName);
1094 * Delete the Custom Field.
1096 * @param object $field - the field object
1104 public static function deleteField($field) {
1105 CRM_Utils_System
::flushCache();
1107 // first delete the custom option group and values associated with this field
1108 if ($field->option_group_id
) {
1109 //check if option group is related to any other field, if
1110 //not delete the option group and related option values
1111 self
::checkOptionGroup($field->option_group_id
);
1114 // next drop the column from the custom value table
1115 self
::createField($field, 'delete');
1118 CRM_Core_BAO_UFField
::delUFField($field->id
);
1119 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_CustomField');
1125 * Given a custom field value, its id and the set of options
1126 * find the display value for this field
1128 * @param mixed $value the custom field value
1129 * @param int $id the custom field id
1130 * @param int $options the assoc array of option name/value pairs
1132 * @return string the display value
1137 static function getDisplayValue($value, $id, &$options, $contactID = NULL, $fieldID = NULL) {
1138 $option = &$options[$id];
1139 $attributes = &$option['attributes'];
1140 $html_type = $attributes['html_type'];
1141 $data_type = $attributes['data_type'];
1142 $format = CRM_Utils_Array
::value('format', $attributes);
1144 return self
::getDisplayValueCommon($value,
1154 static function getDisplayValueCommon($value,
1165 (($html_type == 'Radio' && $data_type != 'Boolean') ||
1166 ($html_type == 'Autocomplete-Select' && $data_type != 'ContactReference') ||
1167 $html_type == 'Select' ||
1168 $html_type == 'CheckBox' ||
1169 $html_type == 'AdvMulti-Select' ||
1170 $html_type == 'Multi-Select'
1173 CRM_Utils_Hook
::customFieldOptions($fieldID, $option);
1176 switch ($html_type) {
1178 if ($data_type == 'Boolean') {
1179 // Do not assume that if not yes means no.
1182 $display = ts('Yes');
1184 elseif ((string)$value === '0') {
1185 $display = ts('No');
1189 $display = CRM_Utils_Array
::value($value, $option);
1193 case 'Autocomplete-Select':
1194 if ($data_type == 'ContactReference' &&
1197 $display = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'display_name');
1200 $display = CRM_Utils_Array
::value($value, $option);
1205 $display = CRM_Utils_Array
::value($value, $option);
1209 case 'AdvMulti-Select':
1210 case 'Multi-Select':
1211 if (is_array($value)) {
1212 $checkedData = $value;
1215 $checkedData = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1216 substr($value, 1, -1)
1218 if ($html_type == 'CheckBox') {
1220 foreach ($checkedData as $v) {
1223 $checkedData = $newData;
1229 foreach ($checkedData as $key => $val) {
1230 if ($key === 'CiviCRM_OP_OR') {
1234 if ($html_type == 'CheckBox') {
1237 $v[] = CRM_Utils_Array
::value($key, $option);
1242 $v[] = CRM_Utils_Array
::value($val, $option);
1246 $display = implode(', ', $v);
1251 if (is_array($value)) {
1252 foreach ($value as $key => $val) {
1253 $display[$key] = CRM_Utils_Date
::customFormat($val);
1257 // remove time element display if time is not set
1258 if (empty($option['attributes']['time_format'])) {
1259 $value = substr($value, 0, 10);
1261 $display = CRM_Utils_Date
::customFormat($value);
1265 case 'Select State/Province':
1266 if (empty($value)) {
1270 $display = CRM_Core_PseudoConstant
::stateProvince($value);
1274 case 'Multi-Select State/Province':
1275 if (is_array($value)) {
1276 $checkedData = $value;
1279 $checkedData = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1280 substr($value, 1, -1)
1284 $states = CRM_Core_PseudoConstant
::stateProvince();
1286 foreach ($checkedData as $stateID) {
1290 $display .= $states[$stateID];
1294 case 'Select Country':
1295 if (empty($value)) {
1299 $display = CRM_Core_PseudoConstant
::country($value);
1303 case 'Multi-Select Country':
1304 if (is_array($value)) {
1305 $checkedData = $value;
1308 $checkedData = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1309 substr($value, 1, -1)
1313 $countries = CRM_Core_PseudoConstant
::country();
1315 foreach ($checkedData as $countryID) {
1319 $display .= $countries[$countryID];
1325 $url = self
::getFileURL($contactID, $fieldID, $value);
1327 $display = $url['file_url'];
1333 if (empty($value)) {
1337 $display = nl2br($value);
1342 if (empty($value)) {
1349 return $display ?
$display : $value;
1353 * Function to set default values for custom data used in profile
1355 * @params int $customFieldId custom field id
1356 * @params string $elementName custom field name
1357 * @params array $defaults associated array of fields
1358 * @params int $contactId contact id
1359 * @param int $mode profile mode
1360 * @param mixed $value if passed - dont fetch value from db,
1361 * just format the given value
1365 static function setProfileDefaults($customFieldId,
1372 //get the type of custom field
1373 $customField = new CRM_Core_BAO_CustomField();
1374 $customField->id
= $customFieldId;
1375 $customField->find(TRUE);
1378 if ($mode == CRM_Profile_Form
::MODE_CREATE
) {
1379 $value = $customField->default_value
;
1383 if (!isset($value)) {
1384 $info = self
::getTableColumnGroup($customFieldId);
1385 $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1386 $result = CRM_Core_DAO
::executeQuery($query);
1387 if ($result->fetch()) {
1388 $value = $result->value
;
1392 if ($customField->data_type
== 'Country') {
1394 $config = CRM_Core_Config
::singleton();
1395 if ($config->defaultContactCountry
) {
1396 $value = $config->defaultContactCountry();
1402 //set defaults if mode is registration
1403 if (!trim($value) &&
1405 (!in_array($mode, array(CRM_Profile_Form
::MODE_EDIT
, CRM_Profile_Form
::MODE_SEARCH
)))
1407 $value = $customField->default_value
;
1410 if ($customField->data_type
== 'Money' && isset($value)) {
1411 $value = number_format($value, 2);
1413 switch ($customField->html_type
) {
1415 case 'AdvMulti-Select':
1416 case 'Multi-Select':
1417 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldId, FALSE);
1418 $defaults[$elementName] = array();
1419 $checkedValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1420 substr($value, 1, -1)
1422 foreach ($customOption as $val) {
1423 if (in_array($val['value'], $checkedValue)) {
1424 if ($customField->html_type
== 'CheckBox') {
1425 $defaults[$elementName][$val['value']] = 1;
1427 elseif ($customField->html_type
== 'Multi-Select' ||
1428 $customField->html_type
== 'AdvMulti-Select'
1430 $defaults[$elementName][$val['value']] = $val['value'];
1438 list($defaults[$elementName], $defaults[$elementName . '_time']) = CRM_Utils_Date
::setDateDefaults(
1441 $customField->date_format
,
1442 $customField->time_format
1447 case 'Autocomplete-Select':
1448 if ($customField->data_type
== 'ContactReference') {
1449 if (is_numeric($value)) {
1450 $defaults[$elementName . '_id'] = $value;
1451 $defaults[$elementName] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name');
1455 $label = CRM_Core_BAO_CustomOption
::getOptionLabel($customField->id
, $value);
1456 $defaults[$elementName . '_id'] = $value;
1457 $defaults[$elementName] = $label;
1462 $defaults[$elementName] = $value;
1466 static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE) {
1469 $params = array('id' => $cfID);
1470 $defaults = array();
1471 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1472 $columnName = $defaults['column_name'];
1474 //table name of custom data
1475 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup',
1476 $defaults['custom_group_id'],
1480 //query to fetch id from civicrm_file
1481 $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1482 $fileID = CRM_Core_DAO
::singleValueQuery($query);
1487 $fileType = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File',
1492 $result['file_id'] = $fileID;
1494 if ($fileType == 'image/jpeg' ||
1495 $fileType == 'image/pjpeg' ||
1496 $fileType == 'image/gif' ||
1497 $fileType == 'image/x-png' ||
1498 $fileType == 'image/png'
1500 $entityId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_EntityFile',
1505 list($path) = CRM_Core_BAO_File
::path($fileID, $entityId, NULL, NULL);
1506 list($imageWidth, $imageHeight) = getimagesize($path);
1507 list($imageThumbWidth, $imageThumbHeight) = CRM_Contact_BAO_Contact
::getThumbSize($imageWidth, $imageHeight);
1508 $url = CRM_Utils_System
::url('civicrm/file',
1509 "reset=1&id=$fileID&eid=$contactID",
1510 $absolute, NULL, TRUE, TRUE
1512 $result['file_url'] = "
1513 <a href=\"$url\" class='crm-image-popup'>
1514 <img src=\"$url\" width=$imageThumbWidth height=$imageThumbHeight/>
1516 // for non image files
1519 $uri = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File',
1523 $url = CRM_Utils_System
::url('civicrm/file',
1524 "reset=1&id=$fileID&eid=$contactID",
1525 $absolute, NULL, TRUE, TRUE
1527 $result['file_url'] = "<a href=\"$url\">{$uri}</a>";
1535 * Format custom fields before inserting
1537 * @param int $customFieldId custom field id
1538 * @param array $customFormatted formatted array
1539 * @param mix $value value of custom field
1540 * @param string $customFieldExtend custom field extends
1541 * @param int $customValueId custom option value id
1542 * @param int $entityId entity id (contribution, membership...)
1543 * @param boolean $inline consider inline custom groups only
1544 * @param boolean $checkPermission if false, do not include permissioning clause
1546 * @return array $customFormatted formatted custom field array
1549 static function formatCustomField($customFieldId, &$customFormatted, $value,
1550 $customFieldExtend, $customValueId = NULL,
1553 $checkPermission = TRUE
1555 //get the custom fields for the entity
1556 //subtype and basic type
1557 $customDataSubType = NULL;
1558 if (is_array($customFieldExtend)) {
1559 $customFieldExtend = $customFieldExtend[0];
1562 if (in_array($customFieldExtend,
1563 CRM_Contact_BAO_ContactType
::subTypes()
1565 // This is the case when getFieldsForImport() requires fields
1566 // of subtype and its parent.CRM-5143
1567 $customDataSubType = $customFieldExtend;
1568 $customFieldExtend = CRM_Contact_BAO_ContactType
::getBasicType($customDataSubType);
1571 $customFields = CRM_Core_BAO_CustomField
::getFields($customFieldExtend,
1581 if (!array_key_exists($customFieldId, $customFields)) {
1585 // return if field is a 'code' field
1586 if (!empty($customFields[$customFieldId]['is_view'])) {
1590 list($tableName, $columnName, $groupID) = self
::getTableColumnGroup($customFieldId);
1592 if (!$customValueId &&
1593 // we always create new entites for is_multiple unless specified
1594 !$customFields[$customFieldId]['is_multiple'] &&
1600 WHERE entity_id={$entityId}";
1602 $customValueId = CRM_Core_DAO
::singleValueQuery($query);
1605 //fix checkbox, now check box always submits values
1606 if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1608 // Note that only during merge this is not an array, and you can directly use value
1609 if (is_array($value)) {
1610 $selectedValues = array();
1611 foreach ($value as $selId => $val) {
1613 $selectedValues[] = $selId;
1616 if (!empty($selectedValues)) {
1617 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1619 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1628 if ($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1629 $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select'
1632 // Note that only during merge this is not an array,
1633 // and you can directly use value, CRM-4385
1634 if (is_array($value)) {
1635 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1636 array_values($value)
1637 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1645 if (($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1646 $customFields[$customFieldId]['html_type'] == 'AdvMulti-Select' ||
1647 $customFields[$customFieldId]['html_type'] == 'CheckBox'
1649 $customFields[$customFieldId]['data_type'] == 'String' &&
1650 !empty($customFields[$customFieldId]['text_length']) &&
1653 // lets make sure that value is less than the length, else we'll
1654 // be losing some data, CRM-7481
1655 if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1656 // need to do a few things here
1658 // 1. lets find a new length
1659 $newLength = $customFields[$customFieldId]['text_length'];
1660 $minLength = strlen($value);
1661 while ($newLength < $minLength) {
1662 $newLength = $newLength * 2;
1665 // set the custom field meta data to have a length larger than value
1666 // alter the custom value table column to match this length
1667 CRM_Core_BAO_SchemaHandler
::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1672 if ($customFields[$customFieldId]['data_type'] == 'Date') {
1673 if (!CRM_Utils_System
::isNull($value)) {
1674 $format = $customFields[$customFieldId]['date_format'];
1675 $date = CRM_Utils_Date
::processDate($value, NULL, FALSE, 'YmdHis', $format);
1680 if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1681 $customFields[$customFieldId]['data_type'] == 'Money'
1687 if ($customFields[$customFieldId]['data_type'] == 'Money') {
1688 $value = CRM_Utils_Rule
::cleanMoney($value);
1692 if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1693 $customFields[$customFieldId]['data_type'] == 'Country'
1703 if ($customFields[$customFieldId]['data_type'] == 'File') {
1704 if (empty($value)) {
1708 $config = CRM_Core_Config
::singleton();
1710 $fName = $value['name'];
1711 $mimeType = $value['type'];
1713 $filename = pathinfo($fName, PATHINFO_BASENAME
);
1715 // rename this file to go into the secure directory
1716 if (!rename($fName, $config->customFileUploadDir
. $filename)) {
1717 CRM_Core_Error
::statusBounce(ts('Could not move custom file to custom upload directory'));
1721 if ($customValueId) {
1726 $params = array(1 => array($customValueId, 'Integer'));
1727 $fileId = CRM_Core_DAO
::singleValueQuery($query, $params);
1730 $fileDAO = new CRM_Core_DAO_File();
1733 $fileDAO->id
= $fileId;
1736 $fileDAO->uri
= $filename;
1737 $fileDAO->mime_type
= $mimeType;
1738 $fileDAO->upload_date
= date('Ymdhis');
1740 $fileId = $fileDAO->id
;
1744 if (!is_array($customFormatted)) {
1745 $customFormatted = array();
1748 if (!array_key_exists($customFieldId, $customFormatted)) {
1749 $customFormatted[$customFieldId] = array();
1753 if ($customValueId) {
1754 $index = $customValueId;
1757 if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1758 $customFormatted[$customFieldId][$index] = array();
1760 $customFormatted[$customFieldId][$index] = array(
1761 'id' => $customValueId > 0 ?
$customValueId : NULL,
1763 'type' => $customFields[$customFieldId]['data_type'],
1764 'custom_field_id' => $customFieldId,
1765 'custom_group_id' => $groupID,
1766 'table_name' => $tableName,
1767 'column_name' => $columnName,
1768 'file_id' => $fileId,
1769 'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1772 //we need to sort so that custom fields are created in the order of entry
1773 krsort($customFormatted[$customFieldId]);
1774 return $customFormatted;
1777 static function &defaultCustomTableSchema(&$params) {
1778 // add the id and extends_id
1780 'name' => $params['name'],
1781 'is_multiple' => $params['is_multiple'],
1782 'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci",
1786 'type' => 'int unsigned',
1789 'attributes' => 'AUTO_INCREMENT',
1790 'comment' => 'Default MySQL primary key',
1793 'name' => 'entity_id',
1794 'type' => 'int unsigned',
1796 'comment' => 'Table that this extends',
1797 'fk_table_name' => $params['extends_name'],
1798 'fk_field_name' => 'id',
1799 'fk_attributes' => 'ON DELETE CASCADE',
1804 if (!$params['is_multiple']) {
1805 $table['indexes'] = array(
1808 'field_name_1' => 'entity_id',
1815 static function createField($field, $operation, $indexExist = FALSE, $triggerRebuild = TRUE) {
1816 $tableName = CRM_Core_DAO
::getFieldValue(
1817 'CRM_Core_DAO_CustomGroup',
1818 $field->custom_group_id
,
1823 'table_name' => $tableName,
1824 'operation' => $operation,
1825 'name' => $field->column_name
,
1826 'type' => CRM_Core_BAO_CustomValueTable
::fieldToSQLType(
1830 'required' => $field->is_required
,
1831 'searchable' => $field->is_searchable
,
1834 if ($operation == 'delete') {
1835 $fkName = "{$tableName}_{$field->column_name}";
1836 if (strlen($fkName) >= 48) {
1837 $fkName = substr($fkName, 0, 32) . '_' . substr(md5($fkName), 0, 16);
1839 $params['fkName'] = $fkName;
1841 if ($field->data_type
== 'Country' && $field->html_type
== 'Select Country') {
1842 $params['fk_table_name'] = 'civicrm_country';
1843 $params['fk_field_name'] = 'id';
1844 $params['fk_attributes'] = 'ON DELETE SET NULL';
1846 elseif ($field->data_type
== 'Country' && $field->html_type
== 'Multi-Select Country') {
1847 $params['type'] = 'varchar(255)';
1849 elseif ($field->data_type
== 'StateProvince' && $field->html_type
== 'Select State/Province') {
1850 $params['fk_table_name'] = 'civicrm_state_province';
1851 $params['fk_field_name'] = 'id';
1852 $params['fk_attributes'] = 'ON DELETE SET NULL';
1854 elseif ($field->data_type
== 'StateProvince' && $field->html_type
== 'Multi-Select State/Province') {
1855 $params['type'] = 'varchar(255)';
1857 elseif ($field->data_type
== 'File') {
1858 $params['fk_table_name'] = 'civicrm_file';
1859 $params['fk_field_name'] = 'id';
1860 $params['fk_attributes'] = 'ON DELETE SET NULL';
1862 elseif ($field->data_type
== 'ContactReference') {
1863 $params['fk_table_name'] = 'civicrm_contact';
1864 $params['fk_field_name'] = 'id';
1865 $params['fk_attributes'] = 'ON DELETE SET NULL';
1867 if ($field->default_value
) {
1868 $params['default'] = "'{$field->default_value}'";
1871 CRM_Core_BAO_SchemaHandler
::alterFieldSQL($params, $indexExist, $triggerRebuild);
1875 * Determine whether it would be safe to move a field
1877 * @param int $fieldID FK to civicrm_custom_field
1878 * @param int $newGroupID FK to civicrm_custom_group
1883 static function _moveFieldValidate($fieldID, $newGroupID) {
1886 $field = new CRM_Core_DAO_CustomField();
1887 $field->id
= $fieldID;
1888 if (!$field->find(TRUE)) {
1889 $errors['fieldID'] = 'Invalid ID for custom field';
1893 $oldGroup = new CRM_Core_DAO_CustomGroup();
1894 $oldGroup->id
= $field->custom_group_id
;
1895 if (!$oldGroup->find(TRUE)) {
1896 $errors['fieldID'] = 'Invalid ID for old custom group';
1900 $newGroup = new CRM_Core_DAO_CustomGroup();
1901 $newGroup->id
= $newGroupID;
1902 if (!$newGroup->find(TRUE)) {
1903 $errors['newGroupID'] = 'Invalid ID for new custom group';
1909 FROM civicrm_custom_field a
1910 INNER JOIN civicrm_custom_field b
1912 AND a.label = b.label
1913 AND b.custom_group_id = %2
1916 1 => array($field->id
, 'Integer'),
1917 2 => array($newGroup->id
, 'Integer'),
1919 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1921 $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1924 $tableName = $oldGroup->table_name
;
1925 $columnName = $field->column_name
;
1930 WHERE $columnName is not null
1932 $count = CRM_Core_DAO
::singleValueQuery($query,
1933 CRM_Core_DAO
::$_nullArray
1938 FROM civicrm_custom_group
1939 WHERE id IN ( %1, %2 )
1941 $params = array(1 => array($oldGroup->id
, 'Integer'),
1942 2 => array($newGroup->id
, 'Integer'),
1945 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1947 while ($dao->fetch()) {
1948 $extends[] = $dao->extends;
1950 if ($extends[0] != $extends[1]) {
1951 $errors['newGroupID'] = ts('The destination group extends a different entity type.');
1955 return empty($errors) ?
TRUE : $errors;
1959 * Move a custom data field from one group (table) to another
1961 * @param int $fieldID FK to civicrm_custom_field
1962 * @param int $newGroupID FK to civicrm_custom_group
1966 static function moveField($fieldID, $newGroupID) {
1967 $validation = self
::_moveFieldValidate($fieldID, $newGroupID);
1968 if (TRUE !== $validation) {
1969 CRM_Core_Error
::fatal(implode(' ', $validation));
1971 $field = new CRM_Core_DAO_CustomField();
1972 $field->id
= $fieldID;
1975 $newGroup = new CRM_Core_DAO_CustomGroup();
1976 $newGroup->id
= $newGroupID;
1977 $newGroup->find(TRUE);
1979 $oldGroup = new CRM_Core_DAO_CustomGroup();
1980 $oldGroup->id
= $field->custom_group_id
;
1981 $oldGroup->find(TRUE);
1984 $add->custom_group_id
= $newGroup->id
;
1985 self
::createField($add, 'add');
1987 $sql = "INSERT INTO {$newGroup->table_name} (entity_id, {$field->column_name})
1988 SELECT entity_id, {$field->column_name} FROM {$oldGroup->table_name}
1989 ON DUPLICATE KEY UPDATE {$field->column_name} = {$oldGroup->table_name}.{$field->column_name}
1991 CRM_Core_DAO
::executeQuery($sql);
1994 $del->custom_group_id
= $oldGroup->id
;
1995 self
::createField($del, 'delete');
1999 CRM_Utils_System
::flushCache();
2003 * Get the database table name and column name for a custom field
2005 * @param int $fieldID - the fieldID of the custom field
2006 * @param boolean $force - force the sql to be run again (primarily used for tests)
2008 * @return array - fatal is fieldID does not exists, else array of tableName, columnName
2012 static function getTableColumnGroup($fieldID, $force = FALSE) {
2013 $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2014 $cache = CRM_Utils_Cache
::singleton();
2015 $fieldValues = $cache->get($cacheKey);
2016 if (empty($fieldValues) ||
$force) {
2018 SELECT cg.table_name, cf.column_name, cg.id
2019 FROM civicrm_custom_group cg,
2020 civicrm_custom_field cf
2021 WHERE cf.custom_group_id = cg.id
2023 $params = array(1 => array($fieldID, 'Integer'));
2024 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2026 if (!$dao->fetch()) {
2027 CRM_Core_Error
::fatal();
2030 $fieldValues = array($dao->table_name
, $dao->column_name
, $dao->id
);
2031 $cache->set($cacheKey, $fieldValues);
2033 return $fieldValues;
2037 * Function to get custom option groups
2039 * @params array $includeFieldIds ids of custom fields for which
2040 * option groups must be included.
2042 * Currently this is required in the cases where option groups are to be included
2043 * for inactive fields : CRM-5369
2047 * @return $customOptionGroup
2050 public static function &customOptionGroup($includeFieldIds = NULL) {
2051 static $customOptionGroup = NULL;
2053 $cacheKey = (empty($includeFieldIds)) ?
'onlyActive' : 'force';
2054 if ($cacheKey == 'force') {
2055 $customOptionGroup[$cacheKey] = NULL;
2058 if (empty($customOptionGroup[$cacheKey])) {
2059 $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2061 //support for single as well as array format.
2062 if (!empty($includeFieldIds)) {
2063 if (is_array($includeFieldIds)) {
2064 $includeFieldIds = implode(',', $includeFieldIds);
2066 $whereClause .= "OR f.id IN ( $includeFieldIds )";
2070 SELECT g.id, g.title
2071 FROM civicrm_option_group g
2072 INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id )
2073 WHERE {$whereClause}";
2075 $dao = CRM_Core_DAO
::executeQuery($query);
2076 while ($dao->fetch()) {
2077 $customOptionGroup[$cacheKey][$dao->id
] = $dao->title
;
2081 return $customOptionGroup[$cacheKey];
2085 * Function to fix orphan groups
2087 * @params int $customFieldId custom field id
2088 * @params int $optionGroupId option group id
2095 static function fixOptionGroups($customFieldId, $optionGroupId) {
2096 // check if option group belongs to any custom Field else delete
2097 // get the current option group
2098 $currentOptionGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
2102 // get the updated option group
2103 // if both are same return
2104 if ($currentOptionGroupId == $optionGroupId) {
2108 // check if option group is related to any other field
2109 self
::checkOptionGroup($currentOptionGroupId);
2113 * Function to check if option group is related to more than one
2116 * @params int $optionGroupId option group id
2121 static function checkOptionGroup($optionGroupId) {
2124 FROM civicrm_custom_field
2125 WHERE option_group_id = {$optionGroupId}";
2127 $count = CRM_Core_DAO
::singleValueQuery($query);
2130 //delete the option group
2131 CRM_Core_BAO_OptionGroup
::del($optionGroupId);
2135 static function getOptionGroupDefault($optionGroupId, $htmlType) {
2137 SELECT default_value, html_type
2138 FROM civicrm_custom_field
2139 WHERE option_group_id = {$optionGroupId}
2140 AND default_value IS NOT NULL
2141 ORDER BY html_type";
2143 $dao = CRM_Core_DAO
::executeQuery($query);
2144 $defaultValue = NULL;
2145 $defaultHTMLType = NULL;
2146 while ($dao->fetch()) {
2147 if ($dao->html_type
== $htmlType) {
2148 return $dao->default_value
;
2150 if ($defaultValue == NULL) {
2151 $defaultValue = $dao->default_value
;
2152 $defaultHTMLType = $dao->html_type
;
2156 // some conversions are needed if either the old or new has a html type which has potential
2157 // multiple default values.
2158 if (($htmlType == 'CheckBox' ||
$htmlType == 'Multi-Select') &&
2159 ($defaultHTMLType != 'CheckBox' && $defaultHTMLType != 'Multi-Select')
2161 $defaultValue = CRM_Core_DAO
::VALUE_SEPARATOR
. $defaultValue . CRM_Core_DAO
::VALUE_SEPARATOR
;
2163 elseif (($defaultHTMLType == 'CheckBox' ||
$defaultHTMLType == 'Multi-Select') &&
2164 ($htmlType != 'CheckBox' && $htmlType != 'Multi-Select')
2166 $defaultValue = substr($defaultValue, 1, -1);
2167 $values = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2168 substr($defaultValue, 1, -1)
2170 $defaultValue = $values[0];
2173 return $defaultValue;
2176 static function postProcess(&$params,
2179 $customFieldExtends,
2182 $customData = array();
2184 foreach ($params as $key => $value) {
2185 if ($customFieldInfo = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE)) {
2187 // for autocomplete transfer hidden value instead of label
2188 if ($params[$key] && isset($params[$key . '_id'])) {
2189 $value = $params[$key . '_id'];
2192 // we need to append time with date
2193 if ($params[$key] && isset($params[$key . '_time'])) {
2194 $value .= ' ' . $params[$key . '_time'];
2197 CRM_Core_BAO_CustomField
::formatCustomField($customFieldInfo[0],
2200 $customFieldExtends,
2201 $customFieldInfo[1],
2210 static function buildOption($field, &$options) {
2211 // Fixme - adding anything but options to the $options array is a bad idea
2212 // What if an option had the key 'attributes'?
2213 $options['attributes'] = array(
2214 'label' => $field['label'],
2215 'data_type' => $field['data_type'],
2216 'html_type' => $field['html_type'],
2219 $optionGroupID = NULL;
2220 if (($field['html_type'] == 'CheckBox' ||
2221 $field['html_type'] == 'Radio' ||
2222 $field['html_type'] == 'Select' ||
2223 $field['html_type'] == 'AdvMulti-Select' ||
2224 $field['html_type'] == 'Multi-Select' ||
2225 ($field['html_type'] == 'Autocomplete-Select' && $field['data_type'] != 'ContactReference')
2227 if ($field['option_group_id']) {
2228 $optionGroupID = $field['option_group_id'];
2230 elseif ($field['data_type'] != 'Boolean') {
2231 CRM_Core_Error
::fatal();
2235 // build the cache for custom values with options (label => value)
2236 if ($optionGroupID != NULL) {
2239 FROM civicrm_option_value
2240 WHERE option_group_id = $optionGroupID
2243 $dao = CRM_Core_DAO
::executeQuery($query);
2244 while ($dao->fetch()) {
2245 if ($field['data_type'] == 'Int' ||
$field['data_type'] == 'Float') {
2246 $num = round($dao->value
, 2);
2247 $options["$num"] = $dao->label
;
2250 $options[$dao->value
] = $dao->label
;
2254 CRM_Utils_Hook
::customFieldOptions($field['id'], $options);
2258 static function getCustomFieldID($fieldLabel, $groupTitle = NULL) {
2259 $params = array(1 => array($fieldLabel, 'String'));
2261 $params[2] = array($groupTitle, 'String');
2264 FROM civicrm_custom_field f
2265 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2266 WHERE ( f.label = %1 OR f.name = %1 )
2267 AND ( g.title = %2 OR g.name = %2 )
2273 FROM civicrm_custom_field f
2274 WHERE ( f.label = %1 OR f.name = %1 )
2278 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2279 if ($dao->fetch() &&
2290 * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2293 static function getNameFromID($ids) {
2294 if (is_array($ids)) {
2295 $ids = implode(',', $ids);
2298 SELECT f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2299 FROM civicrm_custom_field f
2300 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2301 WHERE f.id IN ($ids)";
2304 $dao = CRM_Core_DAO
::executeQuery($sql);
2306 while ($dao->fetch()) {
2307 $result[$dao->id
] = array(
2308 'field_name' => $dao->field_name
,
2309 'field_label' => $dao->field_label
,
2310 'group_name' => $dao->group_name
,
2311 'group_title' => $dao->group_title
,
2318 * Validate custom data.
2320 * @param array $params custom data submitted.
2321 * ie array( 'custom_1' => 'validate me' );
2323 * @return array $errors validation errors.
2326 static function validateCustomData($params) {
2328 if (!is_array($params) ||
empty($params)) {
2333 //pick up profile fields.
2334 $profileFields = array();
2335 $ufGroupId = CRM_Utils_Array
::value('ufGroupId', $params);
2337 $profileFields = CRM_Core_BAO_UFGroup
::getFields($ufGroupId,
2339 CRM_Core_Action
::VIEW
2343 //lets start w/ params.
2344 foreach ($params as $key => $value) {
2345 $customFieldID = self
::getKeyID($key);
2346 if (!$customFieldID) {
2350 //load the structural info for given field.
2351 $field = new CRM_Core_DAO_CustomField();
2352 $field->id
= $customFieldID;
2353 if (!$field->find(TRUE)) {
2356 $dataType = $field->data_type
;
2358 $profileField = CRM_Utils_Array
::value($key, $profileFields, array());
2359 $fieldTitle = CRM_Utils_Array
::value('title', $profileField);
2360 $isRequired = CRM_Utils_Array
::value('is_required', $profileField);
2362 $fieldTitle = $field->label
;
2365 //no need to validate.
2366 if (CRM_Utils_System
::isNull($value) && !$isRequired) {
2370 //lets validate first for required field.
2371 if ($isRequired && CRM_Utils_System
::isNull($value)) {
2372 $errors[$key] = ts('%1 is a required field.', array(1 => $fieldTitle));
2376 //now time to take care of custom field form rules.
2377 $ruleName = $errorMsg = NULL;
2378 switch ($dataType) {
2380 $ruleName = 'integer';
2381 $errorMsg = ts('%1 must be an integer (whole number).',
2382 array(1 => $fieldTitle)
2387 $ruleName = 'money';
2388 $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2389 array(1 => $fieldTitle)
2394 $ruleName = 'numeric';
2395 $errorMsg = ts('%1 must be a number (with or without decimal point).',
2396 array(1 => $fieldTitle)
2401 $ruleName = 'wikiURL';
2402 $errorMsg = ts('%1 must be valid Website.',
2403 array(1 => $fieldTitle)
2408 if ($ruleName && !CRM_Utils_System
::isNull($value)) {
2410 $funName = "CRM_Utils_Rule::{$ruleName}";
2411 if (is_callable($funName)) {
2412 $valid = call_user_func($funName, $value);
2415 $errors[$key] = $errorMsg;
2423 static function isMultiRecordField($customId) {
2424 $isMultipleWithGid = FALSE;
2425 if (!is_numeric($customId)) {
2426 $customId = self
::getKeyID($customId);
2428 if (is_numeric($customId)) {
2429 $sql = "SELECT cg.id cgId
2430 FROM civicrm_custom_group cg
2431 INNER JOIN civicrm_custom_field cf
2432 ON cg.id = cf.custom_group_id
2433 WHERE cf.id = %1 AND cg.is_multiple = 1";
2434 $params[1] = array($customId, 'Integer');
2435 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2436 if ($dao->fetch()) {
2438 $isMultipleWithGid = $dao->cgId
;
2443 return $isMultipleWithGid;