CRM/Core/OptionValue.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35 class CRM_Core_OptionValue {
  36
  37   /**
  38    * static field for all the option value information that we can potentially export
  39    *
  40    * @var array
  41    * @static
  42    */
  43   static $_exportableFields = NULL;
  44
  45   /**
  46    * static field for all the option value information that we can potentially export
  47    *
  48    * @var array
  49    * @static
  50    */
  51   static $_importableFields = NULL;
  52
  53   /**
  54    * static field for all the option value information that we can potentially export
  55    *
  56    * @var array
  57    * @static
  58    */
  59   static $_fields = NULL;
  60
  61   /**
  62    * Function to return option-values of a particular group
  63    *
  64    * @param  array     $groupParams   Array containing group fields whose option-values is to retrieved.
  65    * @param  string    $orderBy       for orderBy clause
  66    * @param  array     $links         has links like edit, delete, disable ..etc
  67    *
  68    * @return array of option-values
  69    *
  70    * @access public
  71    * @static
  72    */
  73   static function getRows($groupParams, $links, $orderBy = 'weight') {
  74     $optionValue = array();
  75
  76     $optionGroupID = NULL;
  77     if (!isset($groupParams['id']) || !$groupParams['id']) {
  78       if ($groupParams['name']) {
  79         $config = CRM_Core_Config::singleton();
  80
  81         $optionGroup = CRM_Core_BAO_OptionGroup::retrieve($groupParams, $dnc);
  82         $optionGroupID = $optionGroup->id;
  83       }
  84     }
  85     else {
  86       $optionGroupID = $groupParams['id'];
  87     }
  88
  89     $groupName = CRM_Utils_Array::value('name', $groupParams);
  90     if (!$groupName && $optionGroupID) {
  91       $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup',
  92         $optionGroupID, 'name', 'id'
  93       );
  94     }
  95
  96     $dao = new CRM_Core_DAO_OptionValue();
  97
  98     if ($optionGroupID) {
  99       $dao->option_group_id = $optionGroupID;
 100
 101       if (in_array($groupName, CRM_Core_OptionGroup::$_domainIDGroups)) {
 102         $dao->domain_id = CRM_Core_Config::domainID();
 103       }
 104
 105       $dao->orderBy($orderBy);
 106       $dao->find();
 107     }
 108
 109     if ($groupName == 'case_type') {
 110       $caseTypeIds = CRM_Case_BAO_Case::getUsedCaseType();
 111     }
 112     elseif ($groupName == 'case_status') {
 113       $caseStatusIds = CRM_Case_BAO_Case::getUsedCaseStatuses();
 114     }
 115
 116     $componentNames = CRM_Core_Component::getNames();
 117     $visibilityLabels = CRM_Core_PseudoConstant::visibility();
 118     while ($dao->fetch()) {
 119       $optionValue[$dao->id] = array();
 120       CRM_Core_DAO::storeValues($dao, $optionValue[$dao->id]);
 121       // form all action links
 122       $action = array_sum(array_keys($links));
 123
 124       // update enable/disable links depending on if it is is_reserved or is_active
 125       if ($dao->is_reserved) {
 126         $action = CRM_Core_Action::UPDATE;
 127       }
 128       else {
 129         if ($dao->is_active) {
 130           $action -= CRM_Core_Action::ENABLE;
 131         }
 132         else {
 133           $action -= CRM_Core_Action::DISABLE;
 134         }
 135         if ((($groupName == 'case_type') && in_array($dao->value, $caseTypeIds)) ||
 136           (($groupName == 'case_status') && in_array($dao->value, $caseStatusIds))
 137         ) {
 138           $action -= CRM_Core_Action::DELETE;
 139         }
 140       }
 141
 142       $optionValue[$dao->id]['label'] = htmlspecialchars($optionValue[$dao->id]['label']);
 143       $optionValue[$dao->id]['order'] = $optionValue[$dao->id]['weight'];
 144       $optionValue[$dao->id]['action'] = CRM_Core_Action::formLink($links, $action,
 145         array(
 146           'id' => $dao->id,
 147           'gid' => $optionGroupID,
 148           'value' => $dao->value,
 149         )
 150       );
 151
 152       if (CRM_Utils_Array::value('component_id', $optionValue[$dao->id])) {
 153         $optionValue[$dao->id]['component_name'] = $componentNames[$optionValue[$dao->id]['component_id']];
 154       }
 155       else {
 156         $optionValue[$dao->id]['component_name'] = 'Contact';
 157       }
 158
 159       if (CRM_Utils_Array::value('visibility_id', $optionValue[$dao->id])) {
 160         $optionValue[$dao->id]['visibility_label'] = $visibilityLabels[$optionValue[$dao->id]['visibility_id']];
 161       }
 162     }
 163
 164     return $optionValue;
 165   }
 166
 167   /**
 168    * Function to add/edit option-value of a particular group
 169    *
 170    * @param  array     $params           Array containing exported values from the invoking form.
 171    * @param  array     $groupParams      Array containing group fields whose option-values is to retrieved/saved.
 172    * @param  string    $orderBy          for orderBy clause
 173    * @param  integer   $optionValueID    has the id of the optionValue being edited, disabled ..etc
 174    *
 175    * @return array of option-values
 176    *
 177    * @access public
 178    * @static
 179    */
 180   static function addOptionValue(&$params, &$groupParams, &$action, &$optionValueID) {
 181     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 182     // checking if the group name with the given id or name (in $groupParams) exists
 183     if (!empty($groupParams)) {
 184       $config = CRM_Core_Config::singleton();
 185       $groupParams['is_active'] = 1;
 186       $optionGroup = CRM_Core_BAO_OptionGroup::retrieve($groupParams, $defaults);
 187     }
 188
 189     // if the corresponding group doesn't exist, create one, provided $groupParams has 'name' in it.
 190     if (!$optionGroup->id) {
 191       if ($groupParams['name']) {
 192         $newOptionGroup   = CRM_Core_BAO_OptionGroup::add($groupParams, $defaults);
 193         $params['weight'] = 1;
 194         $optionGroupID    = $newOptionGroup->id;
 195       }
 196     }
 197     else {
 198       $optionGroupID = $optionGroup->id;
 199       $oldWeight = NULL;
 200       if ($optionValueID) {
 201         $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $optionValueID, 'weight', 'id');
 202       }
 203       $fieldValues = array('option_group_id' => $optionGroupID);
 204       $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Core_DAO_OptionValue', $oldWeight, CRM_Utils_Array::value('weight', $params), $fieldValues);
 205     }
 206     $params['option_group_id'] = $optionGroupID;
 207
 208     if (($action & CRM_Core_Action::ADD) && !CRM_Utils_Array::value('value', $params)) {
 209       $fieldValues = array('option_group_id' => $optionGroupID);
 210       // use the next available value
 211       /* CONVERT(value, DECIMAL) is used to convert varchar
 212                field 'value' to decimal->integer                    */
 213
 214       $params['value'] = (int) CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue',
 215         $fieldValues,
 216         'CONVERT(value, DECIMAL)'
 217       );
 218     }
 219     if (!$params['label'] && $params['name']) {
 220       $params['label'] = $params['name'];
 221     }
 222
 223     // set name to label if it's not set - but *only* for ADD action (CRM-3522)
 224     if (($action & CRM_Core_Action::ADD) && !CRM_Utils_Array::value('name', $params) && $params['label']) {
 225       $params['name'] = $params['label'];
 226     }
 227     if ($action & CRM_Core_Action::UPDATE) {
 228       $ids['optionValue'] = $optionValueID;
 229     }
 230     $optionValue = CRM_Core_BAO_OptionValue::add($params, $ids);
 231     return $optionValue;
 232   }
 233
 234   /**
 235    * Check if there is a record with the same name in the db
 236    *
 237    * @param string $value     the value of the field we are checking
 238    * @param string $daoName   the dao object name
 239    * @param string $daoID     the id of the object being updated. u can change your name
 240    *                          as long as there is no conflict
 241    * @param string $fieldName the name of the field in the DAO
 242    *
 243    * @return boolean     true if object exists
 244    * @access public
 245    * @static
 246    */
 247   static function optionExists($value, $daoName, $daoID, $optionGroupID, $fieldName = 'name') {
 248     $object = new $daoName();
 249     $object->$fieldName = $value;
 250     $object->option_group_id = $optionGroupID;
 251
 252     if ($object->find(TRUE)) {
 253       return ($daoID && $object->id == $daoID) ? TRUE : FALSE;
 254     }
 255     else {
 256       return TRUE;
 257     }
 258   }
 259
 260   /**
 261    * Check if there is a record with the same name in the db
 262    *
 263    * @param string $value     the value of the field we are checking
 264    * @param string $daoName   the dao object name
 265    * @param string $daoID     the id of the object being updated. u can change your name
 266    *                          as long as there is no conflict
 267    * @param string $fieldName the name of the field in the DAO
 268    *
 269    * @return boolean     true if object exists
 270    * @access public
 271    * @static
 272    */
 273   static function getFields($mode = '', $contactType = 'Individual') {
 274     $key = "$mode $contactType";
 275     if (empty(self::$_fields[$key]) || !self::$_fields[$key]) {
 276       self::$_fields[$key] = array();
 277
 278       $option = CRM_Core_DAO_OptionValue::import();
 279
 280       foreach (array_keys($option) as $id) {
 281         $optionName = $option[$id];
 282       }
 283
 284       $nameTitle = array();
 285       if ($mode == 'contribute') {
 286         $nameTitle = array(
 287           'payment_instrument' => array(
 288             'name' => 'payment_instrument',
 289             'title' => ts('Payment Instrument'),
 290             'headerPattern' => '/^payment|(p(ayment\s)?instrument)$/i',
 291           ),
 292         );
 293       }
 294       elseif ($mode == '') {
 295         //the fields email greeting and postal greeting are meant only for Individual and Household
 296         //the field addressee is meant for all contact types, CRM-4575
 297         if (in_array($contactType, array(
 298           'Individual', 'Household', 'Organization', 'All'))) {
 299           $nameTitle = array(
 300             'addressee' => array('name' => 'addressee',
 301               'title' => ts('Addressee'),
 302               'headerPattern' => '/^addressee$/i',
 303             ),
 304           );
 305           $title = array(
 306             'email_greeting' => array('name' => 'email_greeting',
 307               'title' => ts('Email Greeting'),
 308               'headerPattern' => '/^email_greeting$/i',
 309             ),
 310             'postal_greeting' => array(
 311               'name' => 'postal_greeting',
 312               'title' => ts('Postal Greeting'),
 313               'headerPattern' => '/^postal_greeting$/i',
 314             ),
 315           );
 316           $nameTitle = array_merge($nameTitle, $title);
 317         }
 318
 319         if ($contactType == 'Individual' || $contactType == 'All') {
 320           $title = array(
 321             'gender' => array('name' => 'gender',
 322               'title' => ts('Gender'),
 323               'headerPattern' => '/^gender$/i',
 324             ),
 325             'individual_prefix' => array(
 326               'name' => 'individual_prefix',
 327               'title' => ts('Individual Prefix'),
 328               'headerPattern' => '/^(prefix|title)/i',
 329             ),
 330             'individual_suffix' => array(
 331               'name' => 'individual_suffix',
 332               'title' => ts('Individual Suffix'),
 333               'headerPattern' => '/^suffix$/i',
 334             ),
 335           );
 336           $nameTitle = array_merge($nameTitle, $title);
 337         }
 338       }
 339
 340       if (is_array($nameTitle)) {
 341         foreach ($nameTitle as $name => $attribs) {
 342           self::$_fields[$key][$name] = $optionName;
 343           list($tableName, $fieldName) = explode('.', $optionName['where']);
 344           // not sure of this fix, so keeping it commented for now
 345           // this is from CRM-1541
 346           // self::$_fields[$mode][$name]['where'] = $name . '.' . $fieldName;
 347           self::$_fields[$key][$name]['where'] = "{$name}.label";
 348           foreach ($attribs as $k => $val) {
 349             self::$_fields[$key][$name][$k] = $val;
 350           }
 351         }
 352       }
 353     }
 354
 355     return self::$_fields[$key];
 356   }
 357
 358   /**
 359    * build select query in case of option-values
 360    *
 361    * @return void
 362    * @access public
 363    */
 364   static function select(&$query) {
 365     if (!empty($query->_params) || !empty($query->_returnProperties)) {
 366       $field = self::getFields();
 367       foreach ($field as $name => $title) {
 368         list($tableName, $fieldName) = explode('.', $title['where']);
 369         if (CRM_Utils_Array::value($name, $query->_returnProperties)) {
 370           $query->_select["{$name}_id"] = "{$name}.value as {$name}_id";
 371           $query->_element["{$name}_id"] = 1;
 372           $query->_select[$name] = "{$name}.{$fieldName} as $name";
 373           $query->_tables[$tableName] = 1;
 374           $query->_element[$name] = 1;
 375         }
 376       }
 377     }
 378   }
 379
 380   /**
 381    * Function to return option-values of a particular group
 382    *
 383    * @param  array     $groupParams   Array containing group fields
 384    *                                  whose option-values is to retrieved.
 385    * @param  array     $values        (referance) to the array which
 386    *                                  will have the values for the group
 387    * @param  string    $orderBy       for orderBy clause
 388    *
 389    * @param  boolean   $isActive      do you want only active option values?
 390    *
 391    * @return array of option-values
 392    *
 393    * @access public
 394    * @static
 395    */
 396   static function getValues($groupParams, &$values, $orderBy = 'weight', $isActive = FALSE) {
 397     if (empty($groupParams)) {
 398       return NULL;
 399     }
 400     $select = "
 401 SELECT
 402    option_value.id          as id,
 403    option_value.label       as label,
 404    option_value.value       as value,
 405    option_value.name        as name,
 406    option_value.description as description,
 407    option_value.weight      as weight,
 408    option_value.is_active   as is_active,
 409    option_value.is_default  as is_default";
 410
 411     $from = "
 412 FROM
 413    civicrm_option_value  as option_value,
 414    civicrm_option_group  as option_group ";
 415
 416     $where = " WHERE option_group.id = option_value.option_group_id ";
 417
 418     if ($isActive) {
 419       $where .= " AND option_value.is_active = " . $isActive;
 420     }
 421
 422     $order = " ORDER BY " . $orderBy;
 423
 424     $groupId = CRM_Utils_Array::value('id', $groupParams);
 425     $groupName = CRM_Utils_Array::value('name', $groupParams);
 426
 427     if ($groupId) {
 428       $where .= " AND option_group.id = %1";
 429       $params[1] = array($groupId, 'Integer');
 430       if (!$groupName) {
 431         $groupName = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup',
 432           $groupId, 'name', 'id'
 433         );
 434       }
 435     }
 436
 437     if ($groupName) {
 438       $where .= " AND option_group.name = %2";
 439       $params[2] = array($groupName, 'String');
 440     }
 441
 442     if (in_array($groupName, CRM_Core_OptionGroup::$_domainIDGroups)) {
 443       $where .= " AND option_value.domain_id = " . CRM_Core_Config::domainID();
 444     }
 445
 446     $query = $select . $from . $where . $order;
 447
 448     $dao = CRM_Core_DAO::executeQuery($query, $params);
 449
 450     while ($dao->fetch()) {
 451       $values[$dao->id] = array(
 452         'id' => $dao->id,
 453         'label' => $dao->label,
 454         'value' => $dao->value,
 455         'name' => $dao->name,
 456         'description' => $dao->description,
 457         'weight' => $dao->weight,
 458         'is_active' => $dao->is_active,
 459         'is_default' => $dao->is_default,
 460       );
 461     }
 462   }
 463 }
 464