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
46 * (reference), array $ids.
50 * @return CRM_Price_DAO_PriceFieldValue object
53 public 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
75 * (reference), array $ids.
79 * @return CRM_Price_DAO_PriceFieldValue object
82 public 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'])) {
93 unset($params['name']);
98 $oldWeight = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'weight', 'id');
101 $fieldValues = array('price_field_id' => CRM_Utils_Array
::value('price_field_id', $params, 0));
102 $params['weight'] = CRM_Utils_Weight
::updateOtherWeights('CRM_Price_DAO_PriceFieldValue', $oldWeight, $params['weight'], $fieldValues);
106 CRM_Core_DAO
::setCreateDefaults($params, self
::getDefaults());
107 if (empty($params['name'])) {
108 $params['name'] = CRM_Utils_String
::munge(CRM_Utils_Array
::value('label', $params), '_', 64);
112 return self
::add($params, $ids);
116 * Get defaults for new entity
119 public static function getDefaults() {
128 * Takes a bunch of params that are needed to match certain criteria and
129 * retrieves the relevant objects.
131 * @param array $params
132 * (reference ) an assoc array.
133 * @param array $defaults
134 * (reference ) an assoc array to hold the flattened values.
136 * @return CRM_Price_DAO_PriceFieldValue object
139 public static function retrieve(&$params, &$defaults) {
140 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceFieldValue', $params, $defaults);
144 * Retrive the all values for given field id
146 * @param int $fieldId
148 * @param array $values
149 * (reference ) to hold the values.
150 * @param string $orderBy
151 * For order by, default weight.
152 * @param bool|int $isActive is_active, default false
158 public static function getValues($fieldId, &$values, $orderBy = 'weight', $isActive = FALSE) {
159 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
160 $fieldValueDAO->price_field_id
= $fieldId;
161 $fieldValueDAO->orderBy($orderBy, 'label');
163 $fieldValueDAO->is_active
= 1;
165 $fieldValueDAO->find();
167 while ($fieldValueDAO->fetch()) {
168 CRM_Core_DAO
::storeValues($fieldValueDAO, $values[$fieldValueDAO->id
]);
175 * Get the price field option label.
178 * Id of field option.
185 public static function getOptionLabel($id) {
186 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'label');
190 * Update the is_active flag in the db
193 * Id of the database record.
194 * @param bool $is_active
195 * Value we want to set the is_active field.
198 * DAO object on sucess, null otherwise
202 public static function setIsActive($id, $is_active) {
203 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceFieldValue', $id, 'is_active', $is_active);
207 * Delete all values of the given field id
209 * @param int $fieldId
215 public static function deleteValues($fieldId) {
220 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
221 $fieldValueDAO->price_field_id
= $fieldId;
222 $fieldValueDAO->delete();
235 public static function del($id) {
240 $fieldValueDAO = new CRM_Price_DAO_PriceFieldValue();
241 $fieldValueDAO->id
= $id;
242 return $fieldValueDAO->delete();
246 * Update civicrm_price_field_value.financial_type_id
247 * when financial_type_id of contribution_page or event is changed
249 * @param int $entityId
251 * @param string $entityTableEntity table.
253 * @param string $financialTypeIDFinancial type id.
258 public static function updateFinancialType($entityId, $entityTable, $financialTypeID) {
259 if (!$entityId ||
!$entityTable ||
!$financialTypeID) {
263 1 => array($entityId, 'Integer'),
264 2 => array($entityTable, 'String'),
265 3 => array($financialTypeID, 'Integer'),
267 // for event discount
269 if ($entityTable == 'civicrm_event') {
270 $join = " LEFT JOIN civicrm_discount cd ON cd.price_set_id = cps.id AND cd.entity_id = %1 AND cd.entity_table = %2 ";
271 $where = ' OR cd.id IS NOT NULL ';
273 $sql = "UPDATE civicrm_price_set cps
274 LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = cps.id AND cpse.entity_id = %1 AND cpse.entity_table = %2
275 LEFT JOIN civicrm_price_field cpf ON cpf.price_set_id = cps.id
276 LEFT JOIN civicrm_price_field_value cpfv ON cpf.id = cpfv.price_field_id
278 SET cpfv.financial_type_id = CASE
279 WHEN cpfv.membership_type_id IS NOT NULL
280 THEN cpfv.financial_type_id
283 cps.financial_type_id = %3
284 WHERE cpse.id IS NOT NULL {$where}";
286 CRM_Core_DAO
::executeQuery($sql, $params);