CRM/Upgrade/Snapshot/V4p2/Price/BAO/LineItem.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   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_Upgrade_Snapshot_V4p2_Price_BAO_LineItem extends CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem {
  47
  48   /**
  49    * Creates a new entry in the database.
  50    *
  51    * @param array $params
  52    *   (reference) an assoc array of name/value pairs.
  53    *
  54    * @return CRM_Upgrade_Snapshot_V4p2_Price_DAO_LineItem object
  55    * @static
  56    */
  57   public 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_Upgrade_Snapshot_V4p2_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
  79    *   (reference ) an assoc array of name/value pairs.
  80    * @param array $defaults
  81    *   (reference ) an assoc array to hold the flattened values.
  82    *
  83    * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object
  84    * @static
  85    */
  86   public static function retrieve(&$params, &$defaults) {
  87     $lineItem = new CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem();
  88     $lineItem->copyValues($params);
  89     if ($lineItem->find(TRUE)) {
  90       CRM_Core_DAO::storeValues($lineItem, $defaults);
  91       return $lineItem;
  92     }
  93     return NULL;
  94   }
  95
  96   /**
  97    * Given a participant id/contribution id,
  98    * return contribution/fee line items
  99    *
 100    * @param $entityId
 101    *   Int participant/contribution id.
 102    * @param $entity
 103    *   String participant/contribution.
 104    *
 105    * @param null $isQuick
 106    *
 107    * @return array of line items
 108    */
 109   public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) {
 110     $selectClause = $whereClause = $fromClause = NULL;
 111
 112     $selectClause = "
 113 SELECT    li.id,
 114           li.label,
 115           li.qty,
 116           li.unit_price,
 117           li.line_total,
 118           pf.label as field_title,
 119           pf.html_type,
 120           pfv.membership_type_id,
 121           li.price_field_id,
 122           li.participant_count,
 123           li.price_field_value_id,
 124           pfv.description";
 125
 126     $fromClause = "
 127 FROM      civicrm_%2 as %2
 128 LEFT JOIN civicrm_line_item li ON ( li.entity_id = %2.id AND li.entity_table = 'civicrm_%2')
 129 LEFT JOIN civicrm_price_field_value pfv ON ( pfv.id = li.price_field_value_id )
 130 LEFT JOIN civicrm_price_field pf ON (pf.id = li.price_field_id )";
 131     $whereClause = "
 132 WHERE     %2.id = %1";
 133
 134     if ($isQuick) {
 135       $fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
 136       $whereClause .= " and cps.is_quick_config = 0";
 137     }
 138     $lineItems = array();
 139
 140     if (!$entityId || !$entity || !$fromClause) {
 141       return $lineItems;
 142     }
 143
 144     $params = array(
 145       1 => array($entityId, 'Integer'),
 146       2 => array($entity, 'Text'),
 147     );
 148
 149     $dao = CRM_Core_DAO::executeQuery("$selectClause $fromClause $whereClause", $params);
 150     while ($dao->fetch()) {
 151       if (!$dao->id) {
 152         continue;
 153       }
 154       $lineItems[$dao->id] = array(
 155         'qty' => $dao->qty,
 156         'label' => $dao->label,
 157         'unit_price' => $dao->unit_price,
 158         'line_total' => $dao->line_total,
 159         'price_field_id' => $dao->price_field_id,
 160         'participant_count' => $dao->participant_count,
 161         'price_field_value_id' => $dao->price_field_value_id,
 162         'field_title' => $dao->field_title,
 163         'html_type' => $dao->html_type,
 164         'description' => $dao->description,
 165         'entity_id' => $entityId,
 166         'membership_type_id' => $dao->membership_type_id,
 167       );
 168     }
 169     return $lineItems;
 170   }
 171
 172   /**
 173    * This method will create the lineItem array required for
 174    * processAmount method
 175    *
 176    * @param int $fid
 177    *   Price set field id.
 178    * @param array $params
 179    *   Reference to form values.
 180    * @param array $fields
 181    *   Reference to array of fields belonging.
 182    *                          to the price set used for particular event
 183    * @param array $values
 184    *   Reference to the values array(.
 185      this is
 186    *                          lineItem array)
 187    *
 188    * @return void
 189    */
 190   public static function format($fid, &$params, &$fields, &$values) {
 191     if (empty($params["price_{$fid}"])) {
 192       return;
 193     }
 194
 195     $optionIDs = implode(',', array_keys($params["price_{$fid}"]));
 196
 197     //lets first check in fun parameter,
 198     //since user might modified w/ hooks.
 199     $options = array();
 200     if (array_key_exists('options', $fields)) {
 201       $options = $fields['options'];
 202     }
 203     else {
 204       CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue::getValues($fid, $options, 'weight', TRUE);
 205     }
 206     $fieldTitle = CRM_Utils_Array::value('label', $fields);
 207     if (!$fieldTitle) {
 208       $fieldTitle = CRM_Core_DAO::getFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field', $fid, 'label');
 209     }
 210
 211     foreach ($params["price_{$fid}"] as $oid => $qty) {
 212       $price = $options[$oid]['amount'];
 213
 214       // lets clean the price in case it is not yet cleaned
 215       // CRM-10974
 216       $price = CRM_Utils_Rule::cleanMoney($price);
 217
 218       $participantsPerField = CRM_Utils_Array::value('count', $options[$oid], 0);
 219
 220       $values[$oid] = array(
 221         'price_field_id' => $fid,
 222         'price_field_value_id' => $oid,
 223         'label' => CRM_Utils_Array::value('label', $options[$oid]),
 224         'field_title' => $fieldTitle,
 225         'description' => CRM_Utils_Array::value('description', $options[$oid]),
 226         'qty' => $qty,
 227         'unit_price' => $price,
 228         'line_total' => $qty * $price,
 229         'participant_count' => $qty * $participantsPerField,
 230         'max_value' => CRM_Utils_Array::value('max_value', $options[$oid]),
 231         'membership_type_id' => CRM_Utils_Array::value('membership_type_id', $options[$oid]),
 232         'auto_renew' => CRM_Utils_Array::value('auto_renew', $options[$oid]),
 233         'html_type' => $fields['html_type'],
 234       );
 235     }
 236   }
 237
 238   /**
 239    * Delete line items for given entity.
 240    *
 241    * @param int $entityId
 242    * @param int $entityTable
 243    *
 244    * @return bool
 245    * @static
 246    */
 247   public static function deleteLineItems($entityId, $entityTable) {
 248     $result = FALSE;
 249     if (!$entityId || !$entityTable) {
 250       return $result;
 251     }
 252
 253     if ($entityId && !is_array($entityId)) {
 254       $entityId = array($entityId);
 255     }
 256
 257     $query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
 258     $dao = CRM_Core_DAO::executeQuery($query);
 259     return $result;
 260   }
 261
 262   /**
 263    * @param int $entityId
 264    * @param string $entityTable
 265    * @param $amount
 266    * @param array $otherParams
 267    */
 268   public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
 269     if (!$entityId || CRM_Utils_System::isNull($amount))
 270       return;
 271
 272     $from = " civicrm_line_item li
 273 LEFT JOIN   civicrm_price_field pf ON pf.id = li.price_field_id
 274 LEFT JOIN   civicrm_price_set ps ON ps.id = pf.price_set_id ";
 275
 276     $set = " li.unit_price = %3,
 277              li.line_total = %3 ";
 278
 279     $where = " li.entity_id = %1 AND
 280                li.entity_table = %2 ";
 281
 282     $params = array(
 283       1 => array($entityId, 'Integer'),
 284       2 => array($entityTable, 'String'),
 285       3 => array($amount, 'Float'),
 286     );
 287
 288     if ($entityTable == 'civicrm_contribution') {
 289       $entityName = 'default_contribution_amount';
 290       $where .= " AND ps.name = %4 ";
 291       $params[4] = array($entityName, 'String');
 292     } elseif ($entityTable == 'civicrm_participant') {
 293       $from .= "
 294 LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
 295 LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
 296       $set .= " ,li.label = %4,
 297                 li.price_field_value_id = cpfv.id ";
 298       $where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
 299       $amount = empty($amount) ? 0: $amount;
 300       $params += array(
 301         4 => array($otherParams['fee_label'], 'String'),
 302         5 => array($otherParams['event_id'], 'String'),
 303       );
 304     }
 305
 306     $query = "
 307 UPDATE $from
 308 SET    $set
 309 WHERE  $where
 310 ";
 311
 312     CRM_Core_DAO::executeQuery($query, $params);
 313   }
 314 }