3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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_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 object
57 public 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_Upgrade_Snapshot_V4p2_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
79 * (reference ) an assoc array of name/value pairs.
80 * @param array $defaults
81 * (reference ) an assoc array to hold the flattened values.
83 * @return CRM_Upgrade_Snapshot_V4p2_Price_BAO_LineItem object
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);
97 * Given a participant id/contribution id,
98 * return contribution/fee line items
101 * Int participant/contribution id.
103 * String participant/contribution.
105 * @param null $isQuick
107 * @return array of line items
109 public static function getLineItems($entityId, $entity = 'participant', $isQuick = NULL) {
110 $selectClause = $whereClause = $fromClause = NULL;
118 pf.label as field_title,
120 pfv.membership_type_id,
122 li.participant_count,
123 li.price_field_value_id,
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 )";
135 $fromClause .= " LEFT JOIN civicrm_price_set cps on cps.id = pf.price_set_id ";
136 $whereClause .= " and cps.is_quick_config = 0";
138 $lineItems = array();
140 if (!$entityId ||
!$entity ||
!$fromClause) {
145 1 => array($entityId, 'Integer'),
146 2 => array($entity, 'Text'),
149 $dao = CRM_Core_DAO
::executeQuery("$selectClause $fromClause $whereClause", $params);
150 while ($dao->fetch()) {
154 $lineItems[$dao->id
] = array(
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
,
173 * This method will create the lineItem array required for
174 * processAmount method
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(.
190 public static function format($fid, &$params, &$fields, &$values) {
191 if (empty($params["price_{$fid}"])) {
195 $optionIDs = implode(',', array_keys($params["price_{$fid}"]));
197 //lets first check in fun parameter,
198 //since user might modified w/ hooks.
200 if (array_key_exists('options', $fields)) {
201 $options = $fields['options'];
204 CRM_Upgrade_Snapshot_V4p2_Price_BAO_FieldValue
::getValues($fid, $options, 'weight', TRUE);
206 $fieldTitle = CRM_Utils_Array
::value('label', $fields);
208 $fieldTitle = CRM_Core_DAO
::getFieldValue('CRM_Upgrade_Snapshot_V4p2_Price_DAO_Field', $fid, 'label');
211 foreach ($params["price_{$fid}"] as $oid => $qty) {
212 $price = $options[$oid]['amount'];
214 // lets clean the price in case it is not yet cleaned
216 $price = CRM_Utils_Rule
::cleanMoney($price);
218 $participantsPerField = CRM_Utils_Array
::value('count', $options[$oid], 0);
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]),
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'],
239 * Delete line items for given entity.
241 * @param int $entityId
242 * @param int $entityTable
247 public static function deleteLineItems($entityId, $entityTable) {
249 if (!$entityId ||
!$entityTable) {
253 if ($entityId && !is_array($entityId)) {
254 $entityId = array($entityId);
257 $query = "DELETE FROM civicrm_line_item where entity_id IN ('" . implode("','", $entityId) . "') AND entity_table = '$entityTable'";
258 $dao = CRM_Core_DAO
::executeQuery($query);
263 * @param int $entityId
264 * @param string $entityTable
266 * @param array $otherParams
268 public static function syncLineItems($entityId, $entityTable = 'civicrm_contribution', $amount, $otherParams = NULL) {
269 if (!$entityId || CRM_Utils_System
::isNull($amount)) {
273 $from = " civicrm_line_item li
274 LEFT JOIN civicrm_price_field pf ON pf.id = li.price_field_id
275 LEFT JOIN civicrm_price_set ps ON ps.id = pf.price_set_id ";
277 $set = " li.unit_price = %3,
278 li.line_total = %3 ";
280 $where = " li.entity_id = %1 AND
281 li.entity_table = %2 ";
284 1 => array($entityId, 'Integer'),
285 2 => array($entityTable, 'String'),
286 3 => array($amount, 'Float'),
289 if ($entityTable == 'civicrm_contribution') {
290 $entityName = 'default_contribution_amount';
291 $where .= " AND ps.name = %4 ";
292 $params[4] = array($entityName, 'String');
293 } elseif ($entityTable == 'civicrm_participant') {
295 LEFT JOIN civicrm_price_set_entity cpse ON cpse.price_set_id = ps.id
296 LEFT JOIN civicrm_price_field_value cpfv ON cpfv.price_field_id = pf.id and cpfv.label = %4 ";
297 $set .= " ,li.label = %4,
298 li.price_field_value_id = cpfv.id ";
299 $where .= " AND cpse.entity_table = 'civicrm_event' AND cpse.entity_id = %5 ";
300 $amount = empty($amount) ?
0 : $amount;
302 4 => array($otherParams['fee_label'], 'String'),
303 5 => array($otherParams['event_id'], 'String'),
313 CRM_Core_DAO
::executeQuery($query, $params);