3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
39 * @author Marshal Newrock <marshal@idealso.com>
44 * Business objects for Line Items generated by monetary transactions
46 class CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem
extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem
{
49 * Creates a new entry in the database.
51 * @param array $params
52 * (reference) an assoc array of name/value pairs.
54 * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem
56 public static function create(&$params) {
57 //create mode only as we don't support editing line items
59 CRM_Utils_Hook
::pre('create', 'LineItem', $params['entity_id'], $params);
61 $lineItemBAO = new CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem();
62 $lineItemBAO->copyValues($params);
64 $return = $lineItemBAO->save();
66 CRM_Utils_Hook
::post('create', 'LineItem', $params['entity_id'], $params);
72 * Retrieve DB object based on input parameters.
74 * It also stores all the retrieved values in the default array.
76 * @param array $params
77 * (reference ) an assoc array of name/value pairs.
78 * @param array $defaults
79 * (reference ) an assoc array to hold the flattened values.
81 * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem
83 public static function retrieve(&$params, &$defaults) {
84 $lineItem = new CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem();
85 $lineItem->copyValues($params);
86 if ($lineItem->find(TRUE)) {
87 CRM_Core_DAO
::storeValues($lineItem, $defaults);
94 * Given a participant id/contribution id,
95 * return contribution/fee line items
97 * @param int $entityId
98 * participant/contribution id.
99 * @param string $entity
100 * participant/contribution.
102 * @param null $isQuick
105 * Array of line items
107 public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) {
108 $selectClause = $whereClause = $fromClause = NULL;
116 pf.label as field_title,
118 pfv.membership_type_id,
120 li.participant_count,
121 li.price_field_value_id,
125 FROM civicrm_%2 as %2
126 LEFT JOIN civicrm_line_item li ON ( li.entity_id = %2.id AND li.entity_table = 'civicrm_%2')
127 LEFT JOIN civicrm_price_field_value pfv ON ( pfv.id = li.price_field_value_id )
128 LEFT JOIN civicrm_price_field pf ON (pf.id = li.price_field_id )";
133 $fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
134 $whereClause .= " and cps.is_quick_config = 0";
136 $lineItems = array();
138 if (!$entityId ||
!$entity ||
!$fromClause) {
143 1 => array($entityId, 'Integer'),
144 2 => array($entity, 'Text'),
147 $dao = CRM_Core_DAO
::executeQuery("$selectClause $fromClause $whereClause", $params);
148 while ($dao->fetch()) {
152 $lineItems[$dao->id
] = array(
154 'label' => $dao->label
,
155 'unit_price' => $dao->unit_price
,
156 'line_total' => $dao->line_total
,
157 'price_field_id' => $dao->price_field_id
,
158 'participant_count' => $dao->participant_count
,
159 'price_field_value_id' => $dao->price_field_value_id
,
160 'field_title' => $dao->field_title
,
161 'html_type' => $dao->html_type
,
162 'description' => $dao->description
,
163 'entity_id' => $entityId,
164 'membership_type_id' => $dao->membership_type_id
,
171 * This method will create the lineItem array required for.
172 * processAmount method
175 * Price set field id.
176 * @param array $params
177 * Reference to form values.
178 * @param array $fields
179 * Reference to array of fields belonging.
180 * to the price set used for particular event
181 * @param array $values
182 * Reference to the values array(.
183 * this is lineItem array)
185 public static function format($fid, &$params, &$fields, &$values) {
186 if (empty($params["price_{$fid}"])) {
190 $optionIDs = implode(',', array_keys($params["price_{$fid}"]));
192 //lets first check in fun parameter,
193 //since user might modified w/ hooks.
195 if (array_key_exists('options', $fields)) {
196 $options = $fields['options'];
199 CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue
::getValues($fid, $options, 'weight', TRUE);
201 $fieldTitle = CRM_Utils_Array
::value('label', $fields);
203 $fieldTitle = CRM_Core_DAO
::getFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field', $fid, 'label');
206 foreach ($params["price_{$fid}"] as $oid => $qty) {
207 $price = $options[$oid]['amount'];
209 // lets clean the price in case it is not yet cleaned
211 $price = CRM_Utils_Rule
::cleanMoney($price);
213 $participantsPerField = CRM_Utils_Array
::value('count', $options[$oid], 0);
215 $values[$oid] = array(
216 'price_field_id' => $fid,
217 'price_field_value_id' => $oid,
218 'label' => CRM_Utils_Array
::value('label', $options[$oid]),
219 'field_title' => $fieldTitle,
220 'description' => CRM_Utils_Array
::value('description', $options[$oid]),
222 'unit_price' => $price,
223 'line_total' => $qty * $price,
224 'participant_count' => $qty * $participantsPerField,
225 'max_value' => CRM_Utils_Array
::value('max_value', $options[$oid]),
226 'membership_type_id' => CRM_Utils_Array
::value('membership_type_id', $options[$oid]),
227 'auto_renew' => CRM_Utils_Array
::value('auto_renew', $options[$oid]),
228 'html_type' => $fields['html_type'],
234 * Delete line items for given entity.
236 * @param int $entityId
237 * @param int $entityTable
241 public static function deleteLineItems($entityId, $entityTable) {
243 if (!$entityId ||
!$entityTable) {
247 if ($entityId && !is_array($entityId)) {
248 $entityId = array($entityId);
251 $query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
252 $dao = CRM_Core_DAO
::executeQuery($query);
257 * @param int $entityId
258 * @param string $entityTable
260 * @param array $otherParams
262 public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
263 if (!$entityId || CRM_Utils_System
::isNull($amount)) {
267 $from = " civicrm_line_item li
268 LEFT JOIN civicrm_price_field pf ON pf.id = li.price_field_id
269 LEFT JOIN civicrm_price_set ps ON ps.id = pf.price_set_id ";
271 $set = " li.unit_price = %3,
272 li.line_total = %3 ";
274 $where = " li.entity_id = %1 AND
275 li.entity_table = %2 ";
278 1 => array($entityId, 'Integer'),
279 2 => array($entityTable, 'String'),
280 3 => array($amount, 'Float'),
283 if ($entityTable == 'civicrm_contribution') {
284 $entityName = 'default_contribution_amount';
285 $where .= " AND ps.name = %4 ";
286 $params[4] = array($entityName, 'String');
288 elseif ($entityTable == 'civicrm_participant') {
290 LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
291 LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
292 $set .= " ,li.label = %4,
293 li.price_field_value_id = cpfv.id ";
294 $where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
295 $amount = empty($amount) ?
0 : $amount;
297 4 => array($otherParams['fee_label'], 'String'),
298 5 => array($otherParams['event_id'], 'String'),
308 CRM_Core_DAO
::executeQuery($query, $params);