3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2018 |
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-2018
35 * Business objects for managing custom data fields.
37 class CRM_Core_BAO_CustomField
extends CRM_Core_DAO_CustomField
{
40 * Array for valid combinations of data_type & descriptions.
44 public static $_dataType = NULL;
47 * Array for valid combinations of data_type & html_type.
51 public static $_dataToHtml = NULL;
54 * Array to hold (formatted) fields for import
58 public static $_importFields = NULL;
61 * Build and retrieve the list of data types and descriptions.
64 * Data type => Description
66 public static function &dataType() {
67 if (!(self
::$_dataType)) {
68 self
::$_dataType = array(
69 'String' => ts('Alphanumeric'),
70 'Int' => ts('Integer'),
71 'Float' => ts('Number'),
72 'Money' => ts('Money'),
75 'Boolean' => ts('Yes or No'),
76 'StateProvince' => ts('State/Province'),
77 'Country' => ts('Country'),
80 'ContactReference' => ts('Contact Reference'),
83 return self
::$_dataType;
87 * Build the map of custom field's data types and there respective Util type
90 * Data data-type => CRM_Utils_Type
92 public static function dataToType() {
94 'String' => CRM_Utils_Type
::T_STRING
,
95 'Int' => CRM_Utils_Type
::T_INT
,
96 'Money' => CRM_Utils_Type
::T_MONEY
,
97 'Memo' => CRM_Utils_Type
::T_LONGTEXT
,
98 'Float' => CRM_Utils_Type
::T_FLOAT
,
99 'Date' => CRM_Utils_Type
::T_DATE
,
100 'DateTime' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
101 'Boolean' => CRM_Utils_Type
::T_BOOLEAN
,
102 'StateProvince' => CRM_Utils_Type
::T_INT
,
103 'File' => CRM_Utils_Type
::T_STRING
,
104 'Link' => CRM_Utils_Type
::T_STRING
,
105 'ContactReference' => CRM_Utils_Type
::T_INT
,
106 'Country' => CRM_Utils_Type
::T_INT
,
111 * Get data to html array.
113 * (Does this caching achieve anything?)
117 public static function dataToHtml() {
118 if (!self
::$_dataToHtml) {
119 self
::$_dataToHtml = array(
122 'Select' => 'Select',
124 'CheckBox' => 'CheckBox',
125 'Multi-Select' => 'Multi-Select',
126 'Autocomplete-Select' => 'Autocomplete-Select',
128 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
129 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
130 array('Text' => 'Text', 'Select' => 'Select', 'Radio' => 'Radio'),
131 array('TextArea' => 'TextArea', 'RichTextEditor' => 'RichTextEditor'),
132 array('Date' => 'Select Date'),
133 array('Radio' => 'Radio'),
134 array('StateProvince' => 'Select State/Province', 'Multi-Select' => 'Multi-Select State/Province'),
135 array('Country' => 'Select Country', 'Multi-Select' => 'Multi-Select Country'),
136 array('File' => 'File'),
137 array('Link' => 'Link'),
138 array('ContactReference' => 'Autocomplete-Select'),
141 return self
::$_dataToHtml;
145 * Takes an associative array and creates a custom field object.
147 * This function is invoked from within the web form layer and also from the api layer
149 * @param array $params
150 * (reference) an assoc array of name/value pairs.
152 * @return CRM_Core_DAO_CustomField
154 public static function create(&$params) {
155 $origParams = array_merge(array(), $params);
157 $op = empty($params['id']) ?
'create' : 'edit';
159 CRM_Utils_Hook
::pre($op, 'CustomField', CRM_Utils_Array
::value('id', $params), $params);
161 if ($op == 'create') {
162 if (!isset($params['column_name'])) {
163 // if add mode & column_name not present, calculate it.
164 $params['column_name'] = strtolower(CRM_Utils_String
::munge($params['label'], '_', 32));
166 if (!isset($params['name'])) {
167 $params['name'] = CRM_Utils_String
::munge($params['label'], '_', 64);
171 $params['column_name'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
176 $columnName = $params['column_name'];
179 //as during create if field is_searchable we had created index.
180 if (!empty($params['id'])) {
181 $indexExist = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $params['id'], 'is_searchable');
184 switch (CRM_Utils_Array
::value('html_type', $params)) {
186 if (empty($params['date_format'])) {
187 $config = CRM_Core_Config
::singleton();
188 $params['date_format'] = $config->dateInputFormat
;
194 if (isset($params['default_checkbox_option'])) {
195 $tempArray = array_keys($params['default_checkbox_option']);
196 $defaultArray = array();
197 foreach ($tempArray as $k => $v) {
198 if ($params['option_value'][$v]) {
199 $defaultArray[] = $params['option_value'][$v];
203 if (!empty($defaultArray)) {
204 // also add the separator before and after the value per new convention (CRM-1604)
205 $params['default_value'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $defaultArray) . CRM_Core_DAO
::VALUE_SEPARATOR
;
209 if (!empty($params['default_option']) && isset($params['option_value'][$params['default_option']])
211 $params['default_value'] = $params['option_value'][$params['default_option']];
217 $transaction = new CRM_Core_Transaction();
219 $htmlType = CRM_Utils_Array
::value('html_type', $params);
220 $dataType = CRM_Utils_Array
::value('data_type', $params);
221 $allowedOptionTypes = array('String', 'Int', 'Float', 'Money');
223 // create any option group & values if required
224 if ($htmlType != 'Text' && in_array($dataType, $allowedOptionTypes)
226 //CRM-16659: if option_value then create an option group for this custom field.
227 if ($params['option_type'] == 1 && (empty($params['option_group_id']) ||
!empty($params['option_value']))) {
228 // first create an option group for this custom group
229 $optionGroup = new CRM_Core_DAO_OptionGroup();
230 $optionGroup->name
= "{$columnName}_" . date('YmdHis');
231 $optionGroup->title
= $params['label'];
232 $optionGroup->is_active
= 1;
233 // Don't set reserved as it's not a built-in option group and may be useful for other custom fields.
234 $optionGroup->is_reserved
= 0;
235 $optionGroup->data_type
= $dataType;
236 $optionGroup->save();
237 $params['option_group_id'] = $optionGroup->id
;
238 if (!empty($params['option_value']) && is_array($params['option_value'])) {
239 foreach ($params['option_value'] as $k => $v) {
240 if (strlen(trim($v))) {
241 $optionValue = new CRM_Core_DAO_OptionValue();
242 $optionValue->option_group_id
= $optionGroup->id
;
243 $optionValue->label
= $params['option_label'][$k];
244 $optionValue->name
= CRM_Utils_String
::titleToVar($params['option_label'][$k]);
247 $optionValue->value
= CRM_Utils_Rule
::cleanMoney($v);
251 $optionValue->value
= intval($v);
255 $optionValue->value
= floatval($v);
259 $optionValue->value
= trim($v);
262 $optionValue->weight
= $params['option_weight'][$k];
263 $optionValue->is_active
= CRM_Utils_Array
::value($k, $params['option_status'], FALSE);
264 $optionValue->save();
271 // check for orphan option groups
272 if (!empty($params['option_group_id'])) {
273 if (!empty($params['id'])) {
274 self
::fixOptionGroups($params['id'], $params['option_group_id']);
277 // if we do not have a default value
278 // retrieve it from one of the other custom fields which use this option group
279 if (empty($params['default_value'])) {
280 //don't insert only value separator as default value, CRM-4579
281 $defaultValue = self
::getOptionGroupDefault($params['option_group_id'],
285 if (!CRM_Utils_System
::isNull(explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
289 $params['default_value'] = $defaultValue;
294 // since we need to save option group id :)
295 if (!isset($params['attributes']) && strtolower($htmlType) == 'textarea') {
296 $params['attributes'] = 'rows=4, cols=60';
299 $customField = new CRM_Core_DAO_CustomField();
300 $customField->copyValues($params);
301 if ($op == 'create') {
302 $customField->is_required
= CRM_Utils_Array
::value('is_required', $params, FALSE);
303 $customField->is_searchable
= CRM_Utils_Array
::value('is_searchable', $params, FALSE);
304 $customField->in_selector
= CRM_Utils_Array
::value('in_selector', $params, FALSE);
305 $customField->is_search_range
= CRM_Utils_Array
::value('is_search_range', $params, FALSE);
306 //CRM-15792 - Custom field gets disabled if is_active not set
307 $customField->is_active
= CRM_Utils_Array
::value('is_active', $params, TRUE);
308 $customField->is_view
= CRM_Utils_Array
::value('is_view', $params, FALSE);
310 $customField->save();
312 // make sure all values are present in the object for further processing
313 $customField->find(TRUE);
315 $triggerRebuild = CRM_Utils_Array
::value('triggerRebuild', $params, TRUE);
316 //create/drop the index when we toggle the is_searchable flag
318 self
::createField($customField, 'modify', $indexExist, $triggerRebuild);
321 if (!isset($origParams['column_name'])) {
322 $columnName .= "_{$customField->id}";
323 $params['column_name'] = $columnName;
325 $customField->column_name
= $columnName;
326 $customField->save();
327 // make sure all values are present in the object
328 $customField->find(TRUE);
331 self
::createField($customField, 'add', $indexExist, $triggerRebuild);
334 // complete transaction
335 $transaction->commit();
337 CRM_Utils_Hook
::post($op, 'CustomField', $customField->id
, $customField);
339 CRM_Utils_System
::flushCache();
345 * Fetch object based on array of properties.
347 * @param array $params
348 * (reference ) an assoc array of name/value pairs.
349 * @param array $defaults
350 * (reference ) an assoc array to hold the flattened values.
352 * @return CRM_Core_DAO_CustomField
354 public static function retrieve(&$params, &$defaults) {
355 return CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
359 * Update the is_active flag in the db.
362 * Id of the database record.
363 * @param bool $is_active
364 * Value we want to set the is_active field.
367 * true if we found and updated the object, else false
369 public static function setIsActive($id, $is_active) {
371 CRM_Utils_System
::flushCache();
373 //enable-disable CustomField
374 CRM_Core_BAO_UFField
::setUFField($id, $is_active);
375 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_CustomField', $id, 'is_active', $is_active);
379 * Get the field title.
387 public static function getTitle($id) {
388 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField', $id, 'label');
392 * @param string $context
395 public function getOptions($context = NULL) {
396 CRM_Core_DAO
::buildOptionsContext($context);
401 if (!$this->data_type ||
!$this->custom_group_id
) {
405 // This will hold the list of options in format key => label
408 if (!empty($this->option_group_id
)) {
409 $options = CRM_Core_OptionGroup
::valuesByID(
410 $this->option_group_id
,
415 !($context == 'validate' ||
$context == 'get')
418 elseif ($this->data_type
=== 'StateProvince') {
419 $options = CRM_Core_Pseudoconstant
::stateProvince();
421 elseif ($this->data_type
=== 'Country') {
422 $options = $context == 'validate' ? CRM_Core_Pseudoconstant
::countryIsoCode() : CRM_Core_Pseudoconstant
::country();
424 elseif ($this->data_type
=== 'Boolean') {
425 $options = $context == 'validate' ?
array(0, 1) : CRM_Core_SelectValues
::boolean();
427 CRM_Utils_Hook
::customFieldOptions($this->id
, $options, FALSE);
428 CRM_Utils_Hook
::fieldOptions($this->getEntity(), "custom_{$this->id}", $options, array('context' => $context));
433 * Store and return an array of all active custom fields.
435 * @param string $customDataType
436 * Type of Custom Data; empty is a synonym for "all contact data types".
437 * @param bool $showAll
438 * If true returns all fields (includes disabled fields).
439 * @param bool $inline
440 * If true returns all inline fields (includes disabled fields).
441 * @param int $customDataSubType
442 * Custom Data sub type value.
443 * @param int $customDataSubName
444 * Custom Data sub name value.
445 * @param bool $onlyParent
446 * Return only top level custom data, for eg, only Participant and ignore subname and subtype.
447 * @param bool $onlySubType
448 * Return only custom data for subtype.
449 * @param bool $checkPermission
450 * If false, do not include permissioning clause.
453 * an array of active custom fields.
455 public static function &getFields(
456 $customDataType = 'Individual',
459 $customDataSubType = NULL,
460 $customDataSubName = NULL,
462 $onlySubType = FALSE,
463 $checkPermission = TRUE
465 if (empty($customDataType)) {
466 $customDataType = array('Contact', 'Individual', 'Organization', 'Household');
468 if ($customDataType && !is_array($customDataType)) {
470 if (in_array($customDataType, CRM_Contact_BAO_ContactType
::subTypes())) {
471 // This is the case when getFieldsForImport() requires fields
472 // limited strictly to a subtype.
473 $customDataSubType = $customDataType;
474 $customDataType = CRM_Contact_BAO_ContactType
::getBasicType($customDataType);
478 if (in_array($customDataType, array_keys(CRM_Core_SelectValues
::customGroupExtends()))) {
479 // this makes the method flexible to support retrieving fields
480 // for multiple extends value.
481 $customDataType = array($customDataType);
485 $customDataSubType = CRM_Utils_Array
::explodePadded($customDataSubType);
487 if (is_array($customDataType)) {
488 $cacheKey = implode('_', $customDataType);
491 $cacheKey = $customDataType;
494 $cacheKey .= !empty($customDataSubType) ?
('_' . implode('_', $customDataSubType)) : '_0';
495 $cacheKey .= $customDataSubName ?
"{$customDataSubName}_" : '_0';
496 $cacheKey .= $showAll ?
'_1' : '_0';
497 $cacheKey .= $inline ?
'_1_' : '_0_';
498 $cacheKey .= $onlyParent ?
'_1_' : '_0_';
499 $cacheKey .= $onlySubType ?
'_1_' : '_0_';
500 $cacheKey .= $checkPermission ?
'_1_' : '_0_';
502 $cgTable = CRM_Core_DAO_CustomGroup
::getTableName();
504 // also get the permission stuff here
505 if ($checkPermission) {
506 $permissionClause = CRM_Core_Permission
::customGroupClause(CRM_Core_Permission
::VIEW
,
511 $permissionClause = '(1)';
514 // lets md5 permission clause and take first 8 characters
515 $cacheKey .= substr(md5($permissionClause), 0, 8);
517 if (strlen($cacheKey) > 40) {
518 $cacheKey = md5($cacheKey);
521 if (!self
::$_importFields ||
522 CRM_Utils_Array
::value($cacheKey, self
::$_importFields) === NULL
524 if (!self
::$_importFields) {
525 self
::$_importFields = array();
528 // check if we can retrieve from database cache
529 $fields = CRM_Core_BAO_Cache
::getItem('contact fields', "custom importableFields $cacheKey");
531 if ($fields === NULL) {
532 $cfTable = self
::getTableName();
535 if (is_array($customDataType)) {
537 foreach ($customDataType as $dataType) {
538 if (in_array($dataType, array_keys(CRM_Core_SelectValues
::customGroupExtends()))) {
539 if (in_array($dataType, array('Individual', 'Household', 'Organization'))) {
540 $val = "'" . CRM_Utils_Type
::escape($dataType, 'String') . "', 'Contact' ";
543 $val = "'" . CRM_Utils_Type
::escape($dataType, 'String') . "'";
545 $value = $value ?
$value . ", {$val}" : $val;
549 $extends = "AND $cgTable.extends IN ( $value ) ";
553 if (!empty($customDataType) && empty($extends)) {
554 // $customDataType specified a filter, but there is no corresponding SQL ($extends)
555 self
::$_importFields[$cacheKey] = array();
556 return self
::$_importFields[$cacheKey];
560 $extends .= " AND $cgTable.extends_entity_column_value IS NULL AND $cgTable.extends_entity_column_id IS NULL ";
563 $query = "SELECT $cfTable.id, $cfTable.label,
567 $cfTable.default_value,
568 $cfTable.options_per_line, $cfTable.text_length,
569 $cfTable.custom_group_id,
570 $cfTable.is_required,
571 $cfTable.column_name,
572 $cgTable.extends, $cfTable.is_search_range,
573 $cgTable.extends_entity_column_value,
574 $cgTable.extends_entity_column_id,
576 $cfTable.option_group_id,
577 $cfTable.date_format,
578 $cfTable.time_format,
579 $cgTable.is_multiple,
581 og.name as option_group_name
584 ON $cfTable.custom_group_id = $cgTable.id
585 LEFT JOIN civicrm_option_group og
586 ON $cfTable.option_group_id = og.id
590 $query .= " AND $cfTable.is_active = 1 AND $cgTable.is_active = 1 ";
594 $query .= " AND $cgTable.style = 'Inline' ";
597 //get the custom fields for specific type in
598 //combination with fields those support any type.
599 if (!empty($customDataSubType)) {
600 $subtypeClause = array();
601 foreach ($customDataSubType as $subtype) {
602 $subtype = CRM_Core_DAO
::VALUE_SEPARATOR
. $subtype . CRM_Core_DAO
::VALUE_SEPARATOR
;
603 $subtypeClause[] = "$cgTable.extends_entity_column_value LIKE '%{$subtype}%'";
606 $subtypeClause[] = "$cgTable.extends_entity_column_value IS NULL";
608 $query .= " AND ( " . implode(' OR ', $subtypeClause) . " )";
611 if ($customDataSubName) {
612 $query .= " AND ( $cgTable.extends_entity_column_id = $customDataSubName ) ";
615 // also get the permission stuff here
616 if ($checkPermission) {
617 $permissionClause = CRM_Core_Permission
::customGroupClause(CRM_Core_Permission
::VIEW
,
622 $permissionClause = '(1)';
625 $query .= " $extends AND $permissionClause
626 ORDER BY $cgTable.weight, $cgTable.title,
627 $cfTable.weight, $cfTable.label";
629 $dao = CRM_Core_DAO
::executeQuery($query);
632 while (($dao->fetch()) != NULL) {
633 $fields[$dao->id
]['label'] = $dao->label
;
634 $fields[$dao->id
]['groupTitle'] = $dao->title
;
635 $fields[$dao->id
]['data_type'] = $dao->data_type
;
636 $fields[$dao->id
]['html_type'] = $dao->html_type
;
637 $fields[$dao->id
]['default_value'] = $dao->default_value
;
638 $fields[$dao->id
]['text_length'] = $dao->text_length
;
639 $fields[$dao->id
]['options_per_line'] = $dao->options_per_line
;
640 $fields[$dao->id
]['custom_group_id'] = $dao->custom_group_id
;
641 $fields[$dao->id
]['extends'] = $dao->extends;
642 $fields[$dao->id
]['is_search_range'] = $dao->is_search_range
;
643 $fields[$dao->id
]['extends_entity_column_value'] = $dao->extends_entity_column_value
;
644 $fields[$dao->id
]['extends_entity_column_id'] = $dao->extends_entity_column_id
;
645 $fields[$dao->id
]['is_view'] = $dao->is_view
;
646 $fields[$dao->id
]['is_multiple'] = $dao->is_multiple
;
647 $fields[$dao->id
]['option_group_id'] = $dao->option_group_id
;
648 $fields[$dao->id
]['date_format'] = $dao->date_format
;
649 $fields[$dao->id
]['time_format'] = $dao->time_format
;
650 $fields[$dao->id
]['is_required'] = $dao->is_required
;
651 $fields[$dao->id
]['table_name'] = $dao->table_name
;
652 $fields[$dao->id
]['column_name'] = $dao->column_name
;
653 self
::getOptionsForField($fields[$dao->id
], $dao->option_group_name
);
656 CRM_Core_BAO_Cache
::setItem($fields,
658 "custom importableFields $cacheKey"
661 self
::$_importFields[$cacheKey] = $fields;
664 return self
::$_importFields[$cacheKey];
668 * Return the field ids and names (with groups) for import purpose.
670 * @param int|string $contactType Contact type
671 * @param bool $showAll
672 * If true returns all fields (includes disabled fields).
673 * @param bool $onlyParent
674 * Return fields ONLY related to basic types.
675 * @param bool $search
676 * When called from search and multiple records need to be returned.
677 * @param bool $checkPermission
678 * If false, do not include permissioning clause.
680 * @param bool $withMultiple
684 public static function getFieldsForImport(
685 $contactType = 'Individual',
689 $checkPermission = TRUE,
690 $withMultiple = FALSE
692 // Note: there are situations when we want getFieldsForImport() return fields related
693 // ONLY to basic contact types, but NOT subtypes. And thats where $onlyParent is helpful
694 $fields = &self
::getFields($contactType,
704 $importableFields = array();
705 foreach ($fields as $id => $values) {
706 // for now we should not allow multiple fields in profile / export etc, hence unsetting
708 (!empty($values['is_multiple']) && !$withMultiple)
713 /* generate the key for the fields array */
717 $regexp = preg_replace('/[.,;:!?]/', '', CRM_Utils_Array
::value(0, $values));
718 $importableFields[$key] = array(
720 'type' => CRM_Utils_Array
::value(CRM_Utils_Array
::value('data_type', $values), self
::dataToType()),
721 'title' => CRM_Utils_Array
::value('label', $values),
722 'headerPattern' => '/' . preg_quote($regexp, '/') . '/',
724 'custom_field_id' => $id,
725 'options_per_line' => CRM_Utils_Array
::value('options_per_line', $values),
726 'text_length' => CRM_Utils_Array
::value('text_length', $values, 255),
727 'data_type' => CRM_Utils_Array
::value('data_type', $values),
728 'html_type' => CRM_Utils_Array
::value('html_type', $values),
729 'is_search_range' => CRM_Utils_Array
::value('is_search_range', $values),
732 // CRM-6681, pass date and time format when html_type = Select Date
733 if (CRM_Utils_Array
::value('html_type', $values) == 'Select Date') {
734 $importableFields[$key]['date_format'] = CRM_Utils_Array
::value('date_format', $values);
735 $importableFields[$key]['time_format'] = CRM_Utils_Array
::value('time_format', $values);
739 return $importableFields;
743 * Get the field id from an import key.
753 public static function getKeyID($key, $all = FALSE) {
755 if (preg_match('/^custom_(\d+)_?(-?\d+)?$/', $key, $match)) {
762 CRM_Utils_Array
::value(2, $match),
766 return $all ?
array(NULL, NULL) : NULL;
770 * Use the cache to get all values of a specific custom field.
772 * @param int $fieldID
773 * The custom field ID.
775 * @return CRM_Core_BAO_CustomField
778 public static function getFieldObject($fieldID) {
779 $field = new CRM_Core_BAO_CustomField();
781 // check if we can get the field values from the system cache
782 $cacheKey = "CRM_Core_DAO_CustomField_{$fieldID}";
783 $cache = CRM_Utils_Cache
::singleton();
784 $fieldValues = $cache->get($cacheKey);
785 if (empty($fieldValues)) {
786 $field->id
= $fieldID;
787 if (!$field->find(TRUE)) {
788 CRM_Core_Error
::fatal();
791 $fieldValues = array();
792 CRM_Core_DAO
::storeValues($field, $fieldValues);
794 $cache->set($cacheKey, $fieldValues);
797 $field->copyValues($fieldValues);
804 * Add a custom field to an existing form.
806 * @param CRM_Core_Form $qf
807 * Form object (reference).
808 * @param string $elementName
809 * Name of the custom field.
810 * @param int $fieldId
811 * @param bool $useRequired
812 * True if required else false.
813 * @param bool $search
814 * True if used for search else false.
815 * @param string $label
816 * Label for custom field.
817 * @return \HTML_QuickForm_Element|null
818 * @throws \CiviCRM_API3_Exception
820 public static function addQuickFormElement(
821 $qf, $elementName, $fieldId, $useRequired = TRUE, $search = FALSE, $label = NULL
823 $field = self
::getFieldObject($fieldId);
824 $widget = $field->html_type
;
826 $customFieldAttributes = array();
828 // Custom field HTML should indicate group+field name
829 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $field->custom_group_id
);
830 $dataCrmCustomVal = $groupName . ':' . $field->name
;
831 $dataCrmCustomAttr = 'data-crm-custom="' . $dataCrmCustomVal . '"';
832 $field->attributes
.= $dataCrmCustomAttr;
834 // Fixed for Issue CRM-2183
835 if ($widget == 'TextArea' && $search) {
839 $placeholder = $search ?
ts('- any -') : ($useRequired ?
ts('- select -') : ts('- none -'));
841 // FIXME: Why are select state/country separate widget types?
842 $isSelect = (in_array($widget, array(
845 'Select State/Province',
846 'Multi-Select State/Province',
848 'Multi-Select Country',
854 $options = $field->getOptions($search ?
'search' : 'create');
856 // Consolidate widget types to simplify the below switch statement
857 if ($search ||
(strpos($widget, 'Select') !== FALSE)) {
861 $customFieldAttributes['data-crm-custom'] = $dataCrmCustomVal;
862 $selectAttributes = array('class' => 'crm-select2');
864 // Search field is always multi-select
865 if ($search ||
strpos($field->html_type
, 'Multi') !== FALSE) {
866 $selectAttributes['class'] .= ' huge';
867 $selectAttributes['multiple'] = 'multiple';
868 $selectAttributes['placeholder'] = $placeholder;
871 // Add data for popup link. Normally this is handled by CRM_Core_Form->addSelect
872 $isSupportedWidget = in_array($widget, ['Select', 'Radio']);
873 $canEditOptions = CRM_Core_Permission
::check('administer CiviCRM');
874 if ($field->option_group_id
&& !$search && $isSelect && $canEditOptions) {
875 $customFieldAttributes +
= array(
876 'data-api-entity' => $field->getEntity(),
877 'data-api-field' => 'custom_' . $field->id
,
878 'data-option-edit-path' => 'civicrm/admin/options/' . CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup', $field->option_group_id
),
880 $selectAttributes +
= $customFieldAttributes;
884 if (!isset($label)) {
885 $label = $field->label
;
888 // at some point in time we might want to split the below into small functions
893 if ($field->is_search_range
&& $search) {
894 $qf->add('text', $elementName . '_from', $label . ' ' . ts('From'), $field->attributes
);
895 $qf->add('text', $elementName . '_to', ts('To'), $field->attributes
);
898 if ($field->text_length
) {
899 $field->attributes
.= ' maxlength=' . $field->text_length
;
900 if ($field->text_length
< 20) {
901 $field->attributes
.= ' size=' . $field->text_length
;
904 $element = $qf->add('text', $elementName, $label,
906 $useRequired && !$search
912 $attributes = $dataCrmCustomAttr;
913 if ($field->note_rows
) {
914 $attributes .= 'rows=' . $field->note_rows
;
917 $attributes .= 'rows=4';
919 if ($field->note_columns
) {
920 $attributes .= ' cols=' . $field->note_columns
;
923 $attributes .= ' cols=60';
925 if ($field->text_length
) {
926 $attributes .= ' maxlength=' . $field->text_length
;
928 $element = $qf->add('textarea',
932 $useRequired && !$search
937 $attr = array('data-crm-custom' => $dataCrmCustomVal);
938 //CRM-18379: Fix for date range of 'Select Date' custom field when include in profile.
939 $minYear = isset($field->start_date_years
) ?
(date('Y') - $field->start_date_years
) : NULL;
940 $maxYear = isset($field->end_date_years
) ?
(date('Y') +
$field->end_date_years
) : NULL;
943 'date' => $field->date_format
,
944 'minDate' => isset($minYear) ?
$minYear . '-01-01' : NULL,
945 //CRM-18487 - max date should be the last date of the year.
946 'maxDate' => isset($maxYear) ?
$maxYear . '-12-31' : NULL,
947 'time' => $field->time_format ?
$field->time_format
* 12 : FALSE,
949 if ($field->is_search_range
&& $search) {
950 $qf->add('datepicker', $elementName . '_from', $label, $attr +
array('placeholder' => ts('From')), FALSE, $params);
951 $qf->add('datepicker', $elementName . '_to', NULL, $attr +
array('placeholder' => ts('To')), FALSE, $params);
954 $element = $qf->add('datepicker', $elementName, $label, $attr, $useRequired && !$search, $params);
960 parse_str($field->attributes
, $radioAttributes);
961 $radioAttributes = array_merge($radioAttributes, $customFieldAttributes);
963 foreach ($options as $v => $l) {
964 $choice[] = $qf->createElement('radio', NULL, '', $l, (string) $v, $radioAttributes);
966 $element = $qf->addGroup($choice, $elementName, $label);
967 $optionEditKey = 'data-option-edit-path';
968 if (isset($selectAttributes[$optionEditKey])) {
969 $element->setAttribute($optionEditKey, $selectAttributes[$optionEditKey]);
972 if ($useRequired && !$search) {
973 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
976 $element->setAttribute('allowClear', TRUE);
980 // For all select elements
982 if (empty($selectAttributes['multiple'])) {
983 $options = array('' => $placeholder) +
$options;
985 $element = $qf->add('select', $elementName, $label, $options, $useRequired && !$search, $selectAttributes);
987 // Add and/or option for fields that store multiple values
988 if ($search && self
::isSerialized($field)) {
991 $qf->createElement('radio', NULL, '', ts('Any'), 'or', array('title' => ts('Results may contain any of the selected options'))),
992 $qf->createElement('radio', NULL, '', ts('All'), 'and', array('title' => ts('Results must have all of the selected options'))),
994 $qf->addGroup($operators, $elementName . '_operator');
995 $qf->setDefaults(array($elementName . '_operator' => 'or'));
1001 foreach ($options as $v => $l) {
1002 $check[] = &$qf->addElement('advcheckbox', $v, NULL, $l, $customFieldAttributes);
1005 $group = $element = $qf->addGroup($check, $elementName, $label);
1006 $optionEditKey = 'data-option-edit-path';
1007 if (isset($customFieldAttributes[$optionEditKey])) {
1008 $group->setAttribute($optionEditKey, $customFieldAttributes[$optionEditKey]);
1011 if ($useRequired && !$search) {
1012 $qf->addRule($elementName, ts('%1 is a required field.', array(1 => $label)), 'required');
1017 // we should not build upload file in search mode
1021 $element = $qf->add(
1022 strtolower($field->html_type
),
1026 $useRequired && !$search
1028 $qf->addUploadElement($elementName);
1031 case 'RichTextEditor':
1032 $attributes = array(
1033 'rows' => $field->note_rows
,
1034 'cols' => $field->note_columns
,
1035 'data-crm-custom' => $dataCrmCustomVal,
1037 if ($field->text_length
) {
1038 $attributes['maxlength'] = $field->text_length
;
1040 $element = $qf->add('wysiwyg', $elementName, $label, $attributes, $useRequired && !$search);
1043 case 'Autocomplete-Select':
1044 static $customUrls = array();
1045 // Fixme: why is this a string in the first place??
1046 $attributes = array();
1047 if ($field->attributes
) {
1048 foreach (explode(' ', $field->attributes
) as $at) {
1049 if (strpos($at, '=')) {
1050 list($k, $v) = explode('=', $at);
1051 $attributes[$k] = trim($v, ' "');
1055 if ($field->data_type
== 'ContactReference') {
1056 // break if contact does not have permission to access ContactReference
1057 if (!CRM_Core_Permission
::check('access contact reference fields')) {
1060 $attributes['class'] = (isset($attributes['class']) ?
$attributes['class'] . ' ' : '') . 'crm-form-contact-reference huge';
1061 $attributes['data-api-entity'] = 'Contact';
1062 $element = $qf->add('text', $elementName, $label, $attributes, $useRequired && !$search);
1064 $urlParams = "context=customfield&id={$field->id}";
1065 $idOfelement = $elementName;
1066 // dev/core#362 if in an onbehalf profile clean up the name to get rid of square brackets that break the select 2 js
1067 if (strpos($elementName, '[') && strpos($elementName, ']')) {
1068 $idOfelement = substr(substr($elementName, (strpos($elementName, '[') +
1)), 0, -1);
1070 $customUrls[$idOfelement] = CRM_Utils_System
::url('civicrm/ajax/contactref',
1077 // FIXME: This won't work with customFieldOptions hook
1078 $attributes +
= array(
1079 'entity' => 'option_value',
1080 'placeholder' => $placeholder,
1081 'multiple' => $search,
1083 'params' => array('option_group_id' => $field->option_group_id
),
1086 $element = $qf->addEntityRef($elementName, $label, $attributes, $useRequired && !$search);
1089 $qf->assign('customUrls', $customUrls);
1093 switch ($field->data_type
) {
1095 // integers will have numeric rule applied to them.
1096 if ($field->is_search_range
&& $search) {
1097 $qf->addRule($elementName . '_from', ts('%1 From must be an integer (whole number).', array(1 => $label)), 'integer');
1098 $qf->addRule($elementName . '_to', ts('%1 To must be an integer (whole number).', array(1 => $label)), 'integer');
1100 elseif ($widget == 'Text') {
1101 $qf->addRule($elementName, ts('%1 must be an integer (whole number).', array(1 => $label)), 'integer');
1106 if ($field->is_search_range
&& $search) {
1107 $qf->addRule($elementName . '_from', ts('%1 From must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1108 $qf->addRule($elementName . '_to', ts('%1 To must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1110 elseif ($widget == 'Text') {
1111 $qf->addRule($elementName, ts('%1 must be a number (with or without decimal point).', array(1 => $label)), 'numeric');
1116 if ($field->is_search_range
&& $search) {
1117 $qf->addRule($elementName . '_from', ts('%1 From must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1118 $qf->addRule($elementName . '_to', ts('%1 To must in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1120 elseif ($widget == 'Text') {
1121 $qf->addRule($elementName, ts('%1 must be in proper money format. (decimal point/comma/space is allowed).', array(1 => $label)), 'money');
1126 $element->setAttribute('class', "url");
1127 $qf->addRule($elementName, ts('Enter a valid web address beginning with \'http://\' or \'https://\'.'), 'wikiURL');
1130 if ($field->is_view
&& !$search) {
1131 $qf->freeze($elementName);
1137 * Delete the Custom Field.
1139 * @param object $field
1142 public static function deleteField($field) {
1143 CRM_Utils_System
::flushCache();
1145 // first delete the custom option group and values associated with this field
1146 if ($field->option_group_id
) {
1147 //check if option group is related to any other field, if
1148 //not delete the option group and related option values
1149 self
::checkOptionGroup($field->option_group_id
);
1152 // next drop the column from the custom value table
1153 self
::createField($field, 'delete');
1156 CRM_Core_BAO_UFField
::delUFField($field->id
);
1157 CRM_Utils_Weight
::correctDuplicateWeights('CRM_Core_DAO_CustomField');
1159 CRM_Utils_Hook
::post('delete', 'CustomField', $field->id
, $field);
1163 * @param string|int|array|null $value
1164 * @param CRM_Core_BAO_CustomField|int|array|string $field
1165 * @param int $entityId
1168 * @throws \Exception
1170 public static function displayValue($value, $field, $entityId = NULL) {
1171 $field = is_array($field) ?
$field['id'] : $field;
1172 $fieldId = is_object($field) ?
$field->id
: (int) str_replace('custom_', '', $field);
1175 throw new Exception('CRM_Core_BAO_CustomField::displayValue requires a field id');
1178 if (!is_a($field, 'CRM_Core_BAO_CustomField')) {
1179 $field = self
::getFieldObject($fieldId);
1182 $fieldInfo = array('options' => $field->getOptions()) +
(array) $field;
1184 return self
::formatDisplayValue($value, $fieldInfo, $entityId);
1188 * Lower-level logic for rendering a custom field value
1190 * @param string|array $value
1191 * @param array $field
1192 * @param int|null $entityId
1196 private static function formatDisplayValue($value, $field, $entityId = NULL) {
1198 if (self
::isSerialized($field) && !is_array($value)) {
1199 $value = CRM_Utils_Array
::explodePadded($value);
1202 if ($field['html_type'] == 'CheckBox') {
1203 CRM_Utils_Array
::formatArrayKeys($value);
1206 $display = is_array($value) ?
implode(', ', $value) : (string) $value;
1208 switch ($field['html_type']) {
1211 case 'Autocomplete-Select':
1213 case 'Select Country':
1214 case 'Select State/Province':
1216 case 'Multi-Select':
1217 case 'Multi-Select State/Province':
1218 case 'Multi-Select Country':
1219 if ($field['data_type'] == 'ContactReference' && $value) {
1220 if (is_numeric($value)) {
1221 $display = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'display_name');
1227 elseif (is_array($value)) {
1229 foreach ($value as $key => $val) {
1230 $v[] = CRM_Utils_Array
::value($val, $field['options']);
1232 $display = implode(', ', $v);
1235 $display = CRM_Utils_Array
::value($value, $field['options'], '');
1240 $customFormat = NULL;
1242 // FIXME: Are there any legitimate reasons why $value would be an array?
1243 // Or should we throw an exception here if it is?
1244 $value = is_array($value) ? CRM_Utils_Array
::first($value) : $value;
1246 $actualPHPFormats = CRM_Utils_Date
::datePluginToPHPFormats();
1247 $format = CRM_Utils_Array
::value('date_format', $field);
1250 if (array_key_exists($format, $actualPHPFormats)) {
1251 $customTimeFormat = (array) $actualPHPFormats[$format];
1252 switch (CRM_Utils_Array
::value('time_format', $field)) {
1254 $customTimeFormat[] = 'g:iA';
1258 $customTimeFormat[] = 'G:i';
1262 //If time is not selected remove time from value.
1263 $value = $value ?
date('Y-m-d', strtotime($value)) : '';
1265 $customFormat = implode(" ", $customTimeFormat);
1268 $display = CRM_Utils_Date
::processDate($value, NULL, FALSE, $customFormat);
1272 // In the context of displaying a profile, show file/image
1275 if (CRM_Utils_Rule
::positiveInteger($value)) {
1279 $fileId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File', $value, 'id', 'uri');
1281 $url = self
::getFileURL($entityId, $field['id'], $fileId);
1283 $display = $url['file_url'];
1287 // In other contexts show a paperclip icon
1288 if (CRM_Utils_Rule
::integer($value)) {
1289 $icons = CRM_Core_BAO_File
::paperIconAttachment('*', $value);
1290 $display = $icons[$value];
1293 //CRM-18396, if filename is passed instead
1301 $display = $display ?
"<a href=\"$display\" target=\"_blank\">$display</a>" : $display;
1305 $display = nl2br($display);
1309 if ($field['data_type'] == 'Money' && isset($value)) {
1310 //$value can also be an array(while using IN operator from search builder or api).
1311 foreach ((array) $value as $val) {
1312 $disp[] = CRM_Utils_Money
::format($val, NULL, NULL, TRUE);
1314 $display = implode(', ', $disp);
1322 * Set default values for custom data used in profile.
1324 * @param int $customFieldId
1326 * @param string $elementName
1327 * Custom field name.
1328 * @param array $defaults
1329 * Associated array of fields.
1330 * @param int $contactId
1334 * @param mixed $value
1335 * If passed - dont fetch value from db,.
1336 * just format the given value
1338 public static function setProfileDefaults(
1346 //get the type of custom field
1347 $customField = new CRM_Core_BAO_CustomField();
1348 $customField->id
= $customFieldId;
1349 $customField->find(TRUE);
1352 if ($mode == CRM_Profile_Form
::MODE_CREATE
) {
1353 $value = $customField->default_value
;
1357 if (!isset($value)) {
1358 $info = self
::getTableColumnGroup($customFieldId);
1359 $query = "SELECT {$info[0]}.{$info[1]} as value FROM {$info[0]} WHERE {$info[0]}.entity_id = {$contactId}";
1360 $result = CRM_Core_DAO
::executeQuery($query);
1361 if ($result->fetch()) {
1362 $value = $result->value
;
1366 if ($customField->data_type
== 'Country') {
1368 $config = CRM_Core_Config
::singleton();
1369 if ($config->defaultContactCountry
) {
1370 $value = $config->defaultContactCountry();
1376 //set defaults if mode is registration
1377 if (!trim($value) &&
1379 (!in_array($mode, array(CRM_Profile_Form
::MODE_EDIT
, CRM_Profile_Form
::MODE_SEARCH
)))
1381 $value = $customField->default_value
;
1384 if ($customField->data_type
== 'Money' && isset($value)) {
1385 $value = number_format($value, 2);
1387 switch ($customField->html_type
) {
1389 case 'Multi-Select':
1390 $customOption = CRM_Core_BAO_CustomOption
::getCustomOption($customFieldId, FALSE);
1391 $defaults[$elementName] = array();
1392 $checkedValue = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1393 substr($value, 1, -1)
1395 foreach ($customOption as $val) {
1396 if (in_array($val['value'], $checkedValue)) {
1397 if ($customField->html_type
== 'CheckBox') {
1398 $defaults[$elementName][$val['value']] = 1;
1400 elseif ($customField->html_type
== 'Multi-Select') {
1401 $defaults[$elementName][$val['value']] = $val['value'];
1407 case 'Autocomplete-Select':
1408 if ($customField->data_type
== 'ContactReference') {
1409 if (is_numeric($value)) {
1410 $defaults[$elementName . '_id'] = $value;
1411 $defaults[$elementName] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact', $value, 'sort_name');
1415 $defaults[$elementName] = $value;
1420 $defaults[$elementName] = $value;
1427 * @param int $contactID
1429 * @param int $fileID
1430 * @param bool $absolute
1432 * @param string $multiRecordWhereClause
1436 public static function getFileURL($contactID, $cfID, $fileID = NULL, $absolute = FALSE, $multiRecordWhereClause = NULL) {
1439 $params = array('id' => $cfID);
1440 $defaults = array();
1441 CRM_Core_DAO
::commonRetrieve('CRM_Core_DAO_CustomField', $params, $defaults);
1442 $columnName = $defaults['column_name'];
1444 //table name of custom data
1445 $tableName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup',
1446 $defaults['custom_group_id'],
1450 //query to fetch id from civicrm_file
1451 if ($multiRecordWhereClause) {
1452 $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID} AND {$multiRecordWhereClause}";
1455 $query = "SELECT {$columnName} FROM {$tableName} where entity_id = {$contactID}";
1457 $fileID = CRM_Core_DAO
::singleValueQuery($query);
1462 $fileType = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File',
1467 $result['file_id'] = $fileID;
1469 if ($fileType == 'image/jpeg' ||
1470 $fileType == 'image/pjpeg' ||
1471 $fileType == 'image/gif' ||
1472 $fileType == 'image/x-png' ||
1473 $fileType == 'image/png'
1475 $entityId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_EntityFile',
1480 list($path) = CRM_Core_BAO_File
::path($fileID, $entityId, NULL, NULL);
1481 $url = CRM_Utils_System
::url('civicrm/file',
1482 "reset=1&id=$fileID&eid=$contactID",
1483 $absolute, NULL, TRUE, TRUE
1485 $result['file_url'] = CRM_Utils_File
::getFileURL($path, $fileType, $url);
1487 // for non image files
1489 $uri = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_File',
1493 $url = CRM_Utils_System
::url('civicrm/file',
1494 "reset=1&id=$fileID&eid=$contactID",
1495 $absolute, NULL, TRUE, TRUE
1497 $result['file_url'] = CRM_Utils_File
::getFileURL($uri, $fileType, $url);
1505 * Format custom fields before inserting.
1507 * @param int $customFieldId
1509 * @param array $customFormatted
1511 * @param mixed $value
1512 * Value of custom field.
1513 * @param string $customFieldExtend
1514 * Custom field extends.
1515 * @param int $customValueId
1516 * Custom option value id.
1517 * @param int $entityId
1518 * Entity id (contribution, membership...).
1519 * @param bool $inline
1520 * Consider inline custom groups only.
1521 * @param bool $checkPermission
1522 * If false, do not include permissioning clause.
1523 * @param bool $includeViewOnly
1524 * If true, fields marked 'View Only' are included. Required for APIv3.
1526 * @return array|NULL
1527 * formatted custom field array
1529 public static function formatCustomField(
1530 $customFieldId, &$customFormatted, $value,
1531 $customFieldExtend, $customValueId = NULL,
1534 $checkPermission = TRUE,
1535 $includeViewOnly = FALSE
1537 //get the custom fields for the entity
1538 //subtype and basic type
1539 $customDataSubType = NULL;
1540 if ($customFieldExtend) {
1541 // This is the case when getFieldsForImport() requires fields
1542 // of subtype and its parent.CRM-5143
1543 // CRM-16065 - Custom field set data not being saved if contact has more than one contact sub type
1544 $customDataSubType = array_intersect(CRM_Contact_BAO_ContactType
::subTypes(), (array) $customFieldExtend);
1545 if (!empty($customDataSubType) && is_array($customDataSubType)) {
1546 $customFieldExtend = CRM_Contact_BAO_ContactType
::getBasicType($customDataSubType);
1547 if (is_array($customFieldExtend)) {
1548 $customFieldExtend = array_unique(array_values($customFieldExtend));
1553 $customFields = CRM_Core_BAO_CustomField
::getFields($customFieldExtend,
1563 if (!array_key_exists($customFieldId, $customFields)) {
1567 // return if field is a 'code' field
1568 if (!$includeViewOnly && !empty($customFields[$customFieldId]['is_view'])) {
1572 list($tableName, $columnName, $groupID) = self
::getTableColumnGroup($customFieldId);
1574 if (!$customValueId &&
1575 // we always create new entites for is_multiple unless specified
1576 !$customFields[$customFieldId]['is_multiple'] &&
1582 WHERE entity_id={$entityId}";
1584 $customValueId = CRM_Core_DAO
::singleValueQuery($query);
1587 //fix checkbox, now check box always submits values
1588 if ($customFields[$customFieldId]['html_type'] == 'CheckBox') {
1590 // Note that only during merge this is not an array, and you can directly use value
1591 if (is_array($value)) {
1592 $selectedValues = array();
1593 foreach ($value as $selId => $val) {
1595 $selectedValues[] = $selId;
1598 if (!empty($selectedValues)) {
1599 $value = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
,
1601 ) . CRM_Core_DAO
::VALUE_SEPARATOR
;
1610 if ($customFields[$customFieldId]['html_type'] == 'Multi-Select') {
1612 $value = CRM_Utils_Array
::implodePadded($value);
1619 if (($customFields[$customFieldId]['html_type'] == 'Multi-Select' ||
1620 $customFields[$customFieldId]['html_type'] == 'CheckBox'
1622 $customFields[$customFieldId]['data_type'] == 'String' &&
1623 !empty($customFields[$customFieldId]['text_length']) &&
1626 // lets make sure that value is less than the length, else we'll
1627 // be losing some data, CRM-7481
1628 if (strlen($value) >= $customFields[$customFieldId]['text_length']) {
1629 // need to do a few things here
1631 // 1. lets find a new length
1632 $newLength = $customFields[$customFieldId]['text_length'];
1633 $minLength = strlen($value);
1634 while ($newLength < $minLength) {
1635 $newLength = $newLength * 2;
1638 // set the custom field meta data to have a length larger than value
1639 // alter the custom value table column to match this length
1640 CRM_Core_BAO_SchemaHandler
::alterFieldLength($customFieldId, $tableName, $columnName, $newLength);
1645 if ($customFields[$customFieldId]['data_type'] == 'Date') {
1646 if (!CRM_Utils_System
::isNull($value)) {
1647 $format = $customFields[$customFieldId]['date_format'];
1648 $date = CRM_Utils_Date
::processDate($value, NULL, FALSE, 'YmdHis', $format);
1653 if ($customFields[$customFieldId]['data_type'] == 'Float' ||
1654 $customFields[$customFieldId]['data_type'] == 'Money'
1660 if ($customFields[$customFieldId]['data_type'] == 'Money') {
1661 $value = CRM_Utils_Rule
::cleanMoney($value);
1665 if (($customFields[$customFieldId]['data_type'] == 'StateProvince' ||
1666 $customFields[$customFieldId]['data_type'] == 'Country'
1676 if ($customFields[$customFieldId]['data_type'] == 'File') {
1677 if (empty($value)) {
1681 $config = CRM_Core_Config
::singleton();
1683 // If we are already passing the file id as a value then retrieve and set the file data
1684 if (CRM_Utils_Rule
::integer($value)) {
1685 $fileDAO = new CRM_Core_DAO_File();
1686 $fileDAO->id
= $value;
1687 $fileDAO->find(TRUE);
1690 $fName = $fileDAO->uri
;
1691 $mimeType = $fileDAO->mime_type
;
1695 $fName = $value['name'];
1696 $mimeType = $value['type'];
1699 $filename = pathinfo($fName, PATHINFO_BASENAME
);
1701 // rename this file to go into the secure directory only if
1702 // user has uploaded new file not existing verfied on the basis of $fileID
1703 if (empty($fileID) && !rename($fName, $config->customFileUploadDir
. $filename)) {
1704 CRM_Core_Error
::statusBounce(ts('Could not move custom file to custom upload directory'));
1707 if ($customValueId && empty($fileID)) {
1712 $params = array(1 => array($customValueId, 'Integer'));
1713 $fileID = CRM_Core_DAO
::singleValueQuery($query, $params);
1716 $fileDAO = new CRM_Core_DAO_File();
1719 $fileDAO->id
= $fileID;
1722 $fileDAO->uri
= $filename;
1723 $fileDAO->mime_type
= $mimeType;
1724 $fileDAO->upload_date
= date('YmdHis');
1726 $fileID = $fileDAO->id
;
1730 if (!is_array($customFormatted)) {
1731 $customFormatted = array();
1734 if (!array_key_exists($customFieldId, $customFormatted)) {
1735 $customFormatted[$customFieldId] = array();
1739 if ($customValueId) {
1740 $index = $customValueId;
1743 if (!array_key_exists($index, $customFormatted[$customFieldId])) {
1744 $customFormatted[$customFieldId][$index] = array();
1746 $customFormatted[$customFieldId][$index] = array(
1747 'id' => $customValueId > 0 ?
$customValueId : NULL,
1749 'type' => $customFields[$customFieldId]['data_type'],
1750 'custom_field_id' => $customFieldId,
1751 'custom_group_id' => $groupID,
1752 'table_name' => $tableName,
1753 'column_name' => $columnName,
1754 'file_id' => $fileID,
1755 'is_multiple' => $customFields[$customFieldId]['is_multiple'],
1758 //we need to sort so that custom fields are created in the order of entry
1759 krsort($customFormatted[$customFieldId]);
1760 return $customFormatted;
1764 * Get default custom table schema.
1766 * @param array $params
1770 public static function defaultCustomTableSchema($params) {
1771 // add the id and extends_id
1773 'name' => $params['name'],
1774 'is_multiple' => $params['is_multiple'],
1775 'attributes' => "ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci",
1779 'type' => 'int unsigned',
1782 'attributes' => 'AUTO_INCREMENT',
1783 'comment' => 'Default MySQL primary key',
1786 'name' => 'entity_id',
1787 'type' => 'int unsigned',
1789 'comment' => 'Table that this extends',
1790 'fk_table_name' => $params['extends_name'],
1791 'fk_field_name' => 'id',
1792 'fk_attributes' => 'ON DELETE CASCADE',
1797 if (!$params['is_multiple']) {
1798 $table['indexes'] = array(
1801 'field_name_1' => 'entity_id',
1809 * Create custom field.
1811 * @param CRM_Core_DAO_CustomField $field
1812 * @param string $operation
1813 * @param bool $indexExist
1814 * @param bool $triggerRebuild
1816 public static function createField($field, $operation, $indexExist = FALSE, $triggerRebuild = TRUE) {
1817 $tableName = CRM_Core_DAO
::getFieldValue(
1818 'CRM_Core_DAO_CustomGroup',
1819 $field->custom_group_id
,
1824 'table_name' => $tableName,
1825 'operation' => $operation,
1826 'name' => $field->column_name
,
1827 'type' => CRM_Core_BAO_CustomValueTable
::fieldToSQLType(
1831 'required' => $field->is_required
,
1832 'searchable' => $field->is_searchable
,
1835 if ($operation == 'delete') {
1836 $fkName = "{$tableName}_{$field->column_name}";
1837 if (strlen($fkName) >= 48) {
1838 $fkName = substr($fkName, 0, 32) . '_' . substr(md5($fkName), 0, 16);
1840 $params['fkName'] = $fkName;
1842 if ($field->data_type
== 'Country' && $field->html_type
== 'Select Country') {
1843 $params['fk_table_name'] = 'civicrm_country';
1844 $params['fk_field_name'] = 'id';
1845 $params['fk_attributes'] = 'ON DELETE SET NULL';
1847 elseif ($field->data_type
== 'Country' && $field->html_type
== 'Multi-Select Country') {
1848 $params['type'] = 'varchar(255)';
1850 elseif ($field->data_type
== 'StateProvince' && $field->html_type
== 'Select State/Province') {
1851 $params['fk_table_name'] = 'civicrm_state_province';
1852 $params['fk_field_name'] = 'id';
1853 $params['fk_attributes'] = 'ON DELETE SET NULL';
1855 elseif ($field->data_type
== 'StateProvince' && $field->html_type
== 'Multi-Select State/Province') {
1856 $params['type'] = 'varchar(255)';
1858 elseif ($field->data_type
== 'File') {
1859 $params['fk_table_name'] = 'civicrm_file';
1860 $params['fk_field_name'] = 'id';
1861 $params['fk_attributes'] = 'ON DELETE SET NULL';
1863 elseif ($field->data_type
== 'ContactReference') {
1864 $params['fk_table_name'] = 'civicrm_contact';
1865 $params['fk_field_name'] = 'id';
1866 $params['fk_attributes'] = 'ON DELETE SET NULL';
1868 if (isset($field->default_value
)) {
1869 $params['default'] = "'{$field->default_value}'";
1872 CRM_Core_BAO_SchemaHandler
::alterFieldSQL($params, $indexExist, $triggerRebuild);
1876 * Determine whether it would be safe to move a field.
1878 * @param int $fieldID
1879 * FK to civicrm_custom_field.
1880 * @param int $newGroupID
1881 * FK to civicrm_custom_group.
1884 * array(string) or TRUE
1886 public static function _moveFieldValidate($fieldID, $newGroupID) {
1889 $field = new CRM_Core_DAO_CustomField();
1890 $field->id
= $fieldID;
1891 if (!$field->find(TRUE)) {
1892 $errors['fieldID'] = 'Invalid ID for custom field';
1896 $oldGroup = new CRM_Core_DAO_CustomGroup();
1897 $oldGroup->id
= $field->custom_group_id
;
1898 if (!$oldGroup->find(TRUE)) {
1899 $errors['fieldID'] = 'Invalid ID for old custom group';
1903 $newGroup = new CRM_Core_DAO_CustomGroup();
1904 $newGroup->id
= $newGroupID;
1905 if (!$newGroup->find(TRUE)) {
1906 $errors['newGroupID'] = 'Invalid ID for new custom group';
1912 FROM civicrm_custom_field a
1913 INNER JOIN civicrm_custom_field b
1915 AND a.label = b.label
1916 AND b.custom_group_id = %2
1919 1 => array($field->id
, 'Integer'),
1920 2 => array($newGroup->id
, 'Integer'),
1922 $count = CRM_Core_DAO
::singleValueQuery($query, $params);
1924 $errors['newGroupID'] = ts('A field of the same label exists in the destination group');
1927 $tableName = $oldGroup->table_name
;
1928 $columnName = $field->column_name
;
1933 WHERE $columnName is not null
1935 $count = CRM_Core_DAO
::singleValueQuery($query,
1936 CRM_Core_DAO
::$_nullArray
1941 FROM civicrm_custom_group
1942 WHERE id IN ( %1, %2 )
1945 1 => array($oldGroup->id
, 'Integer'),
1946 2 => array($newGroup->id
, 'Integer'),
1949 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1951 while ($dao->fetch()) {
1952 $extends[] = $dao->extends;
1954 if ($extends[0] != $extends[1]) {
1955 $errors['newGroupID'] = ts('The destination group extends a different entity type.');
1959 return empty($errors) ?
TRUE : $errors;
1963 * Move a custom data field from one group (table) to another.
1965 * @param int $fieldID
1966 * FK to civicrm_custom_field.
1967 * @param int $newGroupID
1968 * FK to civicrm_custom_group.
1970 public static function moveField($fieldID, $newGroupID) {
1971 $validation = self
::_moveFieldValidate($fieldID, $newGroupID);
1972 if (TRUE !== $validation) {
1973 CRM_Core_Error
::fatal(implode(' ', $validation));
1975 $field = new CRM_Core_DAO_CustomField();
1976 $field->id
= $fieldID;
1979 $newGroup = new CRM_Core_DAO_CustomGroup();
1980 $newGroup->id
= $newGroupID;
1981 $newGroup->find(TRUE);
1983 $oldGroup = new CRM_Core_DAO_CustomGroup();
1984 $oldGroup->id
= $field->custom_group_id
;
1985 $oldGroup->find(TRUE);
1988 $add->custom_group_id
= $newGroup->id
;
1989 self
::createField($add, 'add');
1991 $sql = "INSERT INTO {$newGroup->table_name} (entity_id, {$field->column_name})
1992 SELECT entity_id, {$field->column_name} FROM {$oldGroup->table_name}
1993 ON DUPLICATE KEY UPDATE {$field->column_name} = {$oldGroup->table_name}.{$field->column_name}
1995 CRM_Core_DAO
::executeQuery($sql);
1998 $del->custom_group_id
= $oldGroup->id
;
1999 self
::createField($del, 'delete');
2003 CRM_Utils_System
::flushCache();
2007 * Get the database table name and column name for a custom field.
2009 * @param int $fieldID
2010 * The fieldID of the custom field.
2011 * @param bool $force
2012 * Force the sql to be run again (primarily used for tests).
2015 * fatal is fieldID does not exists, else array of tableName, columnName
2017 public static function getTableColumnGroup($fieldID, $force = FALSE) {
2018 $cacheKey = "CRM_Core_DAO_CustomField_CustomGroup_TableColumn_{$fieldID}";
2019 $cache = CRM_Utils_Cache
::singleton();
2020 $fieldValues = $cache->get($cacheKey);
2021 if (empty($fieldValues) ||
$force) {
2023 SELECT cg.table_name, cf.column_name, cg.id
2024 FROM civicrm_custom_group cg,
2025 civicrm_custom_field cf
2026 WHERE cf.custom_group_id = cg.id
2028 $params = array(1 => array($fieldID, 'Integer'));
2029 $dao = CRM_Core_DAO
::executeQuery($query, $params);
2031 if (!$dao->fetch()) {
2032 CRM_Core_Error
::fatal();
2035 $fieldValues = array($dao->table_name
, $dao->column_name
, $dao->id
);
2036 $cache->set($cacheKey, $fieldValues);
2038 return $fieldValues;
2042 * Get custom option groups.
2044 * @deprecated Use the API OptionGroup.get
2046 * @param array $includeFieldIds
2047 * Ids of custom fields for which option groups must be included.
2049 * Currently this is required in the cases where option groups are to be included
2050 * for inactive fields : CRM-5369
2054 public static function customOptionGroup($includeFieldIds = NULL) {
2055 static $customOptionGroup = NULL;
2057 $cacheKey = (empty($includeFieldIds)) ?
'onlyActive' : 'force';
2058 if ($cacheKey == 'force') {
2059 $customOptionGroup[$cacheKey] = NULL;
2062 if (empty($customOptionGroup[$cacheKey])) {
2063 $whereClause = '( g.is_active = 1 AND f.is_active = 1 )';
2065 //support for single as well as array format.
2066 if (!empty($includeFieldIds)) {
2067 if (is_array($includeFieldIds)) {
2068 $includeFieldIds = implode(',', $includeFieldIds);
2070 $whereClause .= "OR f.id IN ( $includeFieldIds )";
2074 SELECT g.id, g.title
2075 FROM civicrm_option_group g
2076 INNER JOIN civicrm_custom_field f ON ( g.id = f.option_group_id )
2077 WHERE {$whereClause}";
2079 $dao = CRM_Core_DAO
::executeQuery($query);
2080 while ($dao->fetch()) {
2081 $customOptionGroup[$cacheKey][$dao->id
] = $dao->title
;
2085 return $customOptionGroup[$cacheKey];
2089 * Fix orphan groups.
2091 * @param int $customFieldId
2093 * @param int $optionGroupId
2096 public static function fixOptionGroups($customFieldId, $optionGroupId) {
2097 // check if option group belongs to any custom Field else delete
2098 // get the current option group
2099 $currentOptionGroupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomField',
2103 // get the updated option group
2104 // if both are same return
2105 if ($currentOptionGroupId == $optionGroupId) {
2109 // check if option group is related to any other field
2110 self
::checkOptionGroup($currentOptionGroupId);
2114 * Check if option group is related to more than one custom field.
2116 * @param int $optionGroupId
2119 public static function checkOptionGroup($optionGroupId) {
2122 FROM civicrm_custom_field
2123 WHERE option_group_id = {$optionGroupId}";
2125 $count = CRM_Core_DAO
::singleValueQuery($query);
2128 //delete the option group
2129 CRM_Core_BAO_OptionGroup
::del($optionGroupId);
2134 * Get option group default.
2136 * @param int $optionGroupId
2137 * @param string $htmlType
2139 * @return null|string
2141 public static function getOptionGroupDefault($optionGroupId, $htmlType) {
2143 SELECT default_value, html_type
2144 FROM civicrm_custom_field
2145 WHERE option_group_id = {$optionGroupId}
2146 AND default_value IS NOT NULL
2147 ORDER BY html_type";
2149 $dao = CRM_Core_DAO
::executeQuery($query);
2150 $defaultValue = NULL;
2151 $defaultHTMLType = NULL;
2152 while ($dao->fetch()) {
2153 if ($dao->html_type
== $htmlType) {
2154 return $dao->default_value
;
2156 if ($defaultValue == NULL) {
2157 $defaultValue = $dao->default_value
;
2158 $defaultHTMLType = $dao->html_type
;
2162 // some conversions are needed if either the old or new has a html type which has potential
2163 // multiple default values.
2164 if (($htmlType == 'CheckBox' ||
$htmlType == 'Multi-Select') &&
2165 ($defaultHTMLType != 'CheckBox' && $defaultHTMLType != 'Multi-Select')
2167 $defaultValue = CRM_Core_DAO
::VALUE_SEPARATOR
. $defaultValue . CRM_Core_DAO
::VALUE_SEPARATOR
;
2169 elseif (($defaultHTMLType == 'CheckBox' ||
$defaultHTMLType == 'Multi-Select') &&
2170 ($htmlType != 'CheckBox' && $htmlType != 'Multi-Select')
2172 $defaultValue = substr($defaultValue, 1, -1);
2173 $values = explode(CRM_Core_DAO
::VALUE_SEPARATOR
,
2174 substr($defaultValue, 1, -1)
2176 $defaultValue = $values[0];
2179 return $defaultValue;
2183 * Post process function.
2185 * @param array $params
2186 * @param int $entityID
2187 * @param string $customFieldExtends
2188 * @param bool $inline
2189 * @param bool $checkPermissions
2193 public static function postProcess(
2196 $customFieldExtends,
2198 $checkPermissions = TRUE
2200 $customData = array();
2202 foreach ($params as $key => $value) {
2203 if ($customFieldInfo = CRM_Core_BAO_CustomField
::getKeyID($key, TRUE)) {
2205 // for autocomplete transfer hidden value instead of label
2206 if ($params[$key] && isset($params[$key . '_id'])) {
2207 $value = $params[$key . '_id'];
2210 // we need to append time with date
2211 if ($params[$key] && isset($params[$key . '_time'])) {
2212 $value .= ' ' . $params[$key . '_time'];
2215 CRM_Core_BAO_CustomField
::formatCustomField($customFieldInfo[0],
2218 $customFieldExtends,
2219 $customFieldInfo[1],
2230 * Get custom field ID from field/group name/title.
2232 * @param string $fieldName Field name or label
2233 * @param string|null $groupTitle (Optional) Group name or label
2234 * @param bool $fullString Whether to return "custom_123" or "123"
2236 * @return string|int|null
2237 * @throws \CiviCRM_API3_Exception
2239 public static function getCustomFieldID($fieldName, $groupTitle = NULL, $fullString = FALSE) {
2240 if (!isset(Civi
::$statics['CRM_Core_BAO_CustomField'][$fieldName])) {
2241 $customFieldParams = [
2242 'name' => $fieldName,
2243 'label' => $fieldName,
2244 'options' => ['or' => [["name", "label"]]],
2248 $customFieldParams['custom_group_id.name'] = $groupTitle;
2249 $customFieldParams['custom_group_id.title'] = $groupTitle;
2250 $customFieldParams['options'] = ['or' => [["name", "label"], ["custom_group_id.name", "custom_group_id.title"]]];
2253 $field = civicrm_api3('CustomField', 'get', $customFieldParams);
2255 if (empty($field['id'])) {
2256 Civi
::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'] = NULL;
2257 Civi
::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'] = NULL;
2260 Civi
::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'] = $field['id'];
2261 Civi
::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'] = 'custom_' . $field['id'];
2266 return Civi
::$statics['CRM_Core_BAO_CustomField'][$fieldName]['string'];
2268 return Civi
::$statics['CRM_Core_BAO_CustomField'][$fieldName]['id'];
2272 * Given ID of a custom field, return its name as well as the name of the custom group it belongs to.
2278 public static function getNameFromID($ids) {
2279 if (is_array($ids)) {
2280 $ids = implode(',', $ids);
2283 SELECT f.id, f.name AS field_name, f.label AS field_label, g.name AS group_name, g.title AS group_title
2284 FROM civicrm_custom_field f
2285 INNER JOIN civicrm_custom_group g ON f.custom_group_id = g.id
2286 WHERE f.id IN ($ids)";
2288 $dao = CRM_Core_DAO
::executeQuery($sql);
2290 while ($dao->fetch()) {
2291 $result[$dao->id
] = array(
2292 'field_name' => $dao->field_name
,
2293 'field_label' => $dao->field_label
,
2294 'group_name' => $dao->group_name
,
2295 'group_title' => $dao->group_title
,
2302 * Validate custom data.
2304 * @param array $params
2305 * Custom data submitted.
2306 * ie array( 'custom_1' => 'validate me' );
2309 * validation errors.
2311 public static function validateCustomData($params) {
2313 if (!is_array($params) ||
empty($params)) {
2317 //pick up profile fields.
2318 $profileFields = array();
2319 $ufGroupId = CRM_Utils_Array
::value('ufGroupId', $params);
2321 $profileFields = CRM_Core_BAO_UFGroup
::getFields($ufGroupId,
2323 CRM_Core_Action
::VIEW
2327 //lets start w/ params.
2328 foreach ($params as $key => $value) {
2329 $customFieldID = self
::getKeyID($key);
2330 if (!$customFieldID) {
2334 //load the structural info for given field.
2335 $field = new CRM_Core_DAO_CustomField();
2336 $field->id
= $customFieldID;
2337 if (!$field->find(TRUE)) {
2340 $dataType = $field->data_type
;
2342 $profileField = CRM_Utils_Array
::value($key, $profileFields, array());
2343 $fieldTitle = CRM_Utils_Array
::value('title', $profileField);
2344 $isRequired = CRM_Utils_Array
::value('is_required', $profileField);
2346 $fieldTitle = $field->label
;
2349 //no need to validate.
2350 if (CRM_Utils_System
::isNull($value) && !$isRequired) {
2354 //lets validate first for required field.
2355 if ($isRequired && CRM_Utils_System
::isNull($value)) {
2356 $errors[$key] = ts('%1 is a required field.', array(1 => $fieldTitle));
2360 //now time to take care of custom field form rules.
2361 $ruleName = $errorMsg = NULL;
2362 switch ($dataType) {
2364 $ruleName = 'integer';
2365 $errorMsg = ts('%1 must be an integer (whole number).',
2366 array(1 => $fieldTitle)
2371 $ruleName = 'money';
2372 $errorMsg = ts('%1 must in proper money format. (decimal point/comma/space is allowed).',
2373 array(1 => $fieldTitle)
2378 $ruleName = 'numeric';
2379 $errorMsg = ts('%1 must be a number (with or without decimal point).',
2380 array(1 => $fieldTitle)
2385 $ruleName = 'wikiURL';
2386 $errorMsg = ts('%1 must be valid Website.',
2387 array(1 => $fieldTitle)
2392 if ($ruleName && !CRM_Utils_System
::isNull($value)) {
2394 $funName = "CRM_Utils_Rule::{$ruleName}";
2395 if (is_callable($funName)) {
2396 $valid = call_user_func($funName, $value);
2399 $errors[$key] = $errorMsg;
2408 * Is this field a multi record field.
2410 * @param int $customId
2414 public static function isMultiRecordField($customId) {
2415 $isMultipleWithGid = FALSE;
2416 if (!is_numeric($customId)) {
2417 $customId = self
::getKeyID($customId);
2419 if (is_numeric($customId)) {
2420 $sql = "SELECT cg.id cgId
2421 FROM civicrm_custom_group cg
2422 INNER JOIN civicrm_custom_field cf
2423 ON cg.id = cf.custom_group_id
2424 WHERE cf.id = %1 AND cg.is_multiple = 1";
2425 $params[1] = array($customId, 'Integer');
2426 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2427 if ($dao->fetch()) {
2429 $isMultipleWithGid = $dao->cgId
;
2434 return $isMultipleWithGid;
2438 * Does this field type have any select options?
2440 * @param array $field
2444 public static function hasOptions($field) {
2445 // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2446 $field = (array) $field;
2447 // This will include boolean fields with Yes/No options.
2448 if (in_array($field['html_type'], ['Radio', 'CheckBox'])) {
2451 // Do this before the "Select" string search because date fields have a "Select Date" html_type
2452 // and contactRef fields have an "Autocomplete-Select" html_type - contacts are an FK not an option list.
2453 if (in_array($field['data_type'], ['ContactReference', 'Date'])) {
2456 if (strpos($field['html_type'], 'Select') !== FALSE) {
2459 return !empty($field['option_group_id']);
2463 * Does this field store a serialized string?
2465 * @param array $field
2469 public static function isSerialized($field) {
2470 // Fields retrieved via api are an array, or from the dao are an object. We'll accept either.
2471 $field = (array) $field;
2472 // FIXME: Currently the only way to know if data is serialized is by looking at the html_type. It would be cleaner to decouple this.
2473 return ($field['html_type'] == 'CheckBox' ||
strpos($field['html_type'], 'Multi') !== FALSE);
2477 * Get api entity for this field
2481 public function getEntity() {
2482 $entity = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_CustomGroup', $this->custom_group_id
, 'extends');
2483 return in_array($entity, array('Individual', 'Household', 'Organization')) ?
'Contact' : $entity;
2487 * Set pseudoconstant properties for field metadata.
2489 * @param array $field
2490 * @param string|null $optionGroupName
2492 private static function getOptionsForField(&$field, $optionGroupName) {
2493 if ($optionGroupName) {
2494 $field['pseudoconstant'] = array(
2495 'optionGroupName' => $optionGroupName,
2496 'optionEditPath' => 'civicrm/admin/options/' . $optionGroupName,
2499 elseif ($field['data_type'] == 'Boolean') {
2500 $field['pseudoconstant'] = array(
2501 'callback' => 'CRM_Core_SelectValues::boolean',
2504 elseif ($field['data_type'] == 'Country') {
2505 $field['pseudoconstant'] = array(
2506 'table' => 'civicrm_country',
2507 'keyColumn' => 'id',
2508 'labelColumn' => 'name',
2509 'nameColumn' => 'iso_code',
2512 elseif ($field['data_type'] == 'StateProvince') {
2513 $field['pseudoconstant'] = array(
2514 'table' => 'civicrm_state_province',
2515 'keyColumn' => 'id',
2516 'labelColumn' => 'name',