CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Business objects for managing price fields values.
  38  *
  39  */
  40 class CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue {
  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_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
  51    */
  52   public static function &add(&$params, $ids) {
  53
  54     $fieldValueBAO = new CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue();
  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_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
  79    */
  80   public static function create(&$params, $ids) {
  81
  82     if (!is_array($params) || empty($params)) {
  83       return NULL;
  84     }
  85
  86     if ($id = CRM_Utils_Array::value('id', $ids)) {
  87       if (isset($params['name'])) {
  88         unset($params['name']);
  89       }
  90
  91       $oldWeight = NULL;
  92       if ($id) {
  93         $oldWeight = CRM_Core_DAO::getFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $id, 'weight', 'id');
  94       }
  95
  96       $fieldValues = array('price_field_id' => CRM_Utils_Array::value('price_field_id', $params, 0));
  97       $params['weight'] = CRM_Utils_Weight::updateOtherWeights('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $oldWeight, $params['weight'], $fieldValues);
  98     }
  99     else {
 100       if (empty($params['name'])) {
 101         $params['name'] = CRM_Utils_String::munge(CRM_Utils_Array::value('label', $params), '_', 64);
 102       }
 103       if (empty($params['weight'])) {
 104         $params['weight'] = 1;
 105       }
 106     }
 107     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, 0);
 108
 109     return self::add($params, $ids);
 110   }
 111
 112   /**
 113    * Retrieve DB object based on input parameters.
 114    *
 115    * It also stores all the retrieved values in the default array.
 116    *
 117    * @param array $params
 118    *   (reference ) an assoc array.
 119    * @param array $defaults
 120    *   (reference ) an assoc array to hold the flattened values.
 121    *
 122    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
 123    */
 124   public static function retrieve(&$params, &$defaults) {
 125     return CRM_Core_DAO::commonRetrieve('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $params, $defaults);
 126   }
 127
 128   /**
 129    * Retrive the all values for given field id.
 130    *
 131    * @param int $fieldId
 132    *   Price_field_id.
 133    * @param array $values
 134    *   (reference ) to hold the values.
 135    * @param string $orderBy
 136    *   For order by, default weight.
 137    * @param bool|int $isActive is_active, default false
 138    *
 139    * @return array
 140    *
 141    */
 142   public static function getValues($fieldId, &$values, $orderBy = 'weight', $isActive = FALSE) {
 143     $fieldValueDAO = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue();
 144     $fieldValueDAO->price_field_id = $fieldId;
 145     $fieldValueDAO->orderBy($orderBy, 'label');
 146     if ($isActive) {
 147       $fieldValueDAO->is_active = 1;
 148     }
 149     $fieldValueDAO->find();
 150
 151     while ($fieldValueDAO->fetch()) {
 152       CRM_Core_DAO::storeValues($fieldValueDAO, $values[$fieldValueDAO->id]);
 153     }
 154
 155     return $values;
 156   }
 157
 158   /**
 159    * Get the price field option label.
 160    *
 161    * @param int $id
 162    *   Id of field option.
 163    *
 164    * @return string
 165    *   name
 166    *
 167    */
 168   public static function getOptionLabel($id) {
 169     return CRM_Core_DAO::getFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $id, 'label');
 170   }
 171
 172   /**
 173    * Update the is_active flag in the db.
 174    *
 175    * @param int $id
 176    *   Id of the database record.
 177    * @param bool $is_active
 178    *   Value we want to set the is_active field.
 179    *
 180    * @return Object
 181    *   DAO object on sucess, null otherwise
 182    *
 183    */
 184   public static function setIsActive($id, $is_active) {
 185     return CRM_Core_DAO::setFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $id, 'is_active', $is_active);
 186   }
 187
 188   /**
 189    * Delete all values of the given field id.
 190    *
 191    * @param int $fieldId
 192    *   Price field id.
 193    *
 194    * @return bool
 195    *
 196    */
 197   public static function deleteValues($fieldId) {
 198     if (!$fieldId) {
 199       return FALSE;
 200     }
 201
 202     $fieldValueDAO = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue();
 203     $fieldValueDAO->price_field_id = $fieldId;
 204     $fieldValueDAO->delete();
 205   }
 206
 207   /**
 208    * Delete the value.
 209    *
 210    * @param int $id
 211    *   Id.
 212    *
 213    * @return bool
 214    *
 215    */
 216   public static function del($id) {
 217     if (!$id) {
 218       return FALSE;
 219     }
 220
 221     $fieldValueDAO = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue();
 222     $fieldValueDAO->id = $id;
 223     return $fieldValueDAO->delete();
 224   }
 225
 226 }