Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
e7112fa7 | 6 | | Copyright CiviCRM LLC (c) 2004-2015 | |
6a488035 TO |
7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
e7112fa7 | 31 | * @copyright CiviCRM LLC (c) 2004-2015 |
6a488035 TO |
32 | */ |
33 | class CRM_Core_BAO_OptionValue extends CRM_Core_DAO_OptionValue { | |
34 | ||
35 | /** | |
fe482240 | 36 | * Class constructor. |
6a488035 | 37 | */ |
00be9182 | 38 | public function __construct() { |
6a488035 TO |
39 | parent::__construct(); |
40 | } | |
77b97be7 | 41 | |
9fe6051a | 42 | /** |
8eedd10a | 43 | * Create option value. |
44 | * | |
45 | * Note that the create function calls 'add' but has more business logic. | |
77b97be7 | 46 | * |
6a0b768e TO |
47 | * @param array $params |
48 | * Input parameters. | |
77b97be7 EM |
49 | * |
50 | * @return object | |
51 | */ | |
00be9182 | 52 | public static function create($params) { |
9b873358 | 53 | if (empty($params['id'])) { |
c87bbced | 54 | self::setDefaults($params); |
55 | } | |
56 | $ids = array(); | |
a7488080 | 57 | if (!empty($params['id'])) { |
c87bbced | 58 | $ids = array('optionValue' => $params['id']); |
59 | } | |
d3e86119 | 60 | return CRM_Core_BAO_OptionValue::add($params, $ids); |
c87bbced | 61 | } |
353ffa53 | 62 | |
c87bbced | 63 | /** |
fe482240 | 64 | * Set default Parameters. |
c87bbced | 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) | |
9fe6051a | 68 | * - weight & value will be set to their respective option groups next values |
69 | * if nothing is passed in. | |
70 | * | |
71 | * Note this function does not check for presence of $params['id'] so should only be called | |
72 | * if 'id' is not present | |
c87bbced | 73 | * |
9fe6051a | 74 | * @param array $params |
c87bbced | 75 | */ |
9b873358 TO |
76 | public static function setDefaults(&$params) { |
77 | if (CRM_Utils_Array::value('label', $params, NULL) === NULL) { | |
c87bbced | 78 | $params['label'] = $params['name']; |
79 | } | |
9b873358 | 80 | if (CRM_Utils_Array::value('name', $params, NULL) === NULL) { |
c87bbced | 81 | $params['name'] = $params['label']; |
82 | } | |
9b873358 | 83 | if (CRM_Utils_Array::value('weight', $params, NULL) === NULL) { |
983e888c | 84 | $params['weight'] = self::getDefaultWeight($params); |
c87bbced | 85 | } |
9b873358 | 86 | if (CRM_Utils_Array::value('value', $params, NULL) === NULL) { |
1c6b7d30 | 87 | $params['value'] = self::getDefaultValue($params); |
c87bbced | 88 | } |
89 | } | |
77b97be7 | 90 | |
9fe6051a | 91 | /** |
fe482240 | 92 | * Get next available value. |
9fe6051a | 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 | |
77b97be7 | 96 | * |
9fe6051a | 97 | * @param array $params |
77b97be7 EM |
98 | * |
99 | * @return int | |
9fe6051a | 100 | */ |
9b873358 | 101 | public static function getDefaultWeight($params) { |
1c6b7d30 | 102 | return (int) CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', |
353ffa53 | 103 | array('option_group_id' => $params['option_group_id'])); |
1c6b7d30 | 104 | } |
105 | ||
106 | /** | |
0880a9d0 | 107 | * Get next available value. |
1c6b7d30 | 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 | |
112 | */ | |
9b873358 | 113 | public static function getDefaultValue($params) { |
353ffa53 TO |
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']; | |
118 | } | |
119 | $bao->selectAdd(); | |
120 | $bao->whereAdd("value REGEXP '^[0-9]+$'"); | |
121 | $bao->selectAdd('(ROUND(COALESCE(MAX(CONVERT(value, UNSIGNED)),0)) +1) as nextvalue'); | |
122 | $bao->find(TRUE); | |
123 | return $bao->nextvalue; | |
9fe6051a | 124 | } |
353ffa53 | 125 | |
6a488035 | 126 | /** |
fe482240 | 127 | * Fetch object based on array of properties. |
6a488035 | 128 | * |
6a0b768e TO |
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. | |
6a488035 | 133 | * |
16b10e64 | 134 | * @return CRM_Core_BAO_OptionValue |
6a488035 | 135 | */ |
00be9182 | 136 | public static function retrieve(&$params, &$defaults) { |
6a488035 TO |
137 | $optionValue = new CRM_Core_DAO_OptionValue(); |
138 | $optionValue->copyValues($params); | |
139 | if ($optionValue->find(TRUE)) { | |
140 | CRM_Core_DAO::storeValues($optionValue, $defaults); | |
141 | return $optionValue; | |
142 | } | |
143 | return NULL; | |
144 | } | |
145 | ||
146 | /** | |
fe482240 | 147 | * Update the is_active flag in the db. |
6a488035 | 148 | * |
6a0b768e TO |
149 | * @param int $id |
150 | * Id of the database record. | |
151 | * @param bool $is_active | |
152 | * Value we want to set the is_active field. | |
6a488035 | 153 | * |
a6c01b45 | 154 | * @return Object |
b44e3f84 | 155 | * DAO object on success, null otherwise |
6a488035 | 156 | */ |
00be9182 | 157 | public static function setIsActive($id, $is_active) { |
6a488035 TO |
158 | return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_OptionValue', $id, 'is_active', $is_active); |
159 | } | |
160 | ||
161 | /** | |
fe482240 | 162 | * Add an Option Value. |
6a488035 | 163 | * |
6a0b768e TO |
164 | * @param array $params |
165 | * Reference array contains the values submitted by the form. | |
166 | * @param array $ids | |
167 | * Reference array contains the id. | |
6a488035 | 168 | * |
6a488035 | 169 | * |
7c285037 | 170 | * @return CRM_Core_DAO_OptionValue |
6a488035 | 171 | */ |
00be9182 | 172 | public static function add(&$params, &$ids) { |
6a488035 | 173 | // CRM-10921: do not reset attributes to default if this is an update |
9fe6051a | 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 | |
a7488080 | 178 | if (empty($ids['optionValue'])) { |
6a488035 TO |
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); | |
183 | } | |
58eaa092 CW |
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']); | |
187 | } | |
6a488035 TO |
188 | |
189 | // action is taken depending upon the mode | |
190 | $optionValue = new CRM_Core_DAO_OptionValue(); | |
191 | $optionValue->copyValues($params); | |
192 | ||
a7488080 | 193 | if (!empty($params['is_default'])) { |
6a488035 TO |
194 | $query = 'UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = %1'; |
195 | ||
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 ) )"; | |
202 | } | |
203 | } | |
204 | ||
205 | $p = array(1 => array($params['option_group_id'], 'Integer')); | |
206 | CRM_Core_DAO::executeQuery($query, $p); | |
207 | } | |
89ab5601 PJ |
208 | |
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' | |
213 | ); | |
214 | } | |
215 | else { | |
216 | $groupId = $params['option_group_id']; | |
217 | } | |
218 | ||
6a488035 | 219 | $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', |
89ab5601 | 220 | $groupId, 'name', 'id' |
6a488035 TO |
221 | ); |
222 | if (in_array($groupName, CRM_Core_OptionGroup::$_domainIDGroups)) { | |
223 | $optionValue->domain_id = CRM_Utils_Array::value('domain_id', $params, CRM_Core_Config::domainID()); | |
224 | } | |
225 | ||
226 | $optionValue->id = CRM_Utils_Array::value('optionValue', $ids); | |
227 | $optionValue->save(); | |
a4a33486 | 228 | CRM_Core_PseudoConstant::flush(); |
6a488035 TO |
229 | return $optionValue; |
230 | } | |
231 | ||
232 | /** | |
fe482240 | 233 | * Delete Option Value. |
6a488035 | 234 | * |
c490a46a | 235 | * @param int $optionValueId |
6a488035 | 236 | * |
5c766a0b | 237 | * @return bool |
6a488035 | 238 | * |
6a488035 | 239 | */ |
00be9182 | 240 | public static function del($optionValueId) { |
6a488035 TO |
241 | $optionValue = new CRM_Core_DAO_OptionValue(); |
242 | $optionValue->id = $optionValueId; | |
243 | if (self::updateRecords($optionValueId, CRM_Core_Action::DELETE)) { | |
a4a33486 | 244 | CRM_Core_PseudoConstant::flush(); |
6a488035 TO |
245 | return $optionValue->delete(); |
246 | } | |
247 | return FALSE; | |
248 | } | |
249 | ||
250 | /** | |
fe482240 | 251 | * Retrieve activity type label and description. |
6a488035 | 252 | * |
6a0b768e TO |
253 | * @param int $activityTypeId |
254 | * Activity type id. | |
6a488035 | 255 | * |
a6c01b45 CW |
256 | * @return array |
257 | * label and description | |
6a488035 | 258 | */ |
00be9182 | 259 | public static function getActivityTypeDetails($activityTypeId) { |
6a488035 TO |
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} "; | |
265 | ||
266 | $dao = CRM_Core_DAO::executeQuery($query); | |
267 | ||
268 | $dao->fetch(); | |
269 | ||
270 | return array($dao->label, $dao->description); | |
271 | } | |
272 | ||
273 | /** | |
274 | * Get the Option Value title. | |
275 | * | |
6a0b768e TO |
276 | * @param int $id |
277 | * Id of Option Value. | |
6a488035 | 278 | * |
a6c01b45 CW |
279 | * @return string |
280 | * title | |
6a488035 | 281 | * |
6a488035 TO |
282 | */ |
283 | public static function getTitle($id) { | |
284 | return CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $id, 'label'); | |
285 | } | |
286 | ||
287 | /** | |
100fef9d | 288 | * Updates contacts affected by the option value passed. |
6a488035 | 289 | * |
6a0b768e TO |
290 | * @param int $optionValueId |
291 | * The option value id. | |
292 | * @param int $action | |
293 | * The action describing whether prefix/suffix was UPDATED or DELETED. | |
6a488035 | 294 | * |
7a6073fd | 295 | * @return bool |
6a488035 | 296 | */ |
00be9182 | 297 | public static function updateRecords(&$optionValueId, $action) { |
6a488035 TO |
298 | //finding group name |
299 | $optionValue = new CRM_Core_DAO_OptionValue(); | |
300 | $optionValue->id = $optionValueId; | |
301 | $optionValue->find(TRUE); | |
302 | ||
303 | $optionGroup = new CRM_Core_DAO_OptionGroup(); | |
304 | $optionGroup->id = $optionValue->option_group_id; | |
305 | $optionGroup->find(TRUE); | |
306 | ||
307 | // group name | |
308 | $gName = $optionGroup->name; | |
309 | // value | |
310 | $value = $optionValue->value; | |
311 | ||
312 | // get the proper group name & affected field name | |
67744c4e | 313 | // todo: this may no longer be needed for individuals - check inputs |
6a488035 TO |
314 | $individuals = array( |
315 | 'gender' => 'gender_id', | |
316 | 'individual_prefix' => 'prefix_id', | |
317 | 'individual_suffix' => 'suffix_id', | |
353ffa53 TO |
318 | 'communication_style' => 'communication_style_id', |
319 | // Not only Individuals -- but the code seems to be generic for all contact types, despite the naming... | |
6a488035 TO |
320 | ); |
321 | $contributions = array('payment_instrument' => 'payment_instrument_id'); | |
353ffa53 TO |
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'); | |
6a488035 TO |
326 | |
327 | $all = array_merge($individuals, $contributions, $activities, $participant, $eventType, $aclRole); | |
328 | $fieldName = ''; | |
329 | ||
330 | foreach ($all as $name => $id) { | |
331 | if ($gName == $name) { | |
332 | $fieldName = $id; | |
333 | } | |
334 | } | |
335 | if ($fieldName == '') { | |
336 | return TRUE; | |
337 | } | |
338 | ||
339 | if (array_key_exists($gName, $individuals)) { | |
340 | $contactDAO = new CRM_Contact_DAO_Contact(); | |
341 | ||
342 | $contactDAO->$fieldName = $value; | |
343 | $contactDAO->find(); | |
344 | ||
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); | |
350 | ||
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'; | |
355 | $contact->save(); | |
356 | } | |
357 | } | |
358 | ||
359 | return TRUE; | |
360 | } | |
361 | ||
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(); | |
370 | } | |
371 | } | |
372 | return TRUE; | |
373 | } | |
374 | ||
375 | if (array_key_exists($gName, $activities)) { | |
376 | $activity = new CRM_Activity_DAO_Activity(); | |
377 | $activity->$fieldName = $value; | |
378 | $activity->find(); | |
379 | while ($activity->fetch()) { | |
380 | $activity->delete(); | |
381 | } | |
382 | return TRUE; | |
383 | } | |
384 | ||
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)) { | |
390 | return FALSE; | |
391 | } | |
392 | return TRUE; | |
393 | } | |
394 | ||
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)) { | |
400 | return FALSE; | |
401 | } | |
402 | return TRUE; | |
403 | } | |
404 | ||
405 | //delete acl_role option value | |
406 | if (array_key_exists($gName, $aclRole)) { | |
407 | $entityRole = new CRM_ACL_DAO_EntityRole(); | |
408 | $entityRole->$fieldName = $value; | |
409 | ||
410 | $aclDAO = new CRM_ACL_DAO_ACL(); | |
411 | $aclDAO->entity_id = $value; | |
412 | if ($entityRole->find(TRUE) || $aclDAO->find(TRUE)) { | |
413 | return FALSE; | |
414 | } | |
415 | return TRUE; | |
416 | } | |
417 | } | |
418 | ||
419 | /** | |
100fef9d | 420 | * Updates options values weights. |
6a488035 | 421 | * |
c490a46a | 422 | * @param int $opGroupId |
6a0b768e TO |
423 | * @param array $opWeights |
424 | * Options value , weight pair. | |
6a488035 | 425 | */ |
00be9182 | 426 | public static function updateOptionWeights($opGroupId, $opWeights) { |
6a488035 TO |
427 | if (!is_array($opWeights) || empty($opWeights)) { |
428 | return; | |
429 | } | |
430 | ||
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(); | |
438 | } | |
439 | $optionValue->free(); | |
440 | } | |
441 | } | |
442 | ||
443 | /** | |
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 | |
446 | * from memory | |
447 | * | |
6a0b768e TO |
448 | * @param int $optionGroupID |
449 | * The option group for which we want the values from. | |
6a488035 | 450 | * |
a6c01b45 CW |
451 | * @return array |
452 | * an array of array of values for this option group | |
6a488035 | 453 | */ |
00be9182 | 454 | public static function getOptionValuesArray($optionGroupID) { |
6a488035 | 455 | // check if we can get the field values from the system cache |
353ffa53 TO |
456 | $cacheKey = "CRM_Core_BAO_OptionValue_OptionGroupID_{$optionGroupID}"; |
457 | $cache = CRM_Utils_Cache::singleton(); | |
6a488035 TO |
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'); | |
463 | $dao->find(); | |
464 | ||
465 | $optionValues = array(); | |
466 | while ($dao->fetch()) { | |
467 | $optionValues[$dao->id] = array(); | |
468 | CRM_Core_DAO::storeValues($dao, $optionValues[$dao->id]); | |
469 | } | |
470 | ||
471 | $cache->set($cacheKey, $optionValues); | |
472 | } | |
473 | ||
474 | return $optionValues; | |
475 | } | |
476 | ||
477 | /** | |
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 | |
480 | * | |
6a0b768e TO |
481 | * @param int $optionGroupID |
482 | * The option group for which we want the values from. | |
6a488035 | 483 | * |
a6c01b45 CW |
484 | * @return array |
485 | * an associative array of label, value pairs | |
6a488035 | 486 | */ |
00be9182 | 487 | public static function getOptionValuesAssocArray($optionGroupID) { |
6a488035 TO |
488 | $optionValues = self::getOptionValuesArray($optionGroupID); |
489 | ||
490 | $options = array(); | |
491 | foreach ($optionValues as $id => $value) { | |
492 | $options[$value['value']] = $value['label']; | |
493 | } | |
494 | return $options; | |
495 | } | |
353ffa53 | 496 | |
6a488035 TO |
497 | /** |
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 | |
500 | * | |
6a0b768e TO |
501 | * @param string $optionGroupName |
502 | * The option group name for which we want the values from. | |
6a488035 | 503 | * |
a6c01b45 CW |
504 | * @return array |
505 | * an associative array of label, value pairs | |
6a488035 | 506 | */ |
00be9182 | 507 | public static function getOptionValuesAssocArrayFromName($optionGroupName) { |
6a488035 TO |
508 | $dao = new CRM_Core_DAO_OptionGroup(); |
509 | $dao->name = $optionGroupName; | |
510 | $dao->selectAdd(); | |
511 | $dao->selectAdd('id'); | |
512 | $dao->find(TRUE); | |
513 | $optionValues = self::getOptionValuesArray($dao->id); | |
514 | ||
515 | $options = array(); | |
516 | foreach ($optionValues as $id => $value) { | |
517 | $options[$value['value']] = $value['label']; | |
518 | } | |
519 | return $options; | |
520 | } | |
521 | ||
522 | } |