3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Business objects for managing price fields values.
40 class CRM_Price_BAO_PriceFieldValue
extends CRM_Price_DAO_PriceFieldValue
{
43 * insert/update a new entry in the database.
45 * @param array $params (reference), array $ids
49 * @return object CRM_Price_DAO_PriceFieldValue object
53 static function &add(&$params, $ids) {
55 $fieldValueBAO = new CRM_Price_BAO_PriceFieldValue();
56 $fieldValueBAO->copyValues($params);
58 if ($id = CRM_Utils_Array
::value('id', $ids)) {
59 $fieldValueBAO->id
= $id;
61 if (!empty($params['is_default'])) {
62 $query = 'UPDATE civicrm_price_field_value SET is_default = 0 WHERE price_field_id = %1';
63 $p = array(1 => array($params['price_field_id'], 'Integer'));
64 CRM_Core_DAO
::executeQuery($query, $p);
67 $fieldValueBAO->save();
68 return $fieldValueBAO;
72 * Creates a new entry in the database.
74 * @param array $params (reference), array $ids
78 * @return object CRM_Price_DAO_PriceFieldValue object
82 static function create(&$params, $ids) {
84 if (!is_array($params) ||
empty($params)) {
88 if ($id = CRM_Utils_Array
::value('id', $ids)) {
89 if (isset($params['name']))unset($params['name']);
93 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'weight', 'id');
96 $fieldValues = array('price_field_id' => CRM_Utils_Array
::value('price_field_id', $params, 0));
97 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Price_DAO_PriceFieldValue', $oldWeight, $params['weight'], $fieldValues);
100 if (empty($params['name'])) {
101 $params['name'] = CRM_Utils_String
::munge(CRM_Utils_Array
::value('label', $params), '_', 64);
103 if (empty($params['weight'])) {
104 $params['weight'] = 1;
107 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, 0);
109 return self
::add($params, $ids);
113 * Takes a bunch of params that are needed to match certain criteria and
114 * retrieves the relevant objects.
116 * @param array $params (reference ) an assoc array
117 * @param array $defaults (reference ) an assoc array to hold the flattened values
119 * @return object CRM_Price_DAO_PriceFieldValue object
123 static function retrieve(&$params, &$defaults) {
124 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceFieldValue', $params, $defaults);
128 * Retrive the all values for given field id
130 * @param int $fieldId price_field_id
131 * @param array $values (reference ) to hold the values
132 * @param string $orderBy for order by, default weight
133 * @param bool|int $isActive is_active, default false
135 * @return array $values
140 static function getValues($fieldId, &$values, $orderBy = 'weight', $isActive = FALSE) {
141 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
142 $fieldValueDAO->price_field_id
= $fieldId;
143 $fieldValueDAO->orderBy($orderBy, 'label');
145 $fieldValueDAO->is_active
= 1;
147 $fieldValueDAO->find();
149 while ($fieldValueDAO->fetch()) {
150 CRM_Core_DAO
::storeValues($fieldValueDAO, $values[$fieldValueDAO->id
]);
157 * Get the price field option label.
159 * @param int $id id of field option.
161 * @return string name
167 public static function getOptionLabel($id) {
168 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'label');
172 * update the is_active flag in the db
174 * @param int $id Id of the database record
175 * @param boolean $is_active Value we want to set the is_active field
177 * @return Object DAO object on sucess, null otherwise
182 static function setIsActive($id, $is_active) {
183 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'is_active', $is_active);
187 * delete all values of the given field id
189 * @param int $fieldId Price field id
196 static function deleteValues($fieldId) {
201 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
202 $fieldValueDAO->price_field_id
= $fieldId;
203 $fieldValueDAO->delete();
216 static function del($id) {
221 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
222 $fieldValueDAO->id
= $id;
223 return $fieldValueDAO->delete();
227 * Update civicrm_price_field_value.financial_type_id
228 * when financial_type_id of contribution_page or event is changed
230 * @param int $entityId Id
231 * @param String $entityTable entity table
232 * @param String $financialTypeID financial type id
238 static function updateFinancialType($entityId, $entityTable, $financialTypeID) {
239 if (!$entityId ||
!$entityTable ||
!$financialTypeID) {
243 1 => array($entityId, 'Integer'),
244 2 => array($entityTable, 'String'),
245 3 => array($financialTypeID, 'Integer'),
247 // for event discount
249 if ($entityTable == 'civicrm_event') {
250 $join = " LEFT JOIN civicrm_discount cd ON cd.price_set_id = cps.id AND cd.entity_id = %1 AND cd.entity_table = %2 ";
251 $where = ' OR cd.id IS NOT NULL ';
253 $sql = "UPDATE civicrm_price_set cps
254 LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = cps.id AND cpse.entity_id = %1 AND cpse.entity_table = %2
255 LEFT JOIN civicrm_price_field cpf ON cpf.price_set_id = cps.id
256 LEFT JOIN civicrm_price_field_value cpfv ON cpf.id = cpfv.price_field_id
258 SET cpfv.financial_type_id = CASE
259 WHEN cpfv.membership_type_id IS NOT NULL
260 THEN cpfv.financial_type_id
263 cps.financial_type_id = %3
264 WHERE cpse.id IS NOT NULL {$where}";
266 CRM_Core_DAO
::executeQuery($sql, $params);