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
39 * @author Marshal Newrock <marshal@idealso.com>
44 * Business objects for Line Items generated by monetary transactions
46 class CRM_Price_BAO_LineItem
extends CRM_Price_DAO_LineItem
{
49 * Creates a new entry in the database.
51 * @param array $params (reference) an assoc array of name/value pairs
53 * @return object CRM_Price_DAO_LineItem object
57 static function create(&$params) {
58 //create mode only as we don't support editing line items
60 CRM_Utils_Hook
::pre('create', 'LineItem', $params['entity_id'], $params);
62 $lineItemBAO = new CRM_Price_BAO_LineItem();
63 $lineItemBAO->copyValues($params);
65 $return = $lineItemBAO->save();
67 CRM_Utils_Hook
::post('create', 'LineItem', $params['entity_id'], $params);
73 * Takes a bunch of params that are needed to match certain criteria and
74 * retrieves the relevant objects. Typically, the valid params are only
75 * price_field_id. This is the inverse function of create. It also
76 * stores all of the retrieved values in the default array.
78 * @param array $params (reference ) an assoc array of name/value pairs
79 * @param array $defaults (reference ) an assoc array to hold the flattened values
81 * @return object CRM_Price_BAO_LineItem object
85 static function retrieve(&$params, &$defaults) {
86 $lineItem = new CRM_Price_BAO_LineItem();
87 $lineItem->copyValues($params);
88 if ($lineItem->find(TRUE)) {
89 CRM_Core_DAO
::storeValues($lineItem, $defaults);
95 static function getLineTotal($entityId, $entityTable) {
96 $sqlLineItemTotal = "SELECT SUM(li.line_total)
97 FROM civicrm_line_item li
98 WHERE li.entity_table = '{$entityTable}'
99 AND li.entity_id = {$entityId}
101 $lineItemTotal = CRM_Core_DAO
::singleValueQuery($sqlLineItemTotal);
102 return $lineItemTotal;
106 * Given a participant id/contribution id,
107 * return contribution/fee line items
109 * @param $entityId int participant/contribution id
110 * @param $entity string participant/contribution.
112 * @param null $isQuick
113 * @param bool $isQtyZero
115 * @return array of line items
117 static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL , $isQtyZero = TRUE) {
118 $selectClause = $whereClause = $fromClause = NULL;
125 pf.label as field_title,
127 pfv.membership_type_id,
128 pfv.membership_num_terms,
130 li.participant_count,
131 li.price_field_value_id,
132 li.financial_type_id,
137 FROM civicrm_%2 as %2
138 LEFT JOIN civicrm_line_item li ON ( li.entity_id = %2.id AND li.entity_table = 'civicrm_%2')
139 LEFT JOIN civicrm_price_field_value pfv ON ( pfv.id = li.price_field_value_id )
140 LEFT JOIN civicrm_price_field pf ON (pf.id = li.price_field_id )";
145 $fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
146 $whereClause .= " and cps.is_quick_config = 0";
150 $whereClause .= " and li.qty != 0";
153 $lineItems = array();
155 if (!$entityId ||
!$entity ||
!$fromClause) {
160 1 => array($entityId, 'Integer'),
161 2 => array($entity, 'Text'),
164 $dao = CRM_Core_DAO
::executeQuery("$selectClause $fromClause $whereClause", $params);
165 $getTaxDetails = FALSE;
166 while ($dao->fetch()) {
170 $lineItems[$dao->id
] = array(
172 'label' => $dao->label
,
173 'unit_price' => $dao->unit_price
,
174 'line_total' => $dao->line_total
,
175 'price_field_id' => $dao->price_field_id
,
176 'participant_count' => $dao->participant_count
,
177 'price_field_value_id' => $dao->price_field_value_id
,
178 'field_title' => $dao->field_title
,
179 'html_type' => $dao->html_type
,
180 'description' => $dao->description
,
181 'entity_id' => $entityId,
182 'financial_type_id' => $dao->financial_type_id
,
183 'membership_type_id' => $dao->membership_type_id
,
184 'membership_num_terms' => $dao->membership_num_terms
,
185 'tax_amount' => $dao->tax_amount
,
187 $lineItems[$dao->id
]['tax_rate'] = CRM_Price_BAO_LineItem
::calculateTaxRate($lineItems[$dao->id
]);
188 $lineItems[$dao->id
]['subTotal'] = $lineItems[$dao->id
]['qty'] * $lineItems[$dao->id
]['unit_price'];
189 if ($lineItems[$dao->id
]['tax_amount'] != '') {
190 $getTaxDetails = TRUE;
193 $smarty = CRM_Core_Smarty
::singleton();
194 $smarty->assign('getTaxDetails', $getTaxDetails);
199 * This method will create the lineItem array required for
200 * processAmount method
202 * @param int $fid price set field id
203 * @param array $params referance to form values
204 * @param array $fields referance to array of fields belonging
205 * to the price set used for particular event
206 * @param array $values referance to the values array(
213 static function format($fid, &$params, &$fields, &$values) {
214 if (empty($params["price_{$fid}"])) {
218 $optionIDs = implode(',', array_keys($params["price_{$fid}"]));
220 //lets first check in fun parameter,
221 //since user might modified w/ hooks.
223 if (array_key_exists('options', $fields)) {
224 $options = $fields['options'];
227 CRM_Price_BAO_PriceFieldValue
::getValues($fid, $options, 'weight', TRUE);
229 $fieldTitle = CRM_Utils_Array
::value('label', $fields);
231 $fieldTitle = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'label');
234 foreach ($params["price_{$fid}"] as $oid => $qty) {
235 $price = $options[$oid]['amount'];
237 // lets clean the price in case it is not yet cleant
239 $price = CRM_Utils_Rule
::cleanMoney($price);
241 $participantsPerField = CRM_Utils_Array
::value('count', $options[$oid], 0);
243 $values[$oid] = array(
244 'price_field_id' => $fid,
245 'price_field_value_id' => $oid,
246 'label' => CRM_Utils_Array
::value('label', $options[$oid]),
247 'field_title' => $fieldTitle,
248 'description' => CRM_Utils_Array
::value('description', $options[$oid]),
250 'unit_price' => $price,
251 'line_total' => $qty * $price,
252 'participant_count' => $qty * $participantsPerField,
253 'max_value' => CRM_Utils_Array
::value('max_value', $options[$oid]),
254 'membership_type_id' => CRM_Utils_Array
::value('membership_type_id', $options[$oid]),
255 'membership_num_terms' => CRM_Utils_Array
::value('membership_num_terms', $options[$oid]),
256 'auto_renew' => CRM_Utils_Array
::value('auto_renew', $options[$oid]),
257 'html_type' => $fields['html_type'],
258 'financial_type_id' => CRM_Utils_Array
::value('financial_type_id', $options[$oid]),
261 if ($values[$oid]['membership_type_id'] && !isset($values[$oid]['auto_renew'])) {
262 $values[$oid]['auto_renew'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $values[$oid]['membership_type_id'], 'auto_renew');
268 * Delete line items for given entity.
270 * @param int $entityId
271 * @param int $entityTable
277 public static function deleteLineItems($entityId, $entityTable) {
278 if (!$entityId ||
!$entityTable) {
282 if ($entityId && !is_array($entityId)) {
283 $entityId = array($entityId);
286 $query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
287 $dao = CRM_Core_DAO
::executeQuery($query);
292 * Function to process price set and line items.
295 * @param array $lineItem line item array
296 * @param object $contributionDetails
297 * @param string $entityTable entity table
299 * @param bool $update
301 * @internal param int $contributionId contribution id
302 * @internal param \decimal $initAmount amount
307 static function processPriceSet($entityId, $lineItem, $contributionDetails = NULL, $entityTable = 'civicrm_contribution', $update = FALSE) {
308 if (!$entityId ||
!is_array($lineItem)
309 || CRM_Utils_system
::isNull($lineItem)
314 foreach ($lineItem as $priceSetId => $values) {
319 foreach ($values as $line) {
320 $line['entity_table'] = $entityTable;
321 $line['entity_id'] = $entityId;
322 // if financial type is not set and if price field value is NOT NULL
323 // get financial type id of price field value
324 if (!empty($line['price_field_value_id']) && empty($line['financial_type_id'])) {
325 $line['financial_type_id'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceFieldValue', $line['price_field_value_id'], 'financial_type_id');
327 $lineItems = CRM_Price_BAO_LineItem
::create($line);
328 if (!$update && $contributionDetails) {
329 CRM_Financial_BAO_FinancialItem
::add($lineItems, $contributionDetails);
330 if (isset($contributionDetails->tax_trxn_id
) && !empty($contributionDetails->tax_trxn_id
)) {
331 CRM_Financial_BAO_FinancialItem
::add($lineItems, $contributionDetails, TRUE);
338 public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
339 if (!$entityId || CRM_Utils_System
::isNull($amount))
342 $from = " civicrm_line_item li
343 LEFT JOIN civicrm_price_field pf ON pf.id = li.price_field_id
344 LEFT JOIN civicrm_price_set ps ON ps.id = pf.price_set_id ";
346 $set = " li.unit_price = %3,
347 li.line_total = %3 ";
349 $where = " li.entity_id = %1 AND
350 li.entity_table = %2 ";
353 1 => array($entityId, 'Integer'),
354 2 => array($entityTable, 'String'),
355 3 => array($amount, 'Float'),
358 if ($entityTable == 'civicrm_contribution') {
359 $entityName = 'default_contribution_amount';
360 $where .= " AND ps.name = %4 ";
361 $params[4] = array($entityName, 'String');
363 elseif ($entityTable == 'civicrm_participant') {
365 LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
366 LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
367 $set .= " ,li.label = %4,
368 li.price_field_value_id = cpfv.id ";
369 $where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
370 $amount = empty($amount) ?
0: $amount;
372 4 => array($otherParams['fee_label'], 'String'),
373 5 => array($otherParams['event_id'], 'String'),
383 CRM_Core_DAO
::executeQuery($query, $params);
387 * Function to build line items array.
388 * @param int $params form values
390 * @param string $entityId entity id
392 * @param string $entityTable entity Table
398 static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution') {
401 $priceSetDetails = CRM_Price_BAO_PriceSet
::getDefaultPriceSet();
402 foreach ($priceSetDetails as $values) {
403 $params['line_item'][$values['setID']][$values['priceFieldID']] = array(
404 'price_field_id' => $values['priceFieldID'],
405 'price_field_value_id' => $values['priceFieldValueID'],
406 'label' => $values['label'],
408 'unit_price' => $params['total_amount'],
409 'line_total' => $params['total_amount'],
410 'financial_type_id' => $params['financial_type_id']
416 $totalEntityId = count($entityId);
417 foreach ($entityId as $id) {
418 $lineItems = CRM_Price_BAO_LineItem
::getLineItems($id, $entityTable);
419 foreach ($lineItems as $key => $values) {
420 if (!$setID && $values['price_field_id']) {
421 $setID = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $values['price_field_id'], 'price_set_id');
422 $params['is_quick_config'] = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'is_quick_config');
424 if (!empty($params['is_quick_config']) && array_key_exists('total_amount', $params)
425 && $totalEntityId == 1) {
426 $values['line_total'] = $values['unit_price'] = $params['total_amount'];
428 $values['id'] = $key;
429 $params['line_item'][$setID][$key] = $values;
436 * Calculate tax rate in percentage
438 * @param $lineItemId an assoc array of lineItem
445 public static function calculateTaxRate($lineItemId) {
446 if ($lineItemId['html_type'] == 'Text') {
447 $tax = (($lineItemId['line_total'] - ($lineItemId['unit_price'] * $lineItemId['qty'])))/($lineItemId['unit_price'] * $lineItemId['qty'])*100;
450 $tax = (($lineItemId['line_total'] - $lineItemId['unit_price'])/$lineItemId['unit_price']) * 100;