CRM/Price/BAO/LineItem.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  *
  38  * @package CRM
  39  * @author Marshal Newrock <marshal@idealso.com>
  40  * $Id$
  41  */
  42
  43 /**
  44  * Business objects for Line Items generated by monetary transactions
  45  */
  46 class CRM_Price_BAO_LineItem extends CRM_Price_DAO_LineItem {
  47
  48   /**
  49    * Creates a new entry in the database.
  50    *
  51    * @param array $params (reference) an assoc array of name/value pairs
  52    *
  53    * @return object CRM_Price_DAO_LineItem object
  54    * @access public
  55    * @static
  56    */
  57   static function create(&$params) {
  58     //create mode only as we don't support editing line items
  59
  60     CRM_Utils_Hook::pre('create', 'LineItem', $params['entity_id'], $params);
  61
  62     $lineItemBAO = new CRM_Price_BAO_LineItem();
  63     $lineItemBAO->copyValues($params);
  64
  65     $return = $lineItemBAO->save();
  66
  67     CRM_Utils_Hook::post('create', 'LineItem', $params['entity_id'], $params);
  68
  69     return $return;
  70   }
  71
  72   /**
  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.
  77    *
  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
  80    *
  81    * @return object CRM_Price_BAO_LineItem object
  82    * @access public
  83    * @static
  84    */
  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);
  90       return $lineItem;
  91     }
  92     return NULL;
  93   }
  94
  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}
 100 ";
 101     $lineItemTotal = CRM_Core_DAO::singleValueQuery($sqlLineItemTotal);
 102     return $lineItemTotal;
 103   }
 104
 105   /**
 106    * Given a participant id/contribution id,
 107    * return contribution/fee line items
 108    *
 109    * @param $entityId  int    participant/contribution id
 110    * @param $entity    string participant/contribution.
 111    *
 112    * @param null $isQuick
 113    * @param bool $isQtyZero
 114    *
 115    * @return array of line items
 116    */
 117   static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL , $isQtyZero = TRUE) {
 118     $selectClause = $whereClause = $fromClause = NULL;
 119     $selectClause = "
 120       SELECT    li.id,
 121       li.label,
 122       li.qty,
 123       li.unit_price,
 124       li.line_total,
 125       pf.label as field_title,
 126       pf.html_type,
 127       pfv.membership_type_id,
 128       pfv.membership_num_terms,
 129       li.price_field_id,
 130       li.participant_count,
 131       li.price_field_value_id,
 132       li.financial_type_id,
 133       li.tax_amount,
 134       pfv.description";
 135
 136     $fromClause = "
 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 )";
 141     $whereClause = "
 142       WHERE     %2.id = %1";
 143
 144     if ($isQuick) {
 145       $fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
 146       $whereClause .= " and cps.is_quick_config = 0";
 147     }
 148
 149     if (!$isQtyZero) {
 150       $whereClause .= " and li.qty != 0";
 151     }
 152
 153     $lineItems = array();
 154
 155     if (!$entityId || !$entity || !$fromClause) {
 156       return $lineItems;
 157     }
 158
 159     $params = array(
 160       1 => array($entityId, 'Integer'),
 161       2 => array($entity, 'Text'),
 162     );
 163
 164     $dao = CRM_Core_DAO::executeQuery("$selectClause $fromClause $whereClause", $params);
 165     while ($dao->fetch()) {
 166       if (!$dao->id) {
 167         continue;
 168       }
 169       $lineItems[$dao->id] = array(
 170         'qty' => $dao->qty,
 171         'label' => $dao->label,
 172         'unit_price' => $dao->unit_price,
 173         'line_total' => $dao->line_total,
 174         'price_field_id' => $dao->price_field_id,
 175         'participant_count' => $dao->participant_count,
 176         'price_field_value_id' => $dao->price_field_value_id,
 177         'field_title' => $dao->field_title,
 178         'html_type' => $dao->html_type,
 179         'description' => $dao->description,
 180         'entity_id' => $entityId,
 181         'financial_type_id' => $dao->financial_type_id,
 182         'membership_type_id' => $dao->membership_type_id,
 183         'membership_num_terms' => $dao->membership_num_terms,
 184         'tax_amount' => $dao->tax_amount,
 185       );
 186       $lineItems[$dao->id]['tax_rate'] = CRM_Price_BAO_LineItem::calculateTaxRate($lineItems[$dao->id]);
 187       $lineItems[$dao->id]['subTotal'] = $lineItems[$dao->id]['qty'] * $lineItems[$dao->id]['unit_price'];
 188     }
 189     return $lineItems;
 190   }
 191
 192   /**
 193    * This method will create the lineItem array required for
 194    * processAmount method
 195    *
 196    * @param  int   $fid       price set field id
 197    * @param  array $params    referance to form values
 198    * @param  array $fields    referance to array of fields belonging
 199    *                          to the price set used for particular event
 200    * @param  array $values    referance to the values array(
 201      this is
 202    *                          lineItem array)
 203    *
 204    * @return void
 205    * @access static
 206    */
 207   static function format($fid, &$params, &$fields, &$values) {
 208     if (empty($params["price_{$fid}"])) {
 209       return;
 210     }
 211
 212     $optionIDs = implode(',', array_keys($params["price_{$fid}"]));
 213
 214     //lets first check in fun parameter,
 215     //since user might modified w/ hooks.
 216     $options = array();
 217     if (array_key_exists('options', $fields)) {
 218       $options = $fields['options'];
 219     }
 220     else {
 221       CRM_Price_BAO_PriceFieldValue::getValues($fid, $options, 'weight', TRUE);
 222     }
 223     $fieldTitle = CRM_Utils_Array::value('label', $fields);
 224     if (!$fieldTitle) {
 225       $fieldTitle = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'label');
 226     }
 227
 228     foreach ($params["price_{$fid}"] as $oid => $qty) {
 229       $price = $options[$oid]['amount'];
 230
 231       // lets clean the price in case it is not yet cleant
 232       // CRM-10974
 233       $price = CRM_Utils_Rule::cleanMoney($price);
 234
 235       $participantsPerField = CRM_Utils_Array::value('count', $options[$oid], 0);
 236
 237       $values[$oid] = array(
 238         'price_field_id' => $fid,
 239         'price_field_value_id' => $oid,
 240         'label' => CRM_Utils_Array::value('label', $options[$oid]),
 241         'field_title' => $fieldTitle,
 242         'description' => CRM_Utils_Array::value('description', $options[$oid]),
 243         'qty' => $qty,
 244         'unit_price' => $price,
 245         'line_total' => $qty * $price,
 246         'participant_count' => $qty * $participantsPerField,
 247         'max_value' => CRM_Utils_Array::value('max_value', $options[$oid]),
 248         'membership_type_id' => CRM_Utils_Array::value('membership_type_id', $options[$oid]),
 249         'membership_num_terms' => CRM_Utils_Array::value('membership_num_terms', $options[$oid]),
 250         'auto_renew' => CRM_Utils_Array::value('auto_renew', $options[$oid]),
 251         'html_type' => $fields['html_type'],
 252         'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $options[$oid]),
 253       );
 254
 255       if ($values[$oid]['membership_type_id'] && !isset($values[$oid]['auto_renew'])) {
 256         $values[$oid]['auto_renew'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $values[$oid]['membership_type_id'], 'auto_renew');
 257       }
 258     }
 259   }
 260
 261   /**
 262    * Delete line items for given entity.
 263    *
 264    * @param int $entityId
 265    * @param int $entityTable
 266    *
 267    * @return bool
 268    * @access public
 269    * @static
 270    */
 271   public static function deleteLineItems($entityId, $entityTable) {
 272     if (!$entityId || !$entityTable) {
 273       return FALSE;
 274     }
 275
 276     if ($entityId && !is_array($entityId)) {
 277       $entityId = array($entityId);
 278     }
 279
 280     $query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
 281     $dao = CRM_Core_DAO::executeQuery($query);
 282     return TRUE;
 283   }
 284
 285   /**
 286    * Function to process price set and line items.
 287    *
 288    * @param $entityId
 289    * @param array $lineItem line item array
 290    * @param object $contributionDetails
 291    * @param string $entityTable entity table
 292    *
 293    * @param bool $update
 294    *
 295    * @internal param int $contributionId contribution id
 296    * @internal param \decimal $initAmount amount
 297    * @access public
 298    * @return void
 299    * @static
 300    */
 301   static function processPriceSet($entityId, $lineItem, $contributionDetails = NULL, $entityTable = 'civicrm_contribution', $update = FALSE) {
 302     if (!$entityId || !is_array($lineItem)
 303       || CRM_Utils_system::isNull($lineItem)
 304     ) {
 305       return;
 306     }
 307
 308     foreach ($lineItem as $priceSetId => $values) {
 309       if (!$priceSetId) {
 310         continue;
 311       }
 312
 313       foreach ($values as $line) {
 314         $line['entity_table'] = $entityTable;
 315         $line['entity_id'] = $entityId;
 316         // if financial type is not set and if price field value is NOT NULL
 317         // get financial type id of price field value
 318         if (!empty($line['price_field_value_id']) && empty($line['financial_type_id'])) {
 319           $line['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $line['price_field_value_id'], 'financial_type_id');
 320         }
 321         $lineItems = CRM_Price_BAO_LineItem::create($line);
 322         if (!$update && $contributionDetails) {
 323           CRM_Financial_BAO_FinancialItem::add($lineItems, $contributionDetails);
 324           if (isset($contributionDetails->tax_trxn_id) && !empty($contributionDetails->tax_trxn_id)) {
 325             CRM_Financial_BAO_FinancialItem::add($lineItems, $contributionDetails, TRUE);
 326           }
 327         }
 328       }
 329     }
 330   }
 331
 332   public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
 333     if (!$entityId || CRM_Utils_System::isNull($amount))
 334       return;
 335
 336     $from = " civicrm_line_item li
 337       LEFT JOIN   civicrm_price_field pf ON pf.id = li.price_field_id
 338       LEFT JOIN   civicrm_price_set ps ON ps.id = pf.price_set_id ";
 339
 340     $set = " li.unit_price = %3,
 341       li.line_total = %3 ";
 342
 343     $where = " li.entity_id = %1 AND
 344       li.entity_table = %2 ";
 345
 346     $params = array(
 347       1 => array($entityId, 'Integer'),
 348       2 => array($entityTable, 'String'),
 349       3 => array($amount, 'Float'),
 350     );
 351
 352     if ($entityTable == 'civicrm_contribution') {
 353       $entityName = 'default_contribution_amount';
 354       $where .= " AND ps.name = %4 ";
 355       $params[4] = array($entityName, 'String');
 356     }
 357     elseif ($entityTable == 'civicrm_participant') {
 358       $from .= "
 359         LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
 360         LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
 361       $set .= " ,li.label = %4,
 362         li.price_field_value_id = cpfv.id ";
 363       $where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
 364       $amount = empty($amount) ? 0: $amount;
 365       $params += array(
 366         4 => array($otherParams['fee_label'], 'String'),
 367         5 => array($otherParams['event_id'], 'String'),
 368       );
 369     }
 370
 371     $query = "
 372       UPDATE $from
 373       SET    $set
 374       WHERE  $where
 375       ";
 376
 377     CRM_Core_DAO::executeQuery($query, $params);
 378   }
 379
 380    /**
 381    * Function to build line items array.
 382    * @param int $params form values
 383    *
 384    * @param string $entityId entity id
 385    *
 386    * @param string $entityTable entity Table
 387    *
 388    * @access public
 389    * @return void
 390    * @static
 391    */
 392   static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution') {
 393
 394     if (!$entityId) {
 395       $priceSetDetails = CRM_Price_BAO_PriceSet::getDefaultPriceSet();
 396       foreach ($priceSetDetails as $values) {
 397         $params['line_item'][$values['setID']][$values['priceFieldID']] = array(
 398           'price_field_id' => $values['priceFieldID'],
 399           'price_field_value_id' => $values['priceFieldValueID'],
 400           'label' => $values['label'],
 401           'qty' => 1,
 402           'unit_price' => $params['total_amount'],
 403           'line_total' => $params['total_amount'],
 404           'financial_type_id' => $params['financial_type_id']
 405         );
 406       }
 407     }
 408     else {
 409       $setID = NULL;
 410       $totalEntityId = count($entityId);
 411       foreach ($entityId as $id) {
 412         $lineItems = CRM_Price_BAO_LineItem::getLineItems($id, $entityTable);
 413         foreach ($lineItems as $key => $values) {
 414           if (!$setID && $values['price_field_id']) {
 415             $setID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $values['price_field_id'], 'price_set_id');
 416             $params['is_quick_config'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'is_quick_config');
 417           }
 418           if (!empty($params['is_quick_config']) && array_key_exists('total_amount', $params)
 419             && $totalEntityId == 1) {
 420             $values['line_total'] = $values['unit_price'] = $params['total_amount'];
 421           }
 422           $values['id'] = $key;
 423           $params['line_item'][$setID][$key] = $values;
 424         }
 425       }
 426     }
 427   }
 428
 429   /**
 430    * Calculate tax rate in percentage
 431    *
 432    * @param $lineItemId an assoc array of lineItem
 433    *
 434    * @return tax rate
 435    *
 436    * @access public
 437    * @static
 438    */
 439   public static function calculateTaxRate($lineItemId) {
 440     if ($lineItemId['html_type'] == 'Text') {
 441       $tax = (($lineItemId['line_total'] - ($lineItemId['unit_price'] * $lineItemId['qty'])))/($lineItemId['unit_price'] * $lineItemId['qty'])*100;
 442     }
 443     else {
 444       $tax = (($lineItemId['line_total'] - $lineItemId['unit_price'])/$lineItemId['unit_price']) * 100;
 445     }
 446     return $tax;
 447   }
 448 }