CRM/Upgrade/Snapshot/V4p2/Price/BAO/FieldValue.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_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;
  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    * Takes a bunch of params that are needed to match certain criteria and
 114    * retrieves the relevant objects.
 115    *
 116    * @param array $params
 117    *   (reference ) an assoc array.
 118    * @param array $defaults
 119    *   (reference ) an assoc array to hold the flattened values.
 120    *
 121    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue
 122    */
 123   public static function retrieve(&$params, &$defaults) {
 124     return CRM_Core_DAO::commonRetrieve('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $params, $defaults);
 125   }
 126
 127   /**
 128    * Retrive the all values for given field id
 129    *
 130    * @param int $fieldId
 131    *   Price_field_id.
 132    * @param array $values
 133    *   (reference ) to hold the values.
 134    * @param string $orderBy
 135    *   For order by, default weight.
 136    * @param bool|int $isActive is_active, default false
 137    *
 138    * @return array
 139    *
 140    */
 141   public static function getValues($fieldId, &$values, $orderBy = 'weight', $isActive = FALSE) {
 142     $fieldValueDAO = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue();
 143     $fieldValueDAO->price_field_id = $fieldId;
 144     $fieldValueDAO->orderBy($orderBy, 'label');
 145     if ($isActive) {
 146       $fieldValueDAO->is_active = 1;
 147     }
 148     $fieldValueDAO->find();
 149
 150     while ($fieldValueDAO->fetch()) {
 151       CRM_Core_DAO::storeValues($fieldValueDAO, $values[$fieldValueDAO->id]);
 152     }
 153
 154     return $values;
 155   }
 156
 157   /**
 158    * Get the price field option label.
 159    *
 160    * @param int $id
 161    *   Id of field option.
 162    *
 163    * @return string
 164    *   name
 165    *
 166    */
 167   public static function getOptionLabel($id) {
 168     return CRM_Core_DAO::getFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $id, 'label');
 169   }
 170
 171   /**
 172    * Update the is_active flag in the db
 173    *
 174    * @param int $id
 175    *   Id of the database record.
 176    * @param bool $is_active
 177    *   Value we want to set the is_active field.
 178    *
 179    * @return Object
 180    *   DAO object on sucess, null otherwise
 181    *
 182    */
 183   public static function setIsActive($id, $is_active) {
 184     return CRM_Core_DAO::setFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue', $id, 'is_active', $is_active);
 185   }
 186
 187   /**
 188    * Delete all values of the given field id
 189    *
 190    * @param int $fieldId
 191    *   Price field id.
 192    *
 193    * @return boolean
 194    *
 195    */
 196   public static function deleteValues($fieldId) {
 197     if (!$fieldId) {
 198       return FALSE;
 199     }
 200
 201     $fieldValueDAO = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue();
 202     $fieldValueDAO->price_field_id = $fieldId;
 203     $fieldValueDAO->delete();
 204   }
 205
 206   /**
 207    * Delete the value.
 208    *
 209    * @param int $id
 210    *   Id.
 211    *
 212    * @return boolean
 213    *
 214    */
 215   public static function del($id) {
 216     if (!$id) {
 217       return FALSE;
 218     }
 219
 220     $fieldValueDAO = new CRM_Upgrade_Snapshot_V4p2_Price_DAO_FieldValue();
 221     $fieldValueDAO->id = $id;
 222     return $fieldValueDAO->delete();
 223   }
 224 }