3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
35 class CRM_Core_BAO_OptionValue
extends CRM_Core_DAO_OptionValue
{
40 public function __construct() {
41 parent
::__construct();
45 * Create option value - note that the create function calls 'add' but
46 * has more business logic
48 * @param array $params
53 public static function create($params) {
54 if (empty($params['id'])) {
55 self
::setDefaults($params);
58 if (!empty($params['id'])) {
59 $ids = array('optionValue' => $params['id']);
61 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
;
126 * Fetch object based on array of properties
128 * @param array $params
129 * (reference ) an assoc array of name/value pairs.
130 * @param array $defaults
131 * (reference ) an assoc array to hold the flattened values.
133 * @return CRM_Core_BAO_OptionValue object
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.
154 * @return Object DAO object on sucess, 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.
171 * @return CRM_Core_DAO_OptionValue
173 public static function add(&$params, &$ids) {
174 // CRM-10921: do not reset attributes to default if this is an update
175 //@todo consider if defaults are being set in the right place. 'dumb' defaults like
176 // these would be usefully set @ the api layer so they are visible to api users
177 // complex defaults like the domain id below would make sense in the setDefauls function
178 // but unclear what other ways this function is being used
179 if (empty($ids['optionValue'])) {
180 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
181 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
182 $params['is_optgroup'] = CRM_Utils_Array
::value('is_optgroup', $params, FALSE);
183 $params['filter'] = CRM_Utils_Array
::value('filter', $params, FALSE);
186 // action is taken depending upon the mode
187 $optionValue = new CRM_Core_DAO_OptionValue();
188 $optionValue->copyValues($params);
190 if (!empty($params['is_default'])) {
191 $query = 'UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = %1';
193 // tweak default reset, and allow multiple default within group.
194 if ($resetDefaultFor = CRM_Utils_Array
::value('reset_default_for', $params)) {
195 if (is_array($resetDefaultFor)) {
196 $colName = key($resetDefaultFor);
197 $colVal = $resetDefaultFor[$colName];
198 $query .= " AND ( $colName IN ( $colVal ) )";
202 $p = array(1 => array($params['option_group_id'], 'Integer'));
203 CRM_Core_DAO
::executeQuery($query, $p);
206 // CRM-13814 : evalute option group id
207 if (!array_key_exists('option_group_id', $params) && !empty($ids['optionValue'])) {
208 $groupId = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue',
209 $ids['optionValue'], 'option_group_id', 'id'
213 $groupId = $params['option_group_id'];
216 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
217 $groupId, 'name', 'id'
219 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
220 $optionValue->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
223 $optionValue->id
= CRM_Utils_Array
::value('optionValue', $ids);
224 $optionValue->save();
225 CRM_Core_PseudoConstant
::flush();
230 * Delete Option Value
232 * @param int $optionValueId
238 public static function del($optionValueId) {
239 $optionValue = new CRM_Core_DAO_OptionValue();
240 $optionValue->id
= $optionValueId;
241 if (self
::updateRecords($optionValueId, CRM_Core_Action
::DELETE
)) {
242 CRM_Core_PseudoConstant
::flush();
243 return $optionValue->delete();
249 * Retrieve activity type label and description
251 * @param int $activityTypeId
254 * @return array label and description
257 public static function getActivityTypeDetails($activityTypeId) {
258 $query = "SELECT civicrm_option_value.label, civicrm_option_value.description
259 FROM civicrm_option_value
260 LEFT JOIN civicrm_option_group ON ( civicrm_option_value.option_group_id = civicrm_option_group.id )
261 WHERE civicrm_option_group.name = 'activity_type'
262 AND civicrm_option_value.value = {$activityTypeId} ";
264 $dao = CRM_Core_DAO
::executeQuery($query);
268 return array($dao->label
, $dao->description
);
272 * Get the Option Value title.
275 * Id of Option Value.
277 * @return string title
282 public static function getTitle($id) {
283 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $id, 'label');
287 * Updates contacts affected by the option value passed.
289 * @param int $optionValueId
290 * The option value id.
292 * The action describing whether prefix/suffix was UPDATED or DELETED.
296 public static function updateRecords(&$optionValueId, $action) {
298 $optionValue = new CRM_Core_DAO_OptionValue();
299 $optionValue->id
= $optionValueId;
300 $optionValue->find(TRUE);
302 $optionGroup = new CRM_Core_DAO_OptionGroup();
303 $optionGroup->id
= $optionValue->option_group_id
;
304 $optionGroup->find(TRUE);
307 $gName = $optionGroup->name
;
309 $value = $optionValue->value
;
311 // get the proper group name & affected field name
312 // todo: this may no longer be needed for individuals - check inputs
313 $individuals = array(
314 'gender' => 'gender_id',
315 'individual_prefix' => 'prefix_id',
316 'individual_suffix' => 'suffix_id',
317 'communication_style' => 'communication_style_id', // Not only Individuals -- but the code seems to be generic for all contact types, despite the naming...
319 $contributions = array('payment_instrument' => 'payment_instrument_id');
320 $activities = array('activity_type' => 'activity_type_id');
321 $participant = array('participant_role' => 'role_id');
322 $eventType = array('event_type' => 'event_type_id');
323 $aclRole = array('acl_role' => 'acl_role_id');
325 $all = array_merge($individuals, $contributions, $activities, $participant, $eventType, $aclRole);
328 foreach ($all as $name => $id) {
329 if ($gName == $name) {
333 if ($fieldName == '') {
337 if (array_key_exists($gName, $individuals)) {
338 $contactDAO = new CRM_Contact_DAO_Contact();
340 $contactDAO->$fieldName = $value;
343 while ($contactDAO->fetch()) {
344 if ($action == CRM_Core_Action
::DELETE
) {
345 $contact = new CRM_Contact_DAO_Contact();
346 $contact->id
= $contactDAO->id
;
347 $contact->find(TRUE);
349 // make sure dates doesn't get reset
350 $contact->birth_date
= CRM_Utils_Date
::isoToMysql($contact->birth_date
);
351 $contact->deceased_date
= CRM_Utils_Date
::isoToMysql($contact->deceased_date
);
352 $contact->$fieldName = 'NULL';
360 if (array_key_exists($gName, $contributions)) {
361 $contribution = new CRM_Contribute_DAO_Contribution();
362 $contribution->$fieldName = $value;
363 $contribution->find();
364 while ($contribution->fetch()) {
365 if ($action == CRM_Core_Action
::DELETE
) {
366 $contribution->$fieldName = 'NULL';
367 $contribution->save();
373 if (array_key_exists($gName, $activities)) {
374 $activity = new CRM_Activity_DAO_Activity();
375 $activity->$fieldName = $value;
377 while ($activity->fetch()) {
383 //delete participant role, type and event type option value
384 if (array_key_exists($gName, $participant)) {
385 $participantValue = new CRM_Event_DAO_Participant();
386 $participantValue->$fieldName = $value;
387 if ($participantValue->find(TRUE)) {
393 //delete event type option value
394 if (array_key_exists($gName, $eventType)) {
395 $event = new CRM_Event_DAO_Event();
396 $event->$fieldName = $value;
397 if ($event->find(TRUE)) {
403 //delete acl_role option value
404 if (array_key_exists($gName, $aclRole)) {
405 $entityRole = new CRM_ACL_DAO_EntityRole();
406 $entityRole->$fieldName = $value;
408 $aclDAO = new CRM_ACL_DAO_ACL();
409 $aclDAO->entity_id
= $value;
410 if ($entityRole->find(TRUE) ||
$aclDAO->find(TRUE)) {
418 * Updates options values weights.
420 * @param int $opGroupId
421 * @param array $opWeights
422 * Options value , weight pair.
427 public static function updateOptionWeights($opGroupId, $opWeights) {
428 if (!is_array($opWeights) ||
empty($opWeights)) {
432 foreach ($opWeights as $opValue => $opWeight) {
433 $optionValue = new CRM_Core_DAO_OptionValue();
434 $optionValue->option_group_id
= $opGroupId;
435 $optionValue->value
= $opValue;
436 if ($optionValue->find(TRUE)) {
437 $optionValue->weight
= $opWeight;
438 $optionValue->save();
440 $optionValue->free();
445 * Get the values of all option values given an option group ID. Store in system cache
446 * Does not take any filtering arguments. The object is to avoid hitting the DB and retrieve
449 * @param int $optionGroupID
450 * The option group for which we want the values from.
452 * @return array an array of array of values for this option group
455 public static function getOptionValuesArray($optionGroupID) {
456 // check if we can get the field values from the system cache
457 $cacheKey = "CRM_Core_BAO_OptionValue_OptionGroupID_{$optionGroupID}";
458 $cache = CRM_Utils_Cache
::singleton();
459 $optionValues = $cache->get($cacheKey);
460 if (empty($optionValues)) {
461 $dao = new CRM_Core_DAO_OptionValue();
462 $dao->option_group_id
= $optionGroupID;
463 $dao->orderBy('weight ASC, label ASC');
466 $optionValues = array();
467 while ($dao->fetch()) {
468 $optionValues[$dao->id
] = array();
469 CRM_Core_DAO
::storeValues($dao, $optionValues[$dao->id
]);
472 $cache->set($cacheKey, $optionValues);
475 return $optionValues;
479 * Get the values of all option values given an option group ID as a key => value pair
480 * Use above cached function to make it super efficient
482 * @param int $optionGroupID
483 * The option group for which we want the values from.
485 * @return array an associative array of label, value pairs
488 public static function getOptionValuesAssocArray($optionGroupID) {
489 $optionValues = self
::getOptionValuesArray($optionGroupID);
492 foreach ($optionValues as $id => $value) {
493 $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.
504 * @return array 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'];