3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 class CRM_Core_BAO_OptionValue
extends CRM_Core_DAO_OptionValue
{
40 function __construct() {
41 parent
::__construct();
44 * Create option value - note that the create function calls 'add' but
45 * has more business logic
47 * @param array $params input parameters
49 static function create($params) {
50 if (empty($params['id'])){
51 self
::setDefaults($params);
54 if (CRM_Utils_Array
::value('id', $params)) {
55 $ids = array('optionValue' => $params['id']);
57 return CRM_Core_BAO_OptionValue
::add($params, $ids);
61 * Set default Parameters
62 * This functions sets default parameters if not set:
63 * - name & label are set to each other as required (it might make more sense for one
64 * to be required but this would mean a change to the api level)
65 * - weight & value will be set to their respective option groups next values
66 * if nothing is passed in.
68 * Note this function does not check for presence of $params['id'] so should only be called
69 * if 'id' is not present
71 * @param array $params
73 static function setDefaults(&$params){
74 if(CRM_Utils_Array
::value('label', $params, NULL) === NULL){
75 $params['label'] = $params['name'];
77 if(CRM_Utils_Array
::value('name', $params, NULL) === NULL){
78 $params['name'] = $params['label'];
80 if(CRM_Utils_Array
::value('weight', $params, NULL) === NULL){
81 $params['weight'] = self
::getDefaultWeight($params);
83 if (CRM_Utils_Array
::value('value', $params, NULL) === NULL){
84 $params['value'] = self
::getDefaultValue($params);
88 * Get next available value
89 * We will take the highest numeric value (or 0 if no numeric values exist)
90 * and add one. The calling function is responsible for any
91 * more complex decision making
92 * @param array $params
94 static function getDefaultWeight($params){
95 return (int) CRM_Utils_Weight
::getDefaultWeight('CRM_Core_DAO_OptionValue',
96 array('option_group_id' => $params['option_group_id']));
100 * Get next available value
101 * We will take the highest numeric value (or 0 if no numeric values exist)
102 * and add one. The calling function is responsible for any
103 * more complex decision making
104 * @param array $params
106 static function getDefaultValue($params){
107 $bao = new CRM_Core_BAO_OptionValue();
108 $bao->option_group_id
= $params['option_group_id'];
109 if(isset($params['domain_id'])){
110 $bao->domain_id
= $params['domain_id'];
113 $bao->whereAdd("value REGEXP '^[0-9]+$'");
114 $bao->selectAdd('(ROUND(COALESCE(MAX(CONVERT(value, UNSIGNED)),0)) +1) as nextvalue');
116 return $bao->nextvalue
;
119 * Takes a bunch of params that are needed to match certain criteria and
120 * retrieves the relevant objects. Typically the valid params are only
121 * contact_id. We'll tweak this function to be more full featured over a period
122 * of time. This is the inverse function of create. It also stores all the retrieved
123 * values in the default array
125 * @param array $params (reference ) an assoc array of name/value pairs
126 * @param array $defaults (reference ) an assoc array to hold the flattened values
128 * @return object CRM_Core_BAO_OptionValue object
132 static function retrieve(&$params, &$defaults) {
133 $optionValue = new CRM_Core_DAO_OptionValue();
134 $optionValue->copyValues($params);
135 if ($optionValue->find(TRUE)) {
136 CRM_Core_DAO
::storeValues($optionValue, $defaults);
143 * update the is_active flag in the db
145 * @param int $id id of the database record
146 * @param boolean $is_active value we want to set the is_active field
148 * @return Object DAO object on sucess, null otherwise
151 static function setIsActive($id, $is_active) {
152 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_OptionValue', $id, 'is_active', $is_active);
156 * Function to add an Option Value
158 * @param array $params reference array contains the values submitted by the form
159 * @param array $ids reference array contains the id
166 static function add(&$params, &$ids) {
167 // CRM-10921: do not reset attributes to default if this is an update
168 //@todo consider if defaults are being set in the right place. 'dumb' defaults like
169 // these would be usefully set @ the api layer so they are visible to api users
170 // complex defaults like the domain id below would make sense in the setDefauls function
171 // but unclear what other ways this function is being used
172 if (!CRM_Utils_Array
::value('optionValue', $ids)) {
173 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, FALSE);
174 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, FALSE);
175 $params['is_optgroup'] = CRM_Utils_Array
::value('is_optgroup', $params, FALSE);
176 $params['filter'] = CRM_Utils_Array
::value('filter', $params, FALSE);
179 // action is taken depending upon the mode
180 $optionValue = new CRM_Core_DAO_OptionValue();
181 $optionValue->copyValues($params);
183 if (CRM_Utils_Array
::value('is_default', $params)) {
184 $query = 'UPDATE civicrm_option_value SET is_default = 0 WHERE option_group_id = %1';
186 // tweak default reset, and allow multiple default within group.
187 if ($resetDefaultFor = CRM_Utils_Array
::value('reset_default_for', $params)) {
188 if (is_array($resetDefaultFor)) {
189 $colName = key($resetDefaultFor);
190 $colVal = $resetDefaultFor[$colName];
191 $query .= " AND ( $colName IN ( $colVal ) )";
195 $p = array(1 => array($params['option_group_id'], 'Integer'));
196 CRM_Core_DAO
::executeQuery($query, $p);
198 $groupName = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionGroup',
199 $params['option_group_id'], 'name', 'id'
201 if (in_array($groupName, CRM_Core_OptionGroup
::$_domainIDGroups)) {
202 $optionValue->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
205 $optionValue->id
= CRM_Utils_Array
::value('optionValue', $ids);
206 $optionValue->save();
207 CRM_Core_PseudoConstant
::flush();
212 * Function to delete Option Value
214 * @param int $optionGroupId Id of the Option Group to be deleted.
221 static function del($optionValueId) {
222 $optionValue = new CRM_Core_DAO_OptionValue();
223 $optionValue->id
= $optionValueId;
224 if (self
::updateRecords($optionValueId, CRM_Core_Action
::DELETE
)) {
225 CRM_Core_PseudoConstant
::flush();
226 return $optionValue->delete();
232 * Function to retrieve activity type label and description
234 * @param int $activityTypeId activity type id
236 * @return array label and description
240 static function getActivityTypeDetails($activityTypeId) {
241 $query = "SELECT civicrm_option_value.label, civicrm_option_value.description
242 FROM civicrm_option_value
243 LEFT JOIN civicrm_option_group ON ( civicrm_option_value.option_group_id = civicrm_option_group.id )
244 WHERE civicrm_option_group.name = 'activity_type'
245 AND civicrm_option_value.value = {$activityTypeId} ";
247 $dao = CRM_Core_DAO
::executeQuery($query);
251 return array($dao->label
, $dao->description
);
255 * Get the Option Value title.
257 * @param int $id id of Option Value
259 * @return string title
265 public static function getTitle($id) {
266 return CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_OptionValue', $id, 'label');
270 * updates contacts affected by the option value passed.
272 * @param Integer $optionValueId the option value id.
273 * @param int $action the action describing whether prefix/suffix was UPDATED or DELETED
277 static function updateRecords(&$optionValueId, $action) {
279 $optionValue = new CRM_Core_DAO_OptionValue();
280 $optionValue->id
= $optionValueId;
281 $optionValue->find(TRUE);
283 $optionGroup = new CRM_Core_DAO_OptionGroup();
284 $optionGroup->id
= $optionValue->option_group_id
;
285 $optionGroup->find(TRUE);
288 $gName = $optionGroup->name
;
290 $value = $optionValue->value
;
292 // get the proper group name & affected field name
293 // todo: this may no longer be needed for individuals - check inputs
294 $individuals = array(
295 'gender' => 'gender_id',
296 'individual_prefix' => 'prefix_id',
297 'individual_suffix' => 'suffix_id',
298 'communication_style' => 'communication_style_id', // Not only Individuals -- but the code seems to be generic for all contact types, despite the naming...
300 $contributions = array('payment_instrument' => 'payment_instrument_id');
301 $activities = array('activity_type' => 'activity_type_id');
302 $participant = array('participant_role' => 'role_id');
303 $eventType = array('event_type' => 'event_type_id');
304 $aclRole = array('acl_role' => 'acl_role_id');
306 $all = array_merge($individuals, $contributions, $activities, $participant, $eventType, $aclRole);
309 foreach ($all as $name => $id) {
310 if ($gName == $name) {
314 if ($fieldName == '') {
318 if (array_key_exists($gName, $individuals)) {
319 $contactDAO = new CRM_Contact_DAO_Contact();
321 $contactDAO->$fieldName = $value;
324 while ($contactDAO->fetch()) {
325 if ($action == CRM_Core_Action
::DELETE
) {
326 $contact = new CRM_Contact_DAO_Contact();
327 $contact->id
= $contactDAO->id
;
328 $contact->find(TRUE);
330 // make sure dates doesn't get reset
331 $contact->birth_date
= CRM_Utils_Date
::isoToMysql($contact->birth_date
);
332 $contact->deceased_date
= CRM_Utils_Date
::isoToMysql($contact->deceased_date
);
333 $contact->$fieldName = 'NULL';
341 if (array_key_exists($gName, $contributions)) {
342 $contribution = new CRM_Contribute_DAO_Contribution();
343 $contribution->$fieldName = $value;
344 $contribution->find();
345 while ($contribution->fetch()) {
346 if ($action == CRM_Core_Action
::DELETE
) {
347 $contribution->$fieldName = 'NULL';
348 $contribution->save();
354 if (array_key_exists($gName, $activities)) {
355 $activity = new CRM_Activity_DAO_Activity();
356 $activity->$fieldName = $value;
358 while ($activity->fetch()) {
364 //delete participant role, type and event type option value
365 if (array_key_exists($gName, $participant)) {
366 $participantValue = new CRM_Event_DAO_Participant();
367 $participantValue->$fieldName = $value;
368 if ($participantValue->find(TRUE)) {
374 //delete event type option value
375 if (array_key_exists($gName, $eventType)) {
376 $event = new CRM_Event_DAO_Event();
377 $event->$fieldName = $value;
378 if ($event->find(TRUE)) {
384 //delete acl_role option value
385 if (array_key_exists($gName, $aclRole)) {
386 $entityRole = new CRM_ACL_DAO_EntityRole();
387 $entityRole->$fieldName = $value;
389 $aclDAO = new CRM_ACL_DAO_ACL();
390 $aclDAO->entity_id
= $value;
391 if ($entityRole->find(TRUE) ||
$aclDAO->find(TRUE)) {
399 * updates options values weights.
401 * @param int $opGroupIde option group id.
402 * @param array $opWeights options value , weight pair
408 static function updateOptionWeights($opGroupId, $opWeights) {
409 if (!is_array($opWeights) ||
empty($opWeights)) {
413 foreach ($opWeights as $opValue => $opWeight) {
414 $optionValue = new CRM_Core_DAO_OptionValue();
415 $optionValue->option_group_id
= $opGroupId;
416 $optionValue->value
= $opValue;
417 if ($optionValue->find(TRUE)) {
418 $optionValue->weight
= $opWeight;
419 $optionValue->save();
421 $optionValue->free();
426 * Get the values of all option values given an option group ID. Store in system cache
427 * Does not take any filtering arguments. The object is to avoid hitting the DB and retrieve
430 * @param int $optionGroupID the option group for which we want the values from
432 * @return array an array of array of values for this option group
436 static function getOptionValuesArray($optionGroupID) {
437 // check if we can get the field values from the system cache
438 $cacheKey = "CRM_Core_BAO_OptionValue_OptionGroupID_{$optionGroupID}";
439 $cache = CRM_Utils_Cache
::singleton();
440 $optionValues = $cache->get($cacheKey);
441 if (empty($optionValues)) {
442 $dao = new CRM_Core_DAO_OptionValue();
443 $dao->option_group_id
= $optionGroupID;
444 $dao->orderBy('weight ASC, label ASC');
447 $optionValues = array();
448 while ($dao->fetch()) {
449 $optionValues[$dao->id
] = array();
450 CRM_Core_DAO
::storeValues($dao, $optionValues[$dao->id
]);
453 $cache->set($cacheKey, $optionValues);
456 return $optionValues;
460 * Get the values of all option values given an option group ID as a key => value pair
461 * Use above cached function to make it super efficient
463 * @param int $optionGroupID the option group for which we want the values from
465 * @return array an associative array of label, value pairs
469 static function getOptionValuesAssocArray($optionGroupID) {
470 $optionValues = self
::getOptionValuesArray($optionGroupID);
473 foreach ($optionValues as $id => $value) {
474 $options[$value['value']] = $value['label'];
479 * Get the values of all option values given an option group Name as a key => value pair
480 * Use above cached function to make it super efficient
482 * @param string $optionGroupName the option group name for which we want the values from
484 * @return array an associative array of label, value pairs
488 static function getOptionValuesAssocArrayFromName($optionGroupName) {
489 $dao = new CRM_Core_DAO_OptionGroup();
490 $dao->name
= $optionGroupName;
492 $dao->selectAdd('id');
494 $optionValues = self
::getOptionValuesArray($dao->id
);
497 foreach ($optionValues as $id => $value) {
498 $options[$value['value']] = $value['label'];