CRM/Price/BAO/PriceFieldValue.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Business objects for managing price fields values.
  38  *
  39  */
  40 class CRM_Price_BAO_PriceFieldValue extends CRM_Price_DAO_PriceFieldValue {
  41
  42   /**
  43    * Insert/update a new entry in the database.
  44    *
  45    * @param array $params
  46    *   (reference), array $ids.
  47    *
  48    * @param $ids
  49    *
  50    * @return CRM_Price_DAO_PriceFieldValue
  51    */
  52   public static function add(&$params, $ids = array()) {
  53
  54     $fieldValueBAO = new CRM_Price_BAO_PriceFieldValue();
  55     $fieldValueBAO->copyValues($params);
  56
  57     if ($id = CRM_Utils_Array::value('id', $ids)) {
  58       $fieldValueBAO->id = $id;
  59     }
  60     if (!empty($params['is_default'])) {
  61       $query = 'UPDATE civicrm_price_field_value SET is_default = 0 WHERE  price_field_id = %1';
  62       $p = array(1 => array($params['price_field_id'], 'Integer'));
  63       CRM_Core_DAO::executeQuery($query, $p);
  64     }
  65
  66     $fieldValueBAO->save();
  67     return $fieldValueBAO;
  68   }
  69
  70   /**
  71    * Creates a new entry in the database.
  72    *
  73    * @param array $params
  74    *   (reference), array $ids.
  75    *
  76    * @param $ids
  77    *
  78    * @return CRM_Price_DAO_PriceFieldValue
  79    */
  80   public static function create(&$params, $ids = array()) {
  81     $id = CRM_Utils_Array::value('id', $params, CRM_Utils_Array::value('id', $ids));
  82     if (!is_array($params) || empty($params)) {
  83       return NULL;
  84     }
  85     if (!$id && empty($params['name'])) {
  86       $params['name'] = strtolower(CRM_Utils_String::munge($params['label'], '_', 242));
  87     }
  88
  89     if ($id && !empty($params['weight'])) {
  90       if (isset($params['name'])) {
  91         unset($params['name']);
  92       }
  93
  94       $oldWeight = NULL;
  95       if ($id) {
  96         $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'weight', 'id');
  97       }
  98
  99       $fieldValues = array('price_field_id' => CRM_Utils_Array::value('price_field_id', $params, 0));
 100       $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Price_DAO_PriceFieldValue', $oldWeight, $params['weight'], $fieldValues);
 101     }
 102     else {
 103       if (!$id) {
 104         CRM_Core_DAO::setCreateDefaults($params, self::getDefaults());
 105         if (empty($params['name'])) {
 106           $params['name'] = CRM_Utils_String::munge(CRM_Utils_Array::value('label', $params), '_', 64);
 107         }
 108       }
 109     }
 110     return self::add($params, $ids);
 111   }
 112
 113   /**
 114    * Get defaults for new entity
 115    * @return array
 116    */
 117   public static function getDefaults() {
 118     return array(
 119       'is_active' => 1,
 120       'weight' => 1,
 121     );
 122
 123   }
 124
 125   /**
 126    * Takes a bunch of params that are needed to match certain criteria and
 127    * retrieves the relevant objects.
 128    *
 129    * @param array $params
 130    *   (reference ) an assoc array.
 131    * @param array $defaults
 132    *   (reference ) an assoc array to hold the flattened values.
 133    *
 134    * @return CRM_Price_DAO_PriceFieldValue
 135    */
 136   public static function retrieve(&$params, &$defaults) {
 137     return CRM_Core_DAO::commonRetrieve('CRM_Price_DAO_PriceFieldValue', $params, $defaults);
 138   }
 139
 140   /**
 141    * Retrive the all values for given field id
 142    *
 143    * @param int $fieldId
 144    *   Price_field_id.
 145    * @param array $values
 146    *   (reference ) to hold the values.
 147    * @param string $orderBy
 148    *   For order by, default weight.
 149    * @param bool|int $isActive is_active, default false
 150    *
 151    * @return array
 152    *
 153    */
 154   public static function getValues($fieldId, &$values, $orderBy = 'weight', $isActive = FALSE) {
 155     $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
 156     $fieldValueDAO->price_field_id = $fieldId;
 157     $fieldValueDAO->orderBy($orderBy, 'label');
 158     if ($isActive) {
 159       $fieldValueDAO->is_active = 1;
 160     }
 161     $fieldValueDAO->find();
 162
 163     while ($fieldValueDAO->fetch()) {
 164       CRM_Core_DAO::storeValues($fieldValueDAO, $values[$fieldValueDAO->id]);
 165     }
 166
 167     return $values;
 168   }
 169
 170   /**
 171    * Get the price field option label.
 172    *
 173    * @param int $id
 174    *   Id of field option.
 175    *
 176    * @return string
 177    *   name
 178    *
 179    */
 180   public static function getOptionLabel($id) {
 181     return CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'label');
 182   }
 183
 184   /**
 185    * Update the is_active flag in the db
 186    *
 187    * @param int $id
 188    *   Id of the database record.
 189    * @param bool $is_active
 190    *   Value we want to set the is_active field.
 191    *
 192    * @return Object
 193    *   DAO object on sucess, null otherwise
 194    *
 195    */
 196   public static function setIsActive($id, $is_active) {
 197     return CRM_Core_DAO::setFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'is_active', $is_active);
 198   }
 199
 200   /**
 201    * Delete all values of the given field id
 202    *
 203    * @param int $fieldId
 204    *   Price field id.
 205    *
 206    *
 207    */
 208   public static function deleteValues($fieldId) {
 209     if (!$fieldId) {
 210       return;
 211     }
 212
 213     $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
 214     $fieldValueDAO->price_field_id = $fieldId;
 215     $fieldValueDAO->delete();
 216   }
 217
 218   /**
 219    * Delete the value.
 220    *
 221    * @param int $id
 222    *   Id.
 223    *
 224    * @return bool
 225    *
 226    */
 227   public static function del($id) {
 228     if (!$id) {
 229       return FALSE;
 230     }
 231
 232     $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
 233     $fieldValueDAO->id = $id;
 234     return $fieldValueDAO->delete();
 235   }
 236
 237   /**
 238    * Update civicrm_price_field_value.financial_type_id
 239    * when financial_type_id of contribution_page or event is changed
 240    *
 241    * @param int $entityId
 242    *   Id.
 243    * @param string $entityTable table.
 244    *   Entity table.
 245    * @param string $financialTypeID type id.
 246    *   Financial type id.
 247    *
 248    */
 249   public static function updateFinancialType($entityId, $entityTable, $financialTypeID) {
 250     if (!$entityId || !$entityTable || !$financialTypeID) {
 251       return;
 252     }
 253     $params = array(
 254       1 => array($entityId, 'Integer'),
 255       2 => array($entityTable, 'String'),
 256       3 => array($financialTypeID, 'Integer'),
 257     );
 258     // for event discount
 259     $join = $where = '';
 260     if ($entityTable == 'civicrm_event') {
 261       $join = " LEFT JOIN civicrm_discount cd ON cd.price_set_id = cps.id AND cd.entity_id = %1  AND cd.entity_table = %2 ";
 262       $where = ' OR cd.id IS NOT NULL ';
 263     }
 264     $sql = "UPDATE civicrm_price_set cps
 265 LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = cps.id AND cpse.entity_id = %1 AND cpse.entity_table = %2
 266 LEFT JOIN civicrm_price_field cpf ON cpf.price_set_id = cps.id
 267 LEFT JOIN civicrm_price_field_value cpfv ON cpf.id = cpfv.price_field_id
 268 {$join}
 269 SET cpfv.financial_type_id = CASE
 270   WHEN cpfv.membership_type_id IS NOT NULL
 271   THEN cpfv.financial_type_id
 272   ELSE %3
 273 END,
 274 cps.financial_type_id = %3
 275 WHERE cpse.id IS NOT NULL {$where}";
 276
 277     CRM_Core_DAO::executeQuery($sql, $params);
 278   }
 279 }