3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
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-2016
33 class CRM_Core_BAO_OptionValue
extends CRM_Core_DAO_OptionValue
{
38 public function __construct() {
39 parent
::__construct();
43 * Create option value.
45 * Note that the create function calls 'add' but has more business logic.
47 * @param array $params
52 public static function create($params) {
53 if (empty($params['id'])) {
54 self
::setDefaults($params);
57 if (!empty($params['id'])) {
58 $ids = array('optionValue' => $params['id']);
60 return CRM_Core_BAO_OptionValue
::add($params, $ids);
64 * Set default Parameters.
65 * This functions sets default parameters if not set:
66 * - name & label are set to each other as required (it might make more sense for one
67 * to be required but this would mean a change to the api level)
68 * - weight & value will be set to their respective option groups next values
69 * if nothing is passed in.
71 * Note this function does not check for presence of $params['id'] so should only be called
72 * if 'id' is not present
74 * @param array $params
76 public static function setDefaults(&$params) {
77 if (CRM_Utils_Array
::value('label', $params, NULL) === NULL) {
78 $params['label'] = $params['name'];
80 if (CRM_Utils_Array
::value('name', $params, NULL) === NULL) {
81 $params['name'] = $params['label'];
83 if (CRM_Utils_Array
::value('weight', $params, NULL) === NULL) {
84 $params['weight'] = self
::getDefaultWeight($params);
86 if (CRM_Utils_Array
::value('value', $params, NULL) === NULL) {
87 $params['value'] = self
::getDefaultValue($params);
92 * Get next available value.
93 * We will take the highest numeric value (or 0 if no numeric values exist)
94 * and add one. The calling function is responsible for any
95 * more complex decision making
97 * @param array $params
101 public static function getDefaultWeight($params) {
102 return (int) CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
103 array('option_group_id' => $params['option_group_id']));
107 * Get next available value.
108 * We will take the highest numeric value (or 0 if no numeric values exist)
109 * and add one. The calling function is responsible for any
110 * more complex decision making
111 * @param array $params
113 public static function getDefaultValue($params) {
114 $bao = new CRM_Core_BAO_OptionValue();
115 $bao->option_group_id
= $params['option_group_id'];
116 if (isset($params['domain_id'])) {
117 $bao->domain_id
= $params['domain_id'];
120 $bao->whereAdd("value REGEXP '^[0-9]+$'");
121 $bao->selectAdd('(ROUND(COALESCE(MAX(CONVERT(value, UNSIGNED)),0)) +1) as nextvalue');
123 return $bao->nextvalue
;
127 * Fetch object based on array of properties.
129 * @param array $params
130 * (reference ) an assoc array of name/value pairs.
131 * @param array $defaults
132 * (reference ) an assoc array to hold the flattened values.
134 * @return CRM_Core_BAO_OptionValue
136 public static function retrieve(&$params, &$defaults) {
137 $optionValue = new CRM_Core_DAO_OptionValue();
138 $optionValue->copyValues($params);
139 if ($optionValue->find(TRUE)) {
140 CRM_Core_DAO
::storeValues($optionValue, $defaults);
147 * Update the is_active flag in the db.
150 * Id of the database record.
151 * @param bool $is_active
152 * Value we want to set the is_active field.
155 * DAO object on success, null otherwise
157 public static function setIsActive($id, $is_active) {
158 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_OptionValue', $id, 'is_active', $is_active);
162 * Add an Option Value.
164 * @param array $params
165 * Reference array contains the values submitted by the form.
167 * Reference array contains the id.
170 * @return CRM_Core_DAO_OptionValue
172 public static function add(&$params, $ids = array()) {
173 // CRM-10921: do not reset attributes to default if this is an update
174 //@todo consider if defaults are being set in the right place. 'dumb' defaults like
175 // these would be usefully set @ the api layer so they are visible to api users
176 // complex defaults like the domain id below would make sense in the setDefauls function
177 // but unclear what other ways this function is being used
178 if (empty($ids['optionValue'])) {
179 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
180 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
181 $params['is_optgroup'] = CRM_Utils_Array
::value('is_optgroup', $params, FALSE);
182 $params['filter'] = CRM_Utils_Array
::value('filter', $params, FALSE);
184 // Update custom field data to reflect the new value
185 elseif (isset($params['value'])) {
186 CRM_Core_BAO_CustomOption
::updateValue($ids['optionValue'], $params['value']);
189 // action is taken depending upon the mode
190 $optionValue = new CRM_Core_DAO_OptionValue();
191 $optionValue->copyValues($params);
193 if (!empty($params['is_default'])) {
194 $query = 'UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = %1';
196 // tweak default reset, and allow multiple default within group.
197 if ($resetDefaultFor = CRM_Utils_Array
::value('reset_default_for', $params)) {
198 if (is_array($resetDefaultFor)) {
199 $colName = key($resetDefaultFor);
200 $colVal = $resetDefaultFor[$colName];
201 $query .= " AND ( $colName IN ( $colVal ) )";
205 $p = array(1 => array($params['option_group_id'], 'Integer'));
206 CRM_Core_DAO
::executeQuery($query, $p);
209 // CRM-13814 : evalute option group id
210 if (!array_key_exists('option_group_id', $params) && !empty($ids['optionValue'])) {
211 $groupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
212 $ids['optionValue'], 'option_group_id', 'id'
216 $groupId = $params['option_group_id'];
219 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
220 $groupId, 'name', 'id'
222 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
223 $optionValue->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
226 $optionValue->id
= CRM_Utils_Array
::value('optionValue', $ids);
227 $optionValue->save();
228 CRM_Core_PseudoConstant
::flush();
233 * Delete Option Value.
235 * @param int $optionValueId
240 public static function del($optionValueId) {
241 $optionValue = new CRM_Core_DAO_OptionValue();
242 $optionValue->id
= $optionValueId;
243 if (self
::updateRecords($optionValueId, CRM_Core_Action
::DELETE
)) {
244 CRM_Core_PseudoConstant
::flush();
245 return $optionValue->delete();
251 * Retrieve activity type label and description.
253 * @param int $activityTypeId
257 * label and description
259 public static function getActivityTypeDetails($activityTypeId) {
260 $query = "SELECT civicrm_option_value.label, civicrm_option_value.description
261 FROM civicrm_option_value
262 LEFT JOIN civicrm_option_group ON ( civicrm_option_value.option_group_id = civicrm_option_group.id )
263 WHERE civicrm_option_group.name = 'activity_type'
264 AND civicrm_option_value.value = {$activityTypeId} ";
266 $dao = CRM_Core_DAO
::executeQuery($query);
270 return array($dao->label
, $dao->description
);
274 * Get the Option Value title.
277 * Id of Option Value.
283 public static function getTitle($id) {
284 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $id, 'label');
288 * Updates contacts affected by the option value passed.
290 * @param int $optionValueId
291 * The option value id.
293 * The action describing whether prefix/suffix was UPDATED or DELETED.
297 public static function updateRecords(&$optionValueId, $action) {
299 $optionValue = new CRM_Core_DAO_OptionValue();
300 $optionValue->id
= $optionValueId;
301 $optionValue->find(TRUE);
303 $optionGroup = new CRM_Core_DAO_OptionGroup();
304 $optionGroup->id
= $optionValue->option_group_id
;
305 $optionGroup->find(TRUE);
308 $gName = $optionGroup->name
;
310 $value = $optionValue->value
;
312 // get the proper group name & affected field name
313 // todo: this may no longer be needed for individuals - check inputs
314 $individuals = array(
315 'gender' => 'gender_id',
316 'individual_prefix' => 'prefix_id',
317 'individual_suffix' => 'suffix_id',
318 'communication_style' => 'communication_style_id',
319 // Not only Individuals -- but the code seems to be generic for all contact types, despite the naming...
321 $contributions = array('payment_instrument' => 'payment_instrument_id');
322 $activities = array('activity_type' => 'activity_type_id');
323 $participant = array('participant_role' => 'role_id');
324 $eventType = array('event_type' => 'event_type_id');
325 $aclRole = array('acl_role' => 'acl_role_id');
327 $all = array_merge($individuals, $contributions, $activities, $participant, $eventType, $aclRole);
330 foreach ($all as $name => $id) {
331 if ($gName == $name) {
335 if ($fieldName == '') {
339 if (array_key_exists($gName, $individuals)) {
340 $contactDAO = new CRM_Contact_DAO_Contact();
342 $contactDAO->$fieldName = $value;
345 while ($contactDAO->fetch()) {
346 if ($action == CRM_Core_Action
::DELETE
) {
347 $contact = new CRM_Contact_DAO_Contact();
348 $contact->id
= $contactDAO->id
;
349 $contact->find(TRUE);
351 // make sure dates doesn't get reset
352 $contact->birth_date
= CRM_Utils_Date
::isoToMysql($contact->birth_date
);
353 $contact->deceased_date
= CRM_Utils_Date
::isoToMysql($contact->deceased_date
);
354 $contact->$fieldName = 'NULL';
362 if (array_key_exists($gName, $contributions)) {
363 $contribution = new CRM_Contribute_DAO_Contribution();
364 $contribution->$fieldName = $value;
365 $contribution->find();
366 while ($contribution->fetch()) {
367 if ($action == CRM_Core_Action
::DELETE
) {
368 $contribution->$fieldName = 'NULL';
369 $contribution->save();
375 if (array_key_exists($gName, $activities)) {
376 $activity = new CRM_Activity_DAO_Activity();
377 $activity->$fieldName = $value;
379 while ($activity->fetch()) {
385 //delete participant role, type and event type option value
386 if (array_key_exists($gName, $participant)) {
387 $participantValue = new CRM_Event_DAO_Participant();
388 $participantValue->$fieldName = $value;
389 if ($participantValue->find(TRUE)) {
395 //delete event type option value
396 if (array_key_exists($gName, $eventType)) {
397 $event = new CRM_Event_DAO_Event();
398 $event->$fieldName = $value;
399 if ($event->find(TRUE)) {
405 //delete acl_role option value
406 if (array_key_exists($gName, $aclRole)) {
407 $entityRole = new CRM_ACL_DAO_EntityRole();
408 $entityRole->$fieldName = $value;
410 $aclDAO = new CRM_ACL_DAO_ACL();
411 $aclDAO->entity_id
= $value;
412 if ($entityRole->find(TRUE) ||
$aclDAO->find(TRUE)) {
420 * Updates options values weights.
422 * @param int $opGroupId
423 * @param array $opWeights
424 * Options value , weight pair.
426 public static function updateOptionWeights($opGroupId, $opWeights) {
427 if (!is_array($opWeights) ||
empty($opWeights)) {
431 foreach ($opWeights as $opValue => $opWeight) {
432 $optionValue = new CRM_Core_DAO_OptionValue();
433 $optionValue->option_group_id
= $opGroupId;
434 $optionValue->value
= $opValue;
435 if ($optionValue->find(TRUE)) {
436 $optionValue->weight
= $opWeight;
437 $optionValue->save();
439 $optionValue->free();
444 * Get the values of all option values given an option group ID. Store in system cache
445 * Does not take any filtering arguments. The object is to avoid hitting the DB and retrieve
448 * @param int $optionGroupID
449 * The option group for which we want the values from.
452 * an array of array of values for this option group
454 public static function getOptionValuesArray($optionGroupID) {
455 // check if we can get the field values from the system cache
456 $cacheKey = "CRM_Core_BAO_OptionValue_OptionGroupID_{$optionGroupID}";
457 $cache = CRM_Utils_Cache
::singleton();
458 $optionValues = $cache->get($cacheKey);
459 if (empty($optionValues)) {
460 $dao = new CRM_Core_DAO_OptionValue();
461 $dao->option_group_id
= $optionGroupID;
462 $dao->orderBy('weight ASC, label ASC');
465 $optionValues = array();
466 while ($dao->fetch()) {
467 $optionValues[$dao->id
] = array();
468 CRM_Core_DAO
::storeValues($dao, $optionValues[$dao->id
]);
471 $cache->set($cacheKey, $optionValues);
474 return $optionValues;
478 * Get the values of all option values given an option group ID as a key => value pair
479 * Use above cached function to make it super efficient
481 * @param int $optionGroupID
482 * The option group for which we want the values from.
485 * an associative array of label, value pairs
487 public static function getOptionValuesAssocArray($optionGroupID) {
488 $optionValues = self
::getOptionValuesArray($optionGroupID);
491 foreach ($optionValues as $id => $value) {
492 $options[$value['value']] = $value['label'];
498 * Get the values of all option values given an option group Name as a key => value pair
499 * Use above cached function to make it super efficient
501 * @param string $optionGroupName
502 * The option group name for which we want the values from.
505 * an associative array of label, value pairs
507 public static function getOptionValuesAssocArrayFromName($optionGroupName) {
508 $dao = new CRM_Core_DAO_OptionGroup();
509 $dao->name
= $optionGroupName;
511 $dao->selectAdd('id');
513 $optionValues = self
::getOptionValuesArray($dao->id
);
516 foreach ($optionValues as $id => $value) {
517 $options[$value['value']] = $value['label'];
523 * Ensure an option value exists.
525 * This function is intended to be called from the upgrade script to ensure
526 * that an option value exists, without hitting an error if it already exists.
528 * This is sympathetic to sites who might pre-add it.
530 public static function ensureOptionValueExists($params) {
531 $existingValues = civicrm_api3('OptionValue', 'get', array(
532 'option_group_id' => $params['option_group_id'],
533 'name' => $params['name'],
535 if (!$existingValues['count']) {
536 civicrm_api3('OptionValue', 'create', $params);