3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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 CRM_Price_DAO_PriceFieldValue object
53 static function add(&$params, $ids = array()) {
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 CRM_Price_DAO_PriceFieldValue object
82 static function create(&$params, $ids = array()) {
83 $id = CRM_Utils_Array
::value('id', $params, CRM_Utils_Array
::value('id', $ids));
84 if (!is_array($params) ||
empty($params)) {
87 if(!$id && empty($params['name'])) {
88 $params['name'] = strtolower(CRM_Utils_String
::munge($params['label'], '_', 242));
91 if ($id && !empty($params['weight'])) {
92 if (isset($params['name']))unset($params['name']);
96 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'weight', 'id');
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);
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);
110 return self
::add($params, $ids);
114 * Get defaults for new entity
117 static function getDefaults() {
126 * Takes a bunch of params that are needed to match certain criteria and
127 * retrieves the relevant objects.
129 * @param array $params (reference ) an assoc array
130 * @param array $defaults (reference ) an assoc array to hold the flattened values
132 * @return CRM_Price_DAO_PriceFieldValue object
136 static function retrieve(&$params, &$defaults) {
137 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceFieldValue', $params, $defaults);
141 * Retrive the all values for given field id
143 * @param int $fieldId price_field_id
144 * @param array $values (reference ) to hold the values
145 * @param string $orderBy for order by, default weight
146 * @param bool|int $isActive is_active, default false
148 * @return array $values
153 static function getValues($fieldId, &$values, $orderBy = 'weight', $isActive = FALSE) {
154 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
155 $fieldValueDAO->price_field_id
= $fieldId;
156 $fieldValueDAO->orderBy($orderBy, 'label');
158 $fieldValueDAO->is_active
= 1;
160 $fieldValueDAO->find();
162 while ($fieldValueDAO->fetch()) {
163 CRM_Core_DAO
::storeValues($fieldValueDAO, $values[$fieldValueDAO->id
]);
170 * Get the price field option label.
172 * @param int $id id of field option.
174 * @return string name
180 public static function getOptionLabel($id) {
181 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'label');
185 * Update the is_active flag in the db
187 * @param int $id Id of the database record
188 * @param boolean $is_active Value we want to set the is_active field
190 * @return Object DAO object on sucess, null otherwise
195 static function setIsActive($id, $is_active) {
196 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'is_active', $is_active);
200 * Delete all values of the given field id
202 * @param int $fieldId Price field id
208 static function deleteValues($fieldId) {
213 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
214 $fieldValueDAO->price_field_id
= $fieldId;
215 $fieldValueDAO->delete();
228 static function del($id) {
233 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
234 $fieldValueDAO->id
= $id;
235 return $fieldValueDAO->delete();
239 * Update civicrm_price_field_value.financial_type_id
240 * when financial_type_id of contribution_page or event is changed
242 * @param int $entityId Id
243 * @param String $entityTable entity table
244 * @param String $financialTypeID financial type id
249 static function updateFinancialType($entityId, $entityTable, $financialTypeID) {
250 if (!$entityId ||
!$entityTable ||
!$financialTypeID) {
254 1 => array($entityId, 'Integer'),
255 2 => array($entityTable, 'String'),
256 3 => array($financialTypeID, 'Integer'),
258 // for event discount
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 ';
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
269 SET cpfv.financial_type_id = CASE
270 WHEN cpfv.membership_type_id IS NOT NULL
271 THEN cpfv.financial_type_id
274 cps.financial_type_id = %3
275 WHERE cpse.id IS NOT NULL {$where}";
277 CRM_Core_DAO
::executeQuery($sql, $params);