3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Core_BAO_OptionValue
extends CRM_Core_DAO_OptionValue
{
22 public function __construct() {
23 parent
::__construct();
27 * Create option value.
29 * Note that the create function calls 'add' but has more business logic.
31 * @param array $params
34 * @return CRM_Core_DAO_OptionValue
35 * @throws \CRM_Core_Exception
37 public static function create($params) {
38 if (empty($params['id'])) {
39 self
::setDefaults($params);
41 return CRM_Core_BAO_OptionValue
::add($params);
45 * Set default Parameters.
46 * This functions sets default parameters if not set:
47 * - name & label are set to each other as required (it might make more sense for one
48 * to be required but this would mean a change to the api level)
49 * - weight & value will be set to their respective option groups next values
50 * if nothing is passed in.
52 * Note this function does not check for presence of $params['id'] so should only be called
53 * if 'id' is not present
55 * @param array $params
57 public static function setDefaults(&$params) {
58 $params['label'] = $params['label'] ??
$params['name'];
59 $params['name'] = $params['name'] ?? CRM_Utils_String
::titleToVar($params['label']);
60 $params['weight'] = $params['weight'] ?? self
::getDefaultWeight($params);
61 $params['value'] = $params['value'] ?? self
::getDefaultValue($params);
65 * Get next available value.
66 * We will take the highest numeric value (or 0 if no numeric values exist)
67 * and add one. The calling function is responsible for any
68 * more complex decision making
70 * @param array $params
74 public static function getDefaultWeight($params) {
75 return (int) CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
76 ['option_group_id' => $params['option_group_id']]);
80 * Get next available value.
81 * We will take the highest numeric value (or 0 if no numeric values exist)
82 * and add one. The calling function is responsible for any
83 * more complex decision making
84 * @param array $params
86 public static function getDefaultValue($params) {
87 $bao = new CRM_Core_BAO_OptionValue();
88 $bao->option_group_id
= $params['option_group_id'];
89 if (isset($params['domain_id'])) {
90 $bao->domain_id
= $params['domain_id'];
93 $bao->whereAdd("value REGEXP '^[0-9]+$'");
94 $bao->selectAdd('(ROUND(COALESCE(MAX(CONVERT(value, UNSIGNED)),0)) +1) as nextvalue');
96 return $bao->nextvalue
;
100 * Fetch object based on array of properties.
102 * @param array $params
103 * (reference ) an assoc array of name/value pairs.
104 * @param array $defaults
105 * (reference ) an assoc array to hold the flattened values.
107 * @return CRM_Core_BAO_OptionValue
109 public static function retrieve(&$params, &$defaults) {
110 $optionValue = new CRM_Core_DAO_OptionValue();
111 $optionValue->copyValues($params);
112 if ($optionValue->find(TRUE)) {
113 CRM_Core_DAO
::storeValues($optionValue, $defaults);
120 * Update the is_active flag in the db.
123 * Id of the database record.
124 * @param bool $is_active
125 * Value we want to set the is_active field.
128 * true if we found and updated the object, else false
130 public static function setIsActive($id, $is_active) {
131 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_OptionValue', $id, 'is_active', $is_active);
135 * Add an Option Value.
137 * @param array $params
138 * Reference array contains the values submitted by the form.
140 * deprecated Reference array contains the id.
142 * @return \CRM_Core_DAO_OptionValue
144 * @throws \CRM_Core_Exception
145 * @throws \CiviCRM_API3_Exception
147 public static function add(&$params, $ids = []) {
148 if (!empty($ids['optionValue']) && empty($params['id'])) {
149 CRM_Core_Error
::deprecatedFunctionWarning('$params[\'id\'] should be set, $ids is deprecated');
151 $id = $params['id'] ??
$ids['optionValue'] ??
NULL;
153 // Update custom field data to reflect the new value
154 if ($id && isset($params['value'])) {
155 CRM_Core_BAO_CustomOption
::updateValue($id, $params['value']);
158 // We need to have option_group_id populated for validation so load if necessary.
159 if (empty($params['option_group_id'])) {
160 $params['option_group_id'] = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
161 $id, 'option_group_id', 'id'
164 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
165 $params['option_group_id'], 'name', 'id'
168 // action is taken depending upon the mode
169 $optionValue = new CRM_Core_DAO_OptionValue();
170 $optionValue->copyValues($params);
172 $isDomainOptionGroup = in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups);
173 if (empty($params['domain_id']) && $isDomainOptionGroup) {
174 $optionValue->domain_id
= CRM_Core_Config
::domainID();
177 // When setting a default option, unset other options in this group as default
178 if (!empty($params['is_default'])) {
179 $query = 'UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = %1';
181 // tweak default reset, and allow multiple default within group.
182 if ($resetDefaultFor = CRM_Utils_Array
::value('reset_default_for', $params)) {
183 if (is_array($resetDefaultFor)) {
184 $colName = key($resetDefaultFor);
185 $colVal = $resetDefaultFor[$colName];
186 $query .= " AND ( $colName IN ( $colVal ) )";
190 $p = [1 => [$params['option_group_id'], 'Integer']];
192 // Limit update by domain of option
193 $domain = $optionValue->domain_id ??
NULL;
194 if (!$domain && $id && $isDomainOptionGroup) {
195 $domain = CRM_Core_DAO
::getFieldValue(__CLASS__
, $id, 'domain_id');
198 $query .= ' AND domain_id = %2';
199 $p[2] = [$domain, 'Integer'];
202 CRM_Core_DAO
::executeQuery($query, $p);
205 $groupsSupportingDuplicateValues = ['languages'];
206 if (!$id && !empty($params['value'])) {
207 $dao = new CRM_Core_DAO_OptionValue();
208 if (!in_array($groupName, $groupsSupportingDuplicateValues)) {
209 $dao->value
= $params['value'];
212 // CRM-21737 languages option group does not use unique values but unique names.
213 $dao->name
= $params['name'];
215 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
216 $dao->domain_id
= $optionValue->domain_id
;
218 $dao->option_group_id
= $params['option_group_id'];
219 if ($dao->find(TRUE)) {
220 throw new CRM_Core_Exception('Value already exists in the database');
224 $optionValue->id
= $id;
225 $optionValue->save();
226 CRM_Core_PseudoConstant
::flush();
228 // Create relationship for payment instrument options
229 if (!empty($params['financial_account_id'])) {
230 $optionName = civicrm_api3('OptionGroup', 'getvalue', [
232 'id' => $params['option_group_id'],
234 // Only create relationship for payment instrument options
235 if ($optionName == 'payment_instrument') {
236 $relationTypeId = civicrm_api3('OptionValue', 'getvalue', [
238 'option_group_id' => 'account_relationship',
239 'name' => 'Asset Account is',
242 'entity_table' => 'civicrm_option_value',
243 'entity_id' => $optionValue->id
,
244 'account_relationship' => $relationTypeId,
245 'financial_account_id' => $params['financial_account_id'],
247 CRM_Financial_BAO_FinancialTypeAccount
::add($params);
254 * Delete Option Value.
256 * @param int $optionValueId
261 public static function del($optionValueId) {
262 $optionValue = new CRM_Core_DAO_OptionValue();
263 $optionValue->id
= $optionValueId;
264 if (!$optionValue->find()) {
267 if (self
::updateRecords($optionValueId, CRM_Core_Action
::DELETE
)) {
268 CRM_Core_PseudoConstant
::flush();
269 $optionValue->delete();
276 * Retrieve activity type label and description.
278 * @param int $activityTypeId
282 * label and description
284 public static function getActivityTypeDetails($activityTypeId) {
285 $query = "SELECT civicrm_option_value.label, civicrm_option_value.description
286 FROM civicrm_option_value
287 LEFT JOIN civicrm_option_group ON ( civicrm_option_value.option_group_id = civicrm_option_group.id )
288 WHERE civicrm_option_group.name = 'activity_type'
289 AND civicrm_option_value.value = {$activityTypeId} ";
291 $dao = CRM_Core_DAO
::executeQuery($query);
295 return [$dao->label
, $dao->description
];
299 * Get the Option Value title.
302 * Id of Option Value.
308 public static function getTitle($id) {
309 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $id, 'label');
313 * Updates contacts affected by the option value passed.
315 * @param int $optionValueId
316 * The option value id.
318 * The action describing whether prefix/suffix was UPDATED or DELETED.
322 public static function updateRecords(&$optionValueId, $action) {
324 $optionValue = new CRM_Core_DAO_OptionValue();
325 $optionValue->id
= $optionValueId;
326 $optionValue->find(TRUE);
328 $optionGroup = new CRM_Core_DAO_OptionGroup();
329 $optionGroup->id
= $optionValue->option_group_id
;
330 $optionGroup->find(TRUE);
333 $gName = $optionGroup->name
;
335 $value = $optionValue->value
;
337 // get the proper group name & affected field name
338 // todo: this may no longer be needed for individuals - check inputs
340 'gender' => 'gender_id',
341 'individual_prefix' => 'prefix_id',
342 'individual_suffix' => 'suffix_id',
343 'communication_style' => 'communication_style_id',
344 // Not only Individuals -- but the code seems to be generic for all contact types, despite the naming...
346 $contributions = ['payment_instrument' => 'payment_instrument_id'];
347 $activities = ['activity_type' => 'activity_type_id'];
348 $participant = ['participant_role' => 'role_id'];
349 $eventType = ['event_type' => 'event_type_id'];
350 $aclRole = ['acl_role' => 'acl_role_id'];
352 $all = array_merge($individuals, $contributions, $activities, $participant, $eventType, $aclRole);
355 foreach ($all as $name => $id) {
356 if ($gName == $name) {
360 if ($fieldName == '') {
364 if (array_key_exists($gName, $individuals)) {
365 $contactDAO = new CRM_Contact_DAO_Contact();
367 $contactDAO->$fieldName = $value;
370 while ($contactDAO->fetch()) {
371 if ($action == CRM_Core_Action
::DELETE
) {
372 $contact = new CRM_Contact_DAO_Contact();
373 $contact->id
= $contactDAO->id
;
374 $contact->find(TRUE);
376 // make sure dates doesn't get reset
377 $contact->birth_date
= CRM_Utils_Date
::isoToMysql($contact->birth_date
);
378 $contact->deceased_date
= CRM_Utils_Date
::isoToMysql($contact->deceased_date
);
379 $contact->$fieldName = 'NULL';
387 if (array_key_exists($gName, $contributions)) {
388 $contribution = new CRM_Contribute_DAO_Contribution();
389 $contribution->$fieldName = $value;
390 $contribution->find();
391 while ($contribution->fetch()) {
392 if ($action == CRM_Core_Action
::DELETE
) {
393 $contribution->$fieldName = 'NULL';
394 $contribution->save();
400 if (array_key_exists($gName, $activities)) {
401 $activity = new CRM_Activity_DAO_Activity();
402 $activity->$fieldName = $value;
404 while ($activity->fetch()) {
410 //delete participant role, type and event type option value
411 if (array_key_exists($gName, $participant)) {
412 $participantValue = new CRM_Event_DAO_Participant();
413 $participantValue->$fieldName = $value;
414 if ($participantValue->find(TRUE)) {
420 //delete event type option value
421 if (array_key_exists($gName, $eventType)) {
422 $event = new CRM_Event_DAO_Event();
423 $event->$fieldName = $value;
424 if ($event->find(TRUE)) {
430 //delete acl_role option value
431 if (array_key_exists($gName, $aclRole)) {
432 $entityRole = new CRM_ACL_DAO_EntityRole();
433 $entityRole->$fieldName = $value;
435 $aclDAO = new CRM_ACL_DAO_ACL();
436 $aclDAO->entity_id
= $value;
437 if ($entityRole->find(TRUE) ||
$aclDAO->find(TRUE)) {
445 * Updates options values weights.
447 * @param int $opGroupId
448 * @param array $opWeights
449 * Options value , weight pair.
451 public static function updateOptionWeights($opGroupId, $opWeights) {
452 if (!is_array($opWeights) ||
empty($opWeights)) {
456 foreach ($opWeights as $opValue => $opWeight) {
457 $optionValue = new CRM_Core_DAO_OptionValue();
458 $optionValue->option_group_id
= $opGroupId;
459 $optionValue->value
= $opValue;
460 if ($optionValue->find(TRUE)) {
461 $optionValue->weight
= $opWeight;
462 $optionValue->save();
468 * Get the values of all option values given an option group ID. Store in system cache
469 * Does not take any filtering arguments. The object is to avoid hitting the DB and retrieve
472 * @param int $optionGroupID
473 * The option group for which we want the values from.
476 * an array of array of values for this option group
478 public static function getOptionValuesArray($optionGroupID) {
479 // check if we can get the field values from the system cache
480 $cacheKey = "CRM_Core_BAO_OptionValue_OptionGroupID_{$optionGroupID}";
481 $cache = CRM_Utils_Cache
::singleton();
482 $optionValues = $cache->get($cacheKey);
483 if (empty($optionValues)) {
484 $dao = new CRM_Core_DAO_OptionValue();
485 $dao->option_group_id
= $optionGroupID;
486 $dao->orderBy('weight ASC, label ASC');
490 while ($dao->fetch()) {
491 $optionValues[$dao->id
] = [];
492 CRM_Core_DAO
::storeValues($dao, $optionValues[$dao->id
]);
495 $cache->set($cacheKey, $optionValues);
498 return $optionValues;
502 * Get the values of all option values given an option group ID as a key => value pair
503 * Use above cached function to make it super efficient
505 * @param int $optionGroupID
506 * The option group for which we want the values from.
509 * an associative array of label, value pairs
511 public static function getOptionValuesAssocArray($optionGroupID) {
512 $optionValues = self
::getOptionValuesArray($optionGroupID);
515 foreach ($optionValues as $id => $value) {
516 $options[$value['value']] = $value['label'];
522 * Get the values of all option values given an option group Name as a key => value pair
523 * Use above cached function to make it super efficient
525 * @param string $optionGroupName
526 * The option group name for which we want the values from.
529 * an associative array of label, value pairs
531 public static function getOptionValuesAssocArrayFromName($optionGroupName) {
532 $dao = new CRM_Core_DAO_OptionGroup();
533 $dao->name
= $optionGroupName;
535 $dao->selectAdd('id');
537 $optionValues = self
::getOptionValuesArray($dao->id
);
540 foreach ($optionValues as $id => $value) {
541 $options[$value['value']] = $value['label'];
547 * Ensure an option value exists.
549 * This function is intended to be called from the upgrade script to ensure
550 * that an option value exists, without hitting an error if it already exists.
552 * This is sympathetic to sites who might pre-add it.
554 * @param array $params the option value attributes.
555 * @return array the option value attributes.
557 public static function ensureOptionValueExists($params) {
558 $result = civicrm_api3('OptionValue', 'get', [
559 'option_group_id' => $params['option_group_id'],
560 'name' => $params['name'],
561 'return' => ['id', 'value'],
565 if (!$result['count']) {
566 $result = civicrm_api3('OptionValue', 'create', $params);
569 return CRM_Utils_Array
::first($result['values']);