CRM/Core/BAO/OptionGroup.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_BAO_OptionGroup extends CRM_Core_DAO_OptionGroup {
  36
  37   /**
  38    * class constructor
  39    */
  40   function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Takes a bunch of params that are needed to match certain criteria and
  46    * retrieves the relevant objects. Typically the valid params are only
  47    * contact_id. We'll tweak this function to be more full featured over a period
  48    * of time. This is the inverse function of create. It also stores all the retrieved
  49    * values in the default array
  50    *
  51    * @param array $params   (reference ) an assoc array of name/value pairs
  52    * @param array $defaults (reference ) an assoc array to hold the flattened values
  53    *
  54    * @return object CRM_Core_BAO_OptionGroup object
  55    * @access public
  56    * @static
  57    */
  58   static function retrieve(&$params, &$defaults) {
  59     $optionGroup = new CRM_Core_DAO_OptionGroup();
  60     $optionGroup->copyValues($params);
  61     if ($optionGroup->find(TRUE)) {
  62       CRM_Core_DAO::storeValues($optionGroup, $defaults);
  63       return $optionGroup;
  64     }
  65     return NULL;
  66   }
  67
  68   /**
  69    * update the is_active flag in the db
  70    *
  71    * @param int      $id        id of the database record
  72    * @param boolean  $is_active value we want to set the is_active field
  73    *
  74    * @return Object             DAO object on sucess, null otherwise
  75    * @static
  76    */
  77   static function setIsActive($id, $is_active) {
  78     return CRM_Core_DAO::setFieldValue('CRM_Core_DAO_OptionGroup', $id, 'is_active', $is_active);
  79   }
  80
  81   /**
  82    * function to add the Option Group
  83    *
  84    * @param array $params reference array contains the values submitted by the form
  85    * @param array $ids    reference array contains the id
  86    *
  87    * @access public
  88    * @static
  89    *
  90    * @return object
  91    */
  92   static function add(&$params, &$ids) {
  93     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
  94     $params['is_default'] = CRM_Utils_Array::value('is_default', $params, FALSE);
  95
  96     // action is taken depending upon the mode
  97     $optionGroup = new CRM_Core_DAO_OptionGroup();
  98     $optionGroup->copyValues($params);;
  99
 100     if ($params['is_default']) {
 101       $query = "UPDATE civicrm_option_group SET is_default = 0";
 102       CRM_Core_DAO::executeQuery($query);
 103     }
 104
 105     $optionGroup->id = CRM_Utils_Array::value('optionGroup', $ids);
 106     $optionGroup->save();
 107     return $optionGroup;
 108   }
 109
 110   /**
 111    * Function to delete Option Group
 112    *
 113    * @param  int  $optionGroupId     Id of the Option Group to be deleted.
 114    *
 115    * @return void
 116    *
 117    * @access public
 118    * @static
 119    */
 120   static function del($optionGroupId) {
 121     // need to delete all option value field before deleting group
 122     $optionValue = new CRM_Core_DAO_OptionValue();
 123     $optionValue->option_group_id = $optionGroupId;
 124     $optionValue->delete();
 125
 126     $optionGroup = new CRM_Core_DAO_OptionGroup();
 127     $optionGroup->id = $optionGroupId;
 128     $optionGroup->delete();
 129   }
 130
 131   /**
 132    * Function to get title of the option group
 133    *
 134    * @param  int  $optionGroupId     Id of the Option Group.
 135    *
 136    * @return String title
 137    *
 138    * @access public
 139    * @static
 140    */
 141   static function getTitle($optionGroupId) {
 142     $optionGroup = new CRM_Core_DAO_OptionGroup();
 143     $optionGroup->id = $optionGroupId;
 144     $optionGroup->find(TRUE);
 145     return $optionGroup->name;
 146   }
 147
 148   /**
 149    * Function to copy the option group and values
 150    *
 151    * @param  String $component      - component page for which custom
 152    *                                  option group and values need to be copied
 153    * @param  int    $fromId         - component page id on which
 154    *                                  basis copy is to be made
 155    * @param  int    $toId           - component page id to be copied onto
 156    * @param  int    $defaultId      - default custom value id on the
 157    *                                  component page
 158    * @param  String $discountSuffix - discount suffix for the discounted
 159    *                                  option group
 160    *
 161    * @return int   $id              - default custom value id for the
 162    *                                 copied component page
 163    *
 164    * @access public
 165    * @static
 166    */
 167   static function copyValue($component, $fromId, $toId, $defaultId = FALSE, $discountSuffix = NULL) {
 168     $page = '_page';
 169     if ($component == 'event') {
 170       //fix for CRM-3391.
 171       //as for event we remove 'page' from group name.
 172       $page = NULL;
 173     }
 174     elseif ($component == 'price') {
 175       $page = '_field';
 176     }
 177
 178     $fromGroupName = 'civicrm_' . $component . $page . '.amount.' . $fromId . $discountSuffix;
 179     $toGroupName = 'civicrm_' . $component . $page . '.amount.' . $toId . $discountSuffix;
 180
 181     $optionGroupId = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup',
 182       $fromGroupName,
 183       'id',
 184       'name'
 185     );
 186     if ($optionGroupId) {
 187       $copyOptionGroup = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_OptionGroup',
 188         array('name' => $fromGroupName),
 189         array('name' => $toGroupName)
 190       );
 191
 192       $copyOptionValue = &CRM_Core_DAO::copyGeneric('CRM_Core_DAO_OptionValue',
 193         array('option_group_id' => $optionGroupId),
 194         array('option_group_id' => $copyOptionGroup->id)
 195       );
 196
 197       if ($discountSuffix) {
 198         $copyDiscount =& CRM_Core_DAO::copyGeneric( 'CRM_Core_DAO_Discount',
 199           array(
 200             'entity_id' => $fromId,
 201             'entity_table' => 'civicrm_' . $component,
 202             'option_group_id' => $optionGroupId,
 203           ),
 204           array(
 205             'entity_id' => $toId,
 206             'option_group_id' => $copyOptionGroup->id,
 207           )
 208         );
 209       }
 210
 211       if ($defaultId) {
 212         $query = "
 213 SELECT second.id default_id
 214 FROM civicrm_option_value first, civicrm_option_value second
 215 WHERE second.option_group_id =%1
 216 AND first.option_group_id =%2
 217 AND first.weight = second.weight
 218 AND first.id =%3
 219 ";
 220         $params = array(1 => array($copyOptionGroup->id, 'Int'),
 221           2 => array($optionGroupId, 'Int'),
 222           3 => array($defaultId, 'Int'),
 223         );
 224
 225         $dao = CRM_Core_DAO::executeQuery($query, $params);
 226
 227         while ($dao->fetch()) {
 228           $id = $dao->default_id;
 229         }
 230         return $id;
 231       }
 232       return FALSE;
 233     }
 234   }
 235 }
 236