CRM/Price/BAO/LineItem.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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 INNER JOIN civicrm_participant_payment pp ON ( li.entity_id = pp.participant_id
  99 AND li.entity_table = '{$entityTable}'
 100 AND li.entity_id = {$entityId})";
 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    * @return array of line items
 113    */
 114   static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL , $isQtyZero = TRUE) {
 115     $selectClause = $whereClause = $fromClause = NULL;
 116     $selectClause = "
 117       SELECT    li.id,
 118       li.label,
 119       li.qty,
 120       li.unit_price,
 121       li.line_total,
 122       pf.label as field_title,
 123       pf.html_type,
 124       pfv.membership_type_id,
 125       pfv.membership_num_terms,
 126       li.price_field_id,
 127       li.participant_count,
 128       li.price_field_value_id,
 129       li.financial_type_id,
 130       pfv.description";
 131
 132     $fromClause = "
 133       FROM      civicrm_%2 as %2
 134       LEFT JOIN civicrm_line_item li ON ( li.entity_id = %2.id AND li.entity_table = 'civicrm_%2')
 135       LEFT JOIN civicrm_price_field_value pfv ON ( pfv.id = li.price_field_value_id )
 136       LEFT JOIN civicrm_price_field pf ON (pf.id = li.price_field_id )";
 137     $whereClause = "
 138       WHERE     %2.id = %1";
 139
 140     if ($isQuick) {
 141       $fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
 142       $whereClause .= " and cps.is_quick_config = 0";
 143     }
 144
 145     if (!$isQtyZero) {
 146       $whereClause .= " and li.qty != 0";
 147     }
 148
 149     $lineItems = array();
 150
 151     if (!$entityId || !$entity || !$fromClause) {
 152       return $lineItems;
 153     }
 154
 155     $params = array(
 156       1 => array($entityId, 'Integer'),
 157       2 => array($entity, 'Text'),
 158     );
 159
 160     $dao = CRM_Core_DAO::executeQuery("$selectClause $fromClause $whereClause", $params);
 161     while ($dao->fetch()) {
 162       if (!$dao->id) {
 163         continue;
 164       }
 165       $lineItems[$dao->id] = array(
 166         'qty' => $dao->qty,
 167         'label' => $dao->label,
 168         'unit_price' => $dao->unit_price,
 169         'line_total' => $dao->line_total,
 170         'price_field_id' => $dao->price_field_id,
 171         'participant_count' => $dao->participant_count,
 172         'price_field_value_id' => $dao->price_field_value_id,
 173         'field_title' => $dao->field_title,
 174         'html_type' => $dao->html_type,
 175         'description' => $dao->description,
 176         'entity_id' => $entityId,
 177         'financial_type_id' => $dao->financial_type_id,
 178         'membership_type_id' => $dao->membership_type_id,
 179         'membership_num_terms' => $dao->membership_num_terms,
 180       );
 181     }
 182     return $lineItems;
 183   }
 184
 185   /**
 186    * This method will create the lineItem array required for
 187    * processAmount method
 188    *
 189    * @param  int   $fid       price set field id
 190    * @param  array $params    referance to form values
 191    * @param  array $fields    referance to array of fields belonging
 192    *                          to the price set used for particular event
 193    * @param  array $values    referance to the values array(
 194      this is
 195    *                          lineItem array)
 196    *
 197    * @return void
 198    * @access static
 199    */
 200   static function format($fid, &$params, &$fields, &$values) {
 201     if (empty($params["price_{$fid}"])) {
 202       return;
 203     }
 204
 205     $optionIDs = implode(',', array_keys($params["price_{$fid}"]));
 206
 207     //lets first check in fun parameter,
 208     //since user might modified w/ hooks.
 209     $options = array();
 210     if (array_key_exists('options', $fields)) {
 211       $options = $fields['options'];
 212     }
 213     else {
 214       CRM_Price_BAO_PriceFieldValue::getValues($fid, $options, 'weight', TRUE);
 215     }
 216     $fieldTitle = CRM_Utils_Array::value('label', $fields);
 217     if (!$fieldTitle) {
 218       $fieldTitle = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'label');
 219     }
 220
 221     foreach ($params["price_{$fid}"] as $oid => $qty) {
 222       $price = $options[$oid]['amount'];
 223
 224       // lets clean the price in case it is not yet cleant
 225       // CRM-10974
 226       $price = CRM_Utils_Rule::cleanMoney($price);
 227
 228       $participantsPerField = CRM_Utils_Array::value('count', $options[$oid], 0);
 229
 230       $values[$oid] = array(
 231         'price_field_id' => $fid,
 232         'price_field_value_id' => $oid,
 233         'label' => CRM_Utils_Array::value('label', $options[$oid]),
 234         'field_title' => $fieldTitle,
 235         'description' => CRM_Utils_Array::value('description', $options[$oid]),
 236         'qty' => $qty,
 237         'unit_price' => $price,
 238         'line_total' => $qty * $price,
 239         'participant_count' => $qty * $participantsPerField,
 240         'max_value' => CRM_Utils_Array::value('max_value', $options[$oid]),
 241         'membership_type_id' => CRM_Utils_Array::value('membership_type_id', $options[$oid]),
 242         'membership_num_terms' => CRM_Utils_Array::value('membership_num_terms', $options[$oid]),
 243         'auto_renew' => CRM_Utils_Array::value('auto_renew', $options[$oid]),
 244         'html_type' => $fields['html_type'],
 245         'financial_type_id' => CRM_Utils_Array::value('financial_type_id', $options[$oid]),
 246       );
 247
 248       if ($values[$oid]['membership_type_id'] && !isset($values[$oid]['auto_renew'])) {
 249         $values[$oid]['auto_renew'] = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $values[$oid]['membership_type_id'], 'auto_renew');
 250       }
 251     }
 252   }
 253
 254   /**
 255    * Delete line items for given entity.
 256    *
 257    * @param int $entityId
 258    * @param int $entityTable
 259    *
 260    * @access public
 261    * @static
 262    */
 263   public static function deleteLineItems($entityId, $entityTable) {
 264     if (!$entityId || !$entityTable) {
 265       return FALSE;
 266     }
 267
 268     if ($entityId && !is_array($entityId)) {
 269       $entityId = array($entityId);
 270     }
 271
 272     $query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
 273     $dao = CRM_Core_DAO::executeQuery($query);
 274     return TRUE;
 275   }
 276
 277   /**
 278    * Function to process price set and line items.
 279    * @param int $contributionId contribution id
 280    * @param array $lineItem line item array
 281    * @param object $contributionDetails
 282    * @param decimal $initAmount amount
 283    * @param string $entityTable entity table
 284    *
 285    * @access public
 286    * @return void
 287    * @static
 288    */
 289   static function processPriceSet($entityId, $lineItem, $contributionDetails = NULL, $entityTable = 'civicrm_contribution', $update = FALSE) {
 290     if (!$entityId || !is_array($lineItem)
 291       || CRM_Utils_system::isNull($lineItem)
 292     ) {
 293       return;
 294     }
 295
 296     foreach ($lineItem as $priceSetId => $values) {
 297       if (!$priceSetId) {
 298         continue;
 299       }
 300
 301       foreach ($values as $line) {
 302         $line['entity_table'] = $entityTable;
 303         $line['entity_id'] = $entityId;
 304         // if financial type is not set and if price field value is NOT NULL
 305         // get financial type id of price field value
 306         if (!empty($line['price_field_value_id']) && empty($line['financial_type_id'])) {
 307           $line['financial_type_id'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceFieldValue', $line['price_field_value_id'], 'financial_type_id');
 308         }
 309         $lineItems = CRM_Price_BAO_LineItem::create($line);
 310         if (!$update && $contributionDetails) {
 311           CRM_Financial_BAO_FinancialItem::add($lineItems, $contributionDetails);
 312         }
 313       }
 314     }
 315   }
 316
 317   public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
 318     if (!$entityId || CRM_Utils_System::isNull($amount))
 319       return;
 320
 321     $from = " civicrm_line_item li
 322       LEFT JOIN   civicrm_price_field pf ON pf.id = li.price_field_id
 323       LEFT JOIN   civicrm_price_set ps ON ps.id = pf.price_set_id ";
 324
 325     $set = " li.unit_price = %3,
 326       li.line_total = %3 ";
 327
 328     $where = " li.entity_id = %1 AND
 329       li.entity_table = %2 ";
 330
 331     $params = array(
 332       1 => array($entityId, 'Integer'),
 333       2 => array($entityTable, 'String'),
 334       3 => array($amount, 'Float'),
 335     );
 336
 337     if ($entityTable == 'civicrm_contribution') {
 338       $entityName = 'default_contribution_amount';
 339       $where .= " AND ps.name = %4 ";
 340       $params[4] = array($entityName, 'String');
 341     }
 342     elseif ($entityTable == 'civicrm_participant') {
 343       $from .= "
 344         LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
 345         LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
 346       $set .= " ,li.label = %4,
 347         li.price_field_value_id = cpfv.id ";
 348       $where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
 349       $amount = empty($amount) ? 0: $amount;
 350       $params += array(
 351         4 => array($otherParams['fee_label'], 'String'),
 352         5 => array($otherParams['event_id'], 'String'),
 353       );
 354     }
 355
 356     $query = "
 357       UPDATE $from
 358       SET    $set
 359       WHERE  $where
 360       ";
 361
 362     CRM_Core_DAO::executeQuery($query, $params);
 363   }
 364
 365    /**
 366    * Function to build line items array.
 367    * @param int $params form values
 368    *
 369    * @param string $entityId entity id
 370    *
 371    * @param string $entityTable entity Table
 372    *
 373    * @access public
 374    * @return void
 375    * @static
 376    */
 377   static function getLineItemArray(&$params, $entityId = NULL, $entityTable = 'contribution') {
 378
 379     if (!$entityId) {
 380       $priceSetDetails = CRM_Price_BAO_PriceSet::getDefaultPriceSet();
 381       foreach ($priceSetDetails as $values) {
 382         $params['line_item'][$values['setID']][$values['priceFieldID']] = array(
 383           'price_field_id' => $values['priceFieldID'],
 384           'price_field_value_id' => $values['priceFieldValueID'],
 385           'label' => $values['label'],
 386           'qty' => 1,
 387           'unit_price' => $params['total_amount'],
 388           'line_total' => $params['total_amount'],
 389           'financial_type_id' => $params['financial_type_id']
 390         );
 391       }
 392     }
 393     else {
 394       $setID = NULL;
 395       $totalEntityId = count($entityId);
 396       foreach ($entityId as $id) {
 397         $lineItems = CRM_Price_BAO_LineItem::getLineItems($id, $entityTable);
 398         foreach ($lineItems as $key => $values) {
 399           if (!$setID && $values['price_field_id']) {
 400             $setID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $values['price_field_id'], 'price_set_id');
 401             $params['is_quick_config'] = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'is_quick_config');
 402           }
 403           if (!empty($params['is_quick_config']) && array_key_exists('total_amount', $params)
 404             && $totalEntityId == 1) {
 405             $values['line_total'] = $values['unit_price'] = $params['total_amount'];
 406           }
 407           $values['id'] = $key;
 408           $params['line_item'][$setID][$key] = $values;
 409         }
 410       }
 411     }
 412   }
 413 }