CRM/Core/BAO/CustomOption.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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-2019
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Business objects for managing custom data options.
  38  *
  39  */
  40 class CRM_Core_BAO_CustomOption {
  41
  42   /**
  43    * Fetch object based on array of properties.
  44    *
  45    * @param array $params
  46    *   (reference ) an assoc array of name/value pairs.
  47    * @param array $defaults
  48    *   (reference ) an assoc array to hold the flattened values.
  49    *
  50    * @return CRM_Core_BAO_CustomOption
  51    */
  52   public static function retrieve(&$params, &$defaults) {
  53     $customOption = new CRM_Core_DAO_OptionValue();
  54     $customOption->copyValues($params);
  55     if ($customOption->find(TRUE)) {
  56       CRM_Core_DAO::storeValues($customOption, $defaults);
  57       return $customOption;
  58     }
  59     return NULL;
  60   }
  61
  62   /**
  63    * Returns all active options ordered by weight for a given field.
  64    *
  65    * @param int $fieldID
  66    *   Field whose options are needed.
  67    * @param bool $inactiveNeeded Do we need inactive options ?.
  68    *   Do we need inactive options ?.
  69    *
  70    * @return array
  71    *   all active options for fieldId
  72    */
  73   public static function getCustomOption(
  74     $fieldID,
  75     $inactiveNeeded = FALSE
  76   ) {
  77     $options = array();
  78     if (!$fieldID) {
  79       return $options;
  80     }
  81
  82     $optionValues = CRM_Core_PseudoConstant::get('CRM_Core_BAO_CustomField', 'custom_' . $fieldID, array(), $inactiveNeeded ? 'get' : 'create');
  83
  84     foreach ((array) $optionValues as $value => $label) {
  85       $options[] = array(
  86         'label' => $label,
  87         'value' => $value,
  88       );
  89     }
  90
  91     return $options;
  92   }
  93
  94   /**
  95    * Wrapper for ajax option selector.
  96    *
  97    * @param array $params
  98    *   Associated array for params record id.
  99    *
 100    * @return array
 101    *   associated array of option list
 102    *   -rp = rowcount
 103    *   -page= offset
 104    */
 105   static public function getOptionListSelector(&$params) {
 106     $options = array();
 107
 108     $field = CRM_Core_BAO_CustomField::getFieldObject($params['fid']);
 109     $defVal = CRM_Utils_Array::explodePadded($field->default_value);
 110
 111     // format the params
 112     $params['offset'] = ($params['page'] - 1) * $params['rp'];
 113     $params['rowCount'] = $params['rp'];
 114
 115     if (!$field->option_group_id) {
 116       return $options;
 117     }
 118     $queryParams = array(1 => array($field->option_group_id, 'Integer'));
 119     $total = "SELECT COUNT(*) FROM civicrm_option_value WHERE option_group_id = %1";
 120     $params['total'] = CRM_Core_DAO::singleValueQuery($total, $queryParams);
 121
 122     $limit = " LIMIT {$params['offset']}, {$params['rowCount']} ";
 123     $orderBy = ' ORDER BY options.weight asc';
 124
 125     $query = "SELECT * FROM civicrm_option_value as options WHERE option_group_id = %1 {$orderBy} {$limit}";
 126     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
 127     $links = CRM_Custom_Page_Option::actionLinks();
 128
 129     $fields = array('id', 'label', 'value');
 130     $config = CRM_Core_Config::singleton();
 131     while ($dao->fetch()) {
 132       $options[$dao->id] = array();
 133       foreach ($fields as $k) {
 134         $options[$dao->id][$k] = $dao->$k;
 135       }
 136       $action = array_sum(array_keys($links));
 137       $class = 'crm-entity';
 138       // update enable/disable links depending on custom_field properties.
 139       if ($dao->is_active) {
 140         $action -= CRM_Core_Action::ENABLE;
 141       }
 142       else {
 143         $class .= ' disabled';
 144         $action -= CRM_Core_Action::DISABLE;
 145       }
 146
 147       $isGroupLocked = (bool) CRM_Core_DAO::getFieldValue(
 148         CRM_Core_DAO_OptionGroup::class,
 149         $field->option_group_id,
 150         'is_locked'
 151       );
 152
 153       // disable deletion of option values for locked option groups
 154       if (($action & CRM_Core_Action::DELETE) && $isGroupLocked) {
 155         $action -= CRM_Core_Action::DELETE;
 156       }
 157
 158       if (in_array($field->html_type, ['CheckBox', 'Multi-Select'])) {
 159         if (isset($defVal) && in_array($dao->value, $defVal)) {
 160           $options[$dao->id]['is_default'] = '<img src="' . $config->resourceBase . 'i/check.gif" />';
 161         }
 162         else {
 163           $options[$dao->id]['is_default'] = '';
 164         }
 165       }
 166       else {
 167         if ($field->default_value == $dao->value) {
 168           $options[$dao->id]['is_default'] = '<img src="' . $config->resourceBase . 'i/check.gif" />';
 169         }
 170         else {
 171           $options[$dao->id]['is_default'] = '';
 172         }
 173       }
 174       $options[$dao->id]['description'] = $dao->description;
 175       $options[$dao->id]['class'] = $dao->id . ',' . $class;
 176       $options[$dao->id]['is_active'] = empty($dao->is_active) ? ts('No') : ts('Yes');
 177       $options[$dao->id]['links'] = CRM_Core_Action::formLink($links,
 178           $action,
 179           array(
 180             'id' => $dao->id,
 181             'fid' => $params['fid'],
 182             'gid' => $params['gid'],
 183           ),
 184           ts('more'),
 185           FALSE,
 186           'customOption.row.actions',
 187           'customOption',
 188           $dao->id
 189         );
 190     }
 191
 192     return $options;
 193   }
 194
 195   /**
 196    * Delete Option.
 197    *
 198    * @param $optionId integer
 199    *   option id
 200    *
 201    */
 202   public static function del($optionId) {
 203     // get the customFieldID
 204     $query = "
 205 SELECT f.id as id, f.data_type as dataType
 206 FROM   civicrm_option_value v,
 207        civicrm_option_group g,
 208        civicrm_custom_field f
 209 WHERE  v.id    = %1
 210 AND    g.id    = f.option_group_id
 211 AND    g.id    = v.option_group_id";
 212     $params = array(1 => array($optionId, 'Integer'));
 213     $dao = CRM_Core_DAO::executeQuery($query, $params);
 214     if ($dao->fetch()) {
 215       if (in_array($dao->dataType,
 216         array('Int', 'Float', 'Money', 'Boolean')
 217       )) {
 218         $value = 0;
 219       }
 220       else {
 221         $value = '';
 222       }
 223       $params = array(
 224         'optionId' => $optionId,
 225         'fieldId' => $dao->id,
 226         'value' => $value,
 227       );
 228       // delete this value from the tables
 229       self::updateCustomValues($params);
 230
 231       // also delete this option value
 232       $query = "
 233 DELETE
 234 FROM   civicrm_option_value
 235 WHERE  id = %1";
 236       $params = array(1 => array($optionId, 'Integer'));
 237       CRM_Core_DAO::executeQuery($query, $params);
 238     }
 239   }
 240
 241   /**
 242    * @param array $params
 243    *
 244    * @throws Exception
 245    */
 246   public static function updateCustomValues($params) {
 247     $optionDAO = new CRM_Core_DAO_OptionValue();
 248     $optionDAO->id = $params['optionId'];
 249     $optionDAO->find(TRUE);
 250     $oldValue = $optionDAO->value;
 251
 252     // get the table, column, html_type and data type for this field
 253     $query = "
 254 SELECT g.table_name  as tableName ,
 255        f.column_name as columnName,
 256        f.data_type   as dataType,
 257        f.html_type   as htmlType
 258 FROM   civicrm_custom_group g,
 259        civicrm_custom_field f
 260 WHERE  f.custom_group_id = g.id
 261   AND  f.id = %1";
 262     $queryParams = array(1 => array($params['fieldId'], 'Integer'));
 263     $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
 264     if ($dao->fetch()) {
 265       if ($dao->dataType == 'Money') {
 266         $params['value'] = CRM_Utils_Rule::cleanMoney($params['value']);
 267       }
 268       switch ($dao->htmlType) {
 269         case 'Autocomplete-Select':
 270         case 'Select':
 271         case 'Radio':
 272           $query = "
 273 UPDATE {$dao->tableName}
 274 SET    {$dao->columnName} = %1
 275 WHERE  id = %2";
 276           if ($dao->dataType == 'Auto-complete') {
 277             $dataType = "String";
 278           }
 279           else {
 280             $dataType = $dao->dataType;
 281           }
 282           $queryParams = array(
 283             1 => array(
 284               $params['value'],
 285               $dataType,
 286             ),
 287             2 => array(
 288               $params['optionId'],
 289               'Integer',
 290             ),
 291           );
 292           break;
 293
 294         case 'Multi-Select':
 295         case 'CheckBox':
 296           $oldString = CRM_Core_DAO::VALUE_SEPARATOR . $oldValue . CRM_Core_DAO::VALUE_SEPARATOR;
 297           $newString = CRM_Core_DAO::VALUE_SEPARATOR . $params['value'] . CRM_Core_DAO::VALUE_SEPARATOR;
 298           $query = "
 299 UPDATE {$dao->tableName}
 300 SET    {$dao->columnName} = REPLACE( {$dao->columnName}, %1, %2 )";
 301           $queryParams = array(
 302             1 => array($oldString, 'String'),
 303             2 => array($newString, 'String'),
 304           );
 305           break;
 306
 307         default:
 308           CRM_Core_Error::fatal();
 309       }
 310       $dao = CRM_Core_DAO::executeQuery($query, $queryParams);
 311     }
 312   }
 313
 314   /**
 315    * When changing the value of an option this is called to update all corresponding custom data
 316    *
 317    * @param int $optionId
 318    * @param string $newValue
 319    */
 320   public static function updateValue($optionId, $newValue) {
 321     $optionValue = new CRM_Core_DAO_OptionValue();
 322     $optionValue->id = $optionId;
 323     $optionValue->find(TRUE);
 324     $oldValue = $optionValue->value;
 325     if ($oldValue == $newValue) {
 326       return;
 327     }
 328
 329     $customField = new CRM_Core_DAO_CustomField();
 330     $customField->option_group_id = $optionValue->option_group_id;
 331     $customField->find();
 332     while ($customField->fetch()) {
 333       $customGroup = new CRM_Core_DAO_CustomGroup();
 334       $customGroup->id = $customField->custom_group_id;
 335       $customGroup->find(TRUE);
 336       if (CRM_Core_BAO_CustomField::isSerialized($customField)) {
 337         $params = array(
 338           1 => array(CRM_Utils_Array::implodePadded($oldValue), 'String'),
 339           2 => array(CRM_Utils_Array::implodePadded($newValue), 'String'),
 340           3 => array('%' . CRM_Utils_Array::implodePadded($oldValue) . '%', 'String'),
 341         );
 342       }
 343       else {
 344         $params = array(
 345           1 => array($oldValue, 'String'),
 346           2 => array($newValue, 'String'),
 347           3 => array($oldValue, 'String'),
 348         );
 349       }
 350       $sql = "UPDATE `{$customGroup->table_name}` SET `{$customField->column_name}` = REPLACE(`{$customField->column_name}`, %1, %2) WHERE `{$customField->column_name}` LIKE %3";
 351       $customGroup->free();
 352       CRM_Core_DAO::executeQuery($sql, $params);
 353     }
 354     $customField->free();
 355   }
 356
 357 }