3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
37 * Business object for managing price sets
40 class CRM_Price_BAO_PriceSet
extends CRM_Price_DAO_PriceSet
{
43 * Static field for default price set details.
47 static $_defaultPriceSet = NULL;
52 public function __construct() {
53 parent
::__construct();
57 * Takes an associative array and creates a price set object.
59 * @param array $params
60 * (reference) an assoc array of name/value pairs.
62 * @return CRM_Price_DAO_PriceSet
64 public static function create(&$params) {
65 if (empty($params['id']) && empty($params['name'])) {
66 $params['name'] = CRM_Utils_String
::munge($params['title'], '_', 242);
68 if (!empty($params['extends']) && is_array($params['extends'])) {
69 $params['extends'] = CRM_Utils_Array
::implodePadded($params['extends']);
71 $priceSetBAO = new CRM_Price_BAO_PriceSet();
72 $priceSetBAO->copyValues($params);
73 if (self
::eventPriceSetDomainID()) {
74 $priceSetBAO->domain_id
= CRM_Core_Config
::domainID();
76 return $priceSetBAO->save();
80 * Fetch object based on array of properties.
82 * @param array $params
83 * (reference ) an assoc array of name/value pairs.
84 * @param array $defaults
85 * (reference ) an assoc array to hold the flattened values.
87 * @return CRM_Price_DAO_PriceSet
89 public static function retrieve(&$params, &$defaults) {
90 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceSet', $params, $defaults);
94 * Update the is_active flag in the db.
97 * Id of the database record.
100 * @internal param bool $is_active value we want to set the is_active field
103 * DAO object on sucess, null otherwise
105 public static function setIsActive($id, $isActive) {
106 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceSet', $id, 'is_active', $isActive);
110 * Calculate the default price set id
111 * assigned to the contribution/membership etc
113 * @param string $entity
119 public static function getDefaultPriceSet($entity = 'contribution') {
120 if (!empty(self
::$_defaultPriceSet[$entity])) {
121 return self
::$_defaultPriceSet[$entity];
123 $entityName = 'default_contribution_amount';
124 if ($entity == 'membership') {
125 $entityName = 'default_membership_type_amount';
129 SELECT ps.id AS setID, pfv.price_field_id AS priceFieldID, pfv.id AS priceFieldValueID, pfv.name, pfv.label, pfv.membership_type_id, pfv.amount, pfv.financial_type_id
130 FROM civicrm_price_set ps
131 LEFT JOIN civicrm_price_field pf ON pf.`price_set_id` = ps.id
132 LEFT JOIN civicrm_price_field_value pfv ON pfv.price_field_id = pf.id
133 WHERE ps.name = '{$entityName}'
136 $dao = CRM_Core_DAO
::executeQuery($sql);
137 self
::$_defaultPriceSet[$entity] = array();
138 while ($dao->fetch()) {
139 self
::$_defaultPriceSet[$entity][$dao->priceFieldValueID
] = array(
140 'setID' => $dao->setID
,
141 'priceFieldID' => $dao->priceFieldID
,
142 'name' => $dao->name
,
143 'label' => $dao->label
,
144 'priceFieldValueID' => $dao->priceFieldValueID
,
145 'membership_type_id' => $dao->membership_type_id
,
146 'amount' => $dao->amount
,
147 'financial_type_id' => $dao->financial_type_id
,
151 return self
::$_defaultPriceSet[$entity];
155 * Get the price set title.
164 public static function getTitle($id) {
165 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $id, 'title');
169 * Return a list of all forms which use this price set.
173 * @param bool|string $simpleReturn - get raw data. Possible values: 'entity', 'table'
177 public static function &getUsedBy($id, $simpleReturn = FALSE) {
178 $usedBy = $forms = $tables = array();
180 SELECT entity_table, entity_id
181 FROM civicrm_price_set_entity
182 WHERE price_set_id = %1";
183 $params = array(1 => array($id, 'Integer'));
184 $crmFormDAO = CRM_Core_DAO
::executeQuery($queryString, $params);
186 while ($crmFormDAO->fetch()) {
187 $forms[$crmFormDAO->entity_table
][] = $crmFormDAO->entity_id
;
188 $tables[] = $crmFormDAO->entity_table
;
190 // Return only tables
191 if ($simpleReturn == 'table') {
196 SELECT cli.entity_table, cli.entity_id
197 FROM civicrm_line_item cli
198 LEFT JOIN civicrm_price_field cpf ON cli.price_field_id = cpf.id
199 WHERE cpf.price_set_id = %1";
200 $params = array(1 => array($id, 'Integer'));
201 $crmFormDAO = CRM_Core_DAO
::executeQuery($queryString, $params);
202 while ($crmFormDAO->fetch()) {
203 $forms[$crmFormDAO->entity_table
][] = $crmFormDAO->entity_id
;
204 $tables[] = $crmFormDAO->entity_table
;
210 // Return only entity data
211 if ($simpleReturn == 'entity') {
214 foreach ($forms as $table => $entities) {
216 case 'civicrm_event':
217 $ids = implode(',', $entities);
218 $queryString = "SELECT ce.id as id, ce.title as title, ce.is_public as isPublic, ce.start_date as startDate, ce.end_date as endDate, civicrm_option_value.label as eventType, ce.is_template as isTemplate, ce.template_title as templateTitle
219 FROM civicrm_event ce
220 LEFT JOIN civicrm_option_value ON
221 ( ce.event_type_id = civicrm_option_value.value )
222 LEFT JOIN civicrm_option_group ON
223 ( civicrm_option_group.id = civicrm_option_value.option_group_id )
225 civicrm_option_group.name = 'event_type' AND
228 $crmDAO = CRM_Core_DAO
::executeQuery($queryString);
229 while ($crmDAO->fetch()) {
230 if ($crmDAO->isTemplate
) {
231 $usedBy['civicrm_event_template'][$crmDAO->id
]['title'] = $crmDAO->templateTitle
;
232 $usedBy['civicrm_event_template'][$crmDAO->id
]['eventType'] = $crmDAO->eventType
;
233 $usedBy['civicrm_event_template'][$crmDAO->id
]['isPublic'] = $crmDAO->isPublic
;
236 $usedBy[$table][$crmDAO->id
]['title'] = $crmDAO->title
;
237 $usedBy[$table][$crmDAO->id
]['eventType'] = $crmDAO->eventType
;
238 $usedBy[$table][$crmDAO->id
]['startDate'] = $crmDAO->startDate
;
239 $usedBy[$table][$crmDAO->id
]['endDate'] = $crmDAO->endDate
;
240 $usedBy[$table][$crmDAO->id
]['isPublic'] = $crmDAO->isPublic
;
245 case 'civicrm_contribution_page':
246 $ids = implode(',', $entities);
247 $queryString = "SELECT cp.id as id, cp.title as title, cp.start_date as startDate, cp.end_date as endDate,ct.name as type
248 FROM civicrm_contribution_page cp, civicrm_financial_type ct
249 WHERE ct.id = cp.financial_type_id AND
252 $crmDAO = CRM_Core_DAO
::executeQuery($queryString);
253 while ($crmDAO->fetch()) {
254 $usedBy[$table][$crmDAO->id
]['title'] = $crmDAO->title
;
255 $usedBy[$table][$crmDAO->id
]['type'] = $crmDAO->type
;
256 $usedBy[$table][$crmDAO->id
]['startDate'] = $crmDAO->startDate
;
257 $usedBy[$table][$crmDAO->id
]['endDate'] = $crmDAO->endDate
;
261 case 'civicrm_contribution':
262 case 'civicrm_membership':
263 case 'civicrm_participant':
268 CRM_Core_Error
::fatal("$table is not supported in PriceSet::usedBy()");
277 * Delete the price set.
283 * false if fields exist for this set, true if the
284 * set could be deleted
287 public static function deleteSet($id) {
288 // remove from all inactive forms
289 $usedBy = self
::getUsedBy($id);
290 if (isset($usedBy['civicrm_event'])) {
291 foreach ($usedBy['civicrm_event'] as $eventId => $unused) {
292 $eventDAO = new CRM_Event_DAO_Event();
293 $eventDAO->id
= $eventId;
295 while ($eventDAO->fetch()) {
296 self
::removeFrom('civicrm_event', $eventDAO->id
);
301 // delete price fields
302 $priceField = new CRM_Price_DAO_PriceField();
303 $priceField->price_set_id
= $id;
305 while ($priceField->fetch()) {
306 // delete options first
307 CRM_Price_BAO_PriceField
::deleteField($priceField->id
);
310 $set = new CRM_Price_DAO_PriceSet();
312 return $set->delete();
316 * Link the price set with the specified table and id.
318 * @param string $entityTable
319 * @param int $entityId
320 * @param int $priceSetId
324 public static function addTo($entityTable, $entityId, $priceSetId) {
325 // verify that the price set exists
326 $dao = new CRM_Price_DAO_PriceSet();
327 $dao->id
= $priceSetId;
333 $dao = new CRM_Price_DAO_PriceSetEntity();
334 // find if this already exists
335 $dao->entity_id
= $entityId;
336 $dao->entity_table
= $entityTable;
339 // add or update price_set_id
340 $dao->price_set_id
= $priceSetId;
345 * Delete price set for the given entity and id.
347 * @param string $entityTable
348 * @param int $entityId
352 public static function removeFrom($entityTable, $entityId) {
353 $dao = new CRM_Price_DAO_PriceSetEntity();
354 $dao->entity_table
= $entityTable;
355 $dao->entity_id
= $entityId;
356 return $dao->delete();
360 * Find a price_set_id associatied with the given table, id and usedFor
361 * Used For value for events:1, contribution:2, membership:3
363 * @param string $entityTable
364 * @param int $entityId
365 * @param int $usedFor
366 * ( price set that extends/used for particular component ).
368 * @param null $isQuickConfig
369 * @param null $setName
372 * price_set_id, or false if none found
374 public static function getFor($entityTable, $entityId, $usedFor = NULL, $isQuickConfig = NULL, &$setName = NULL) {
375 if (!$entityTable ||
!$entityId) {
379 $sql = 'SELECT ps.id as price_set_id, ps.name as price_set_name
380 FROM civicrm_price_set ps
381 INNER JOIN civicrm_price_set_entity pse ON ps.id = pse.price_set_id
382 WHERE pse.entity_table = %1 AND pse.entity_id = %2 ';
383 if ($isQuickConfig) {
384 $sql .= ' AND ps.is_quick_config = 0 ';
387 1 => array($entityTable, 'String'),
388 2 => array($entityId, 'Integer'),
391 $sql .= " AND ps.extends LIKE '%%3%' ";
392 $params[3] = array($usedFor, 'Integer');
395 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
397 $setName = (isset($dao->price_set_name
)) ?
$dao->price_set_name
: FALSE;
398 return (isset($dao->price_set_id
)) ?
$dao->price_set_id
: FALSE;
402 * Find a price_set_id associated with the given option value or field ID.
404 * @param array $params
405 * (reference) an assoc array of name/value pairs.
406 * array may contain either option id or
410 * price set id on success, null otherwise
412 public static function getSetId(&$params) {
415 if ($oid = CRM_Utils_Array
::value('oid', $params)) {
416 $fieldValue = new CRM_Price_DAO_PriceFieldValue();
417 $fieldValue->id
= $oid;
418 if ($fieldValue->find(TRUE)) {
419 $fid = $fieldValue->price_field_id
;
423 $fid = CRM_Utils_Array
::value('fid', $params);
427 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'price_set_id');
434 * Return an associative array of all price sets.
436 * @param bool $withInactive
437 * Whether or not to include inactive entries.
438 * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute'
441 * associative array of id => name
443 public static function getAssoc($withInactive = FALSE, $extendComponentName = FALSE) {
446 DISTINCT ( price_set_id ) as id, title
451 civicrm_price_set.id = civicrm_price_field.price_set_id AND is_quick_config = 0 ';
453 if (!$withInactive) {
454 $query .= ' AND civicrm_price_set.is_active = 1 ';
457 if (self
::eventPriceSetDomainID()) {
458 $query .= ' AND civicrm_price_set.domain_id = ' . CRM_Core_Config
::domainID();
461 $priceSets = array();
463 if ($extendComponentName) {
464 $componentId = CRM_Core_Component
::getComponentID($extendComponentName);
468 $query .= " AND civicrm_price_set.extends LIKE '%$componentId%' ";
471 $dao = CRM_Core_DAO
::executeQuery($query);
472 while ($dao->fetch()) {
473 $priceSets[$dao->id
] = $dao->title
;
479 * Get price set details.
481 * An array containing price set details (including price fields) is returned
485 * @param bool $required
486 * Appears to have no effect based on reading the code.
487 * @param bool $validOnly
488 * Should only fields where today's date falls within the valid range be returned?
491 * Array consisting of field details
493 public static function getSetDetail($setID, $required = TRUE, $validOnly = FALSE) {
497 $priceFields = array(
506 'is_display_amounts',
515 if ($required == TRUE) {
516 $priceFields[] = 'is_required';
520 $select = 'SELECT ' . implode(',', $priceFields);
521 $from = ' FROM civicrm_price_field';
524 $params[1] = array($setID, 'Integer');
526 WHERE price_set_id = %1
531 $currentTime = date('YmdHis');
533 AND ( active_on IS NULL OR active_on <= {$currentTime} )
534 AND ( expire_on IS NULL OR expire_on >= {$currentTime} )
538 $orderBy = ' ORDER BY weight';
540 $sql = $select . $from . $where . $dateSelect . $orderBy;
542 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
544 $visibility = CRM_Core_PseudoConstant
::visibility('name');
545 while ($dao->fetch()) {
548 $setTree[$setID]['fields'][$fieldID] = array();
549 $setTree[$setID]['fields'][$fieldID]['id'] = $fieldID;
551 foreach ($priceFields as $field) {
552 if ($field == 'id' ||
is_null($dao->$field)) {
556 if ($field == 'visibility_id') {
557 $setTree[$setID]['fields'][$fieldID]['visibility'] = $visibility[$dao->$field];
559 $setTree[$setID]['fields'][$fieldID][$field] = $dao->$field;
561 $setTree[$setID]['fields'][$fieldID]['options'] = CRM_Price_BAO_PriceField
::getOptions($fieldID, FALSE);
564 // also get the pre and post help from this price set
566 SELECT extends, financial_type_id, help_pre, help_post, is_quick_config
567 FROM civicrm_price_set
569 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
571 $setTree[$setID]['extends'] = $dao->extends;
572 $setTree[$setID]['financial_type_id'] = $dao->financial_type_id
;
573 $setTree[$setID]['help_pre'] = $dao->help_pre
;
574 $setTree[$setID]['help_post'] = $dao->help_post
;
575 $setTree[$setID]['is_quick_config'] = $dao->is_quick_config
;
581 * Get the Price Field ID.
583 * We call this function when more than one being present would represent an error
584 * starting format derived from current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))
585 * @param array $priceSet
587 * @throws CRM_Core_Exception
590 public static function getOnlyPriceFieldID(array $priceSet) {
591 if (count($priceSet['fields']) > 1) {
592 throw new CRM_Core_Exception(ts('expected only one price field to be in priceset but multiple are present'));
594 return (int) implode('_', array_keys($priceSet['fields']));
598 * Get the Price Field Value ID. We call this function when more than one being present would represent an error
599 * current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))
600 * @param array $priceSet
602 * @throws CRM_Core_Exception
605 public static function getOnlyPriceFieldValueID(array $priceSet) {
606 $priceFieldID = self
::getOnlyPriceFieldID($priceSet);
607 if (count($priceSet['fields'][$priceFieldID]['options']) > 1) {
608 throw new CRM_Core_Exception(ts('expected only one price field to be in priceset but multiple are present'));
610 return (int) implode('_', array_keys($priceSet['fields'][$priceFieldID]['options']));
615 * Initiate price set such that various non-BAO things are set on the form.
617 * This function is not really a BAO function so the location is misleading.
619 * @param CRM_Core_Form $form
622 * @param string $entityTable
623 * @param bool $validOnly
624 * @param int $priceSetId
627 * @return bool|false|int|null
629 public static function initSet(&$form, $id, $entityTable = 'civicrm_event', $validOnly = FALSE, $priceSetId = NULL) {
631 $priceSetId = self
::getFor($entityTable, $id);
634 //check if priceset is is_config
635 if (is_numeric($priceSetId)) {
636 if (CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config') && $form->getVar('_name') != 'Participant') {
637 $form->assign('quickConfig', 1);
642 if ($form->_action
& CRM_Core_Action
::UPDATE
) {
643 $entityId = $entity = NULL;
645 switch ($entityTable) {
646 case 'civicrm_event':
647 $entity = 'participant';
648 if (CRM_Utils_System
::getClassName($form) == 'CRM_Event_Form_Participant') {
649 $entityId = $form->_id
;
652 $entityId = $form->_participantId
;
656 case 'civicrm_contribution_page':
657 case 'civicrm_contribution':
658 $entity = 'contribution';
659 $entityId = $form->_id
;
663 if ($entityId && $entity) {
664 $form->_values
['line_items'] = CRM_Price_BAO_LineItem
::getLineItems($entityId, $entity);
672 $form->_priceSetId
= $priceSetId;
673 $priceSet = self
::getSetDetail($priceSetId, $required, $validOnly);
674 $form->_priceSet
= CRM_Utils_Array
::value($priceSetId, $priceSet);
675 $form->_values
['fee'] = CRM_Utils_Array
::value('fields', $form->_priceSet
);
677 //get the price set fields participant count.
678 if ($entityTable == 'civicrm_event') {
679 //get option count info.
680 $form->_priceSet
['optionsCountTotal'] = self
::getPricesetCount($priceSetId);
681 if ($form->_priceSet
['optionsCountTotal']) {
682 $optionsCountDeails = array();
683 if (!empty($form->_priceSet
['fields'])) {
684 foreach ($form->_priceSet
['fields'] as $field) {
685 foreach ($field['options'] as $option) {
686 $count = CRM_Utils_Array
::value('count', $option, 0);
687 $optionsCountDeails['fields'][$field['id']]['options'][$option['id']] = $count;
691 $form->_priceSet
['optionsCountDetails'] = $optionsCountDeails;
694 //get option max value info.
695 $optionsMaxValueTotal = 0;
696 $optionsMaxValueDetails = array();
698 if (!empty($form->_priceSet
['fields'])) {
699 foreach ($form->_priceSet
['fields'] as $field) {
700 foreach ($field['options'] as $option) {
701 $maxVal = CRM_Utils_Array
::value('max_value', $option, 0);
702 $optionsMaxValueDetails['fields'][$field['id']]['options'][$option['id']] = $maxVal;
703 $optionsMaxValueTotal +
= $maxVal;
708 $form->_priceSet
['optionsMaxValueTotal'] = $optionsMaxValueTotal;
709 if ($optionsMaxValueTotal) {
710 $form->_priceSet
['optionsMaxValueDetails'] = $optionsMaxValueDetails;
713 $form->set('priceSetId', $form->_priceSetId
);
714 $form->set('priceSet', $form->_priceSet
);
722 * Get line item purchase information.
724 * This function takes the input parameters and interprets out of it what has been purchased.
727 * This is the output of the function CRM_Price_BAO_PriceSet::getSetDetail($priceSetID, FALSE, FALSE);
728 * And, it would make sense to introduce caching into that function and call it from here rather than
729 * require the $fields array which is passed from pillar to post around the form in order to pass it in here.
730 * @param array $params
731 * Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
733 * Line item array to be altered.
734 * @param string $component
735 * This parameter appears to only be relevant to determining whether memberships should be auto-renewed.
736 * (and is effectively a boolean for 'is_membership' which could be calculated from the line items.)
738 public static function processAmount(&$fields, &$params, &$lineItem, $component = '') {
740 $totalPrice = $totalTax = 0;
741 $radioLevel = $checkboxLevel = $selectLevel = $textLevel = array();
743 $autoRenew = array();
744 $autoRenew[0] = $autoRenew[1] = $autoRenew[2] = 0;
746 foreach ($fields as $id => $field) {
747 if (empty($params["price_{$id}"]) ||
748 (empty($params["price_{$id}"]) && $params["price_{$id}"] == NULL)
750 // skip if nothing was submitted for this field
754 switch ($field['html_type']) {
756 $firstOption = reset($field['options']);
757 $params["price_{$id}"] = array($firstOption['id'] => $params["price_{$id}"]);
758 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem);
759 if (CRM_Utils_Array
::value('tax_rate', $field['options'][key($field['options'])])) {
760 $lineItem = self
::setLineItem($field, $lineItem, key($field['options']));
761 $totalTax +
= $field['options'][key($field['options'])]['tax_amount'] * $lineItem[key($field['options'])]['qty'];
763 if (CRM_Utils_Array
::value('name', $field['options'][key($field['options'])]) == 'contribution_amount') {
764 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
765 if (array_key_exists($params['financial_type_id'], $taxRates)) {
766 $field['options'][key($field['options'])]['tax_rate'] = $taxRates[$params['financial_type_id']];
767 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($field['options'][key($field['options'])]['amount'], $field['options'][key($field['options'])]['tax_rate']);
768 $field['options'][key($field['options'])]['tax_amount'] = round($taxAmount['tax_amount'], 2);
769 $lineItem = self
::setLineItem($field, $lineItem, key($field['options']));
770 $totalTax +
= $field['options'][key($field['options'])]['tax_amount'] * $lineItem[key($field['options'])]['qty'];
773 $totalPrice +
= $lineItem[$firstOption['id']]['line_total'] + CRM_Utils_Array
::value('tax_amount', $lineItem[key($field['options'])]);
777 //special case if user select -none-
778 if ($params["price_{$id}"] <= 0) {
781 $params["price_{$id}"] = array($params["price_{$id}"] => 1);
782 $optionValueId = CRM_Utils_Array
::key(1, $params["price_{$id}"]);
783 $optionLabel = CRM_Utils_Array
::value('label', $field['options'][$optionValueId]);
784 $params['amount_priceset_level_radio'] = array();
785 $params['amount_priceset_level_radio'][$optionValueId] = $optionLabel;
786 if (isset($radioLevel)) {
787 $radioLevel = array_merge($radioLevel,
788 array_keys($params['amount_priceset_level_radio'])
792 $radioLevel = array_keys($params['amount_priceset_level_radio']);
794 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem);
795 if (CRM_Utils_Array
::value('tax_rate', $field['options'][$optionValueId])) {
796 $lineItem = self
::setLineItem($field, $lineItem, $optionValueId);
797 $totalTax +
= $field['options'][$optionValueId]['tax_amount'];
798 if (CRM_Utils_Array
::value('field_title', $lineItem[$optionValueId]) == 'Membership Amount') {
799 $lineItem[$optionValueId]['line_total'] = $lineItem[$optionValueId]['unit_price'] = CRM_Utils_Rule
::cleanMoney($lineItem[$optionValueId]['line_total'] - $lineItem[$optionValueId]['tax_amount']);
802 $totalPrice +
= $lineItem[$optionValueId]['line_total'] + CRM_Utils_Array
::value('tax_amount', $lineItem[$optionValueId]);
805 // auto_renew exists and is empty in some workflows, which php treat as a 0
806 // and hence we explicitly check to see if auto_renew is numeric
807 isset($lineItem[$optionValueId]['auto_renew']) &&
808 is_numeric($lineItem[$optionValueId]['auto_renew'])
810 $autoRenew[$lineItem[$optionValueId]['auto_renew']] +
= $lineItem[$optionValueId]['line_total'];
815 $params["price_{$id}"] = array($params["price_{$id}"] => 1);
816 $optionValueId = CRM_Utils_Array
::key(1, $params["price_{$id}"]);
817 $optionLabel = $field['options'][$optionValueId]['label'];
818 $params['amount_priceset_level_select'] = array();
819 $params['amount_priceset_level_select'][CRM_Utils_Array
::key(1, $params["price_{$id}"])] = $optionLabel;
820 if (isset($selectLevel)) {
821 $selectLevel = array_merge($selectLevel, array_keys($params['amount_priceset_level_select']));
824 $selectLevel = array_keys($params['amount_priceset_level_select']);
826 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem);
827 if (CRM_Utils_Array
::value('tax_rate', $field['options'][$optionValueId])) {
828 $lineItem = self
::setLineItem($field, $lineItem, $optionValueId);
829 $totalTax +
= $field['options'][$optionValueId]['tax_amount'];
831 $totalPrice +
= $lineItem[$optionValueId]['line_total'] + CRM_Utils_Array
::value('tax_amount', $lineItem[$optionValueId]);
834 isset($lineItem[$optionValueId]['auto_renew']) &&
835 is_numeric($lineItem[$optionValueId]['auto_renew'])
837 $autoRenew[$lineItem[$optionValueId]['auto_renew']] +
= $lineItem[$optionValueId]['line_total'];
842 $params['amount_priceset_level_checkbox'] = $optionIds = array();
843 foreach ($params["price_{$id}"] as $optionId => $option) {
844 $optionIds[] = $optionId;
845 $optionLabel = $field['options'][$optionId]['label'];
846 $params['amount_priceset_level_checkbox']["{$field['options'][$optionId]['id']}"] = $optionLabel;
847 if (isset($checkboxLevel)) {
848 $checkboxLevel = array_unique(array_merge(
850 array_keys($params['amount_priceset_level_checkbox'])
855 $checkboxLevel = array_keys($params['amount_priceset_level_checkbox']);
858 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem);
859 foreach ($optionIds as $optionId) {
860 if (CRM_Utils_Array
::value('tax_rate', $field['options'][$optionId])) {
861 $lineItem = self
::setLineItem($field, $lineItem, $optionId);
862 $totalTax +
= $field['options'][$optionId]['tax_amount'];
864 $totalPrice +
= $lineItem[$optionId]['line_total'] + CRM_Utils_Array
::value('tax_amount', $lineItem[$optionId]);
867 isset($lineItem[$optionId]['auto_renew']) &&
868 is_numeric($lineItem[$optionId]['auto_renew'])
870 $autoRenew[$lineItem[$optionId]['auto_renew']] +
= $lineItem[$optionId]['line_total'];
877 $amount_level = array();
878 $totalParticipant = 0;
879 if (is_array($lineItem)) {
880 foreach ($lineItem as $values) {
881 $totalParticipant +
= $values['participant_count'];
882 $amount_level[] = $values['label'] . ' - ' . (float) $values['qty'];
886 $displayParticipantCount = '';
887 if ($totalParticipant > 0) {
888 $displayParticipantCount = ' Participant Count -' . $totalParticipant;
890 $params['amount_level'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $amount_level) . $displayParticipantCount . CRM_Core_DAO
::VALUE_SEPARATOR
;
891 $params['amount'] = CRM_Utils_Money
::format($totalPrice, NULL, NULL, TRUE);
892 $params['tax_amount'] = $totalTax;
894 foreach ($autoRenew as $dontCare => $eachAmount) {
896 unset($autoRenew[$dontCare]);
899 if (count($autoRenew) > 1) {
900 $params['autoRenew'] = $autoRenew;
906 * Build the price set form.
908 * @param CRM_Core_Form $form
912 public static function buildPriceSet(&$form) {
913 $priceSetId = $form->get('priceSetId');
918 $validFieldsOnly = TRUE;
919 $className = CRM_Utils_System
::getClassName($form);
920 if (in_array($className, array(
921 'CRM_Contribute_Form_Contribution',
922 'CRM_Member_Form_Membership',
924 $validFieldsOnly = FALSE;
927 $priceSet = self
::getSetDetail($priceSetId, TRUE, $validFieldsOnly);
928 $form->_priceSet
= CRM_Utils_Array
::value($priceSetId, $priceSet);
929 $validPriceFieldIds = array_keys($form->_priceSet
['fields']);
930 $form->_quickConfig
= $quickConfig = 0;
931 if (CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config')) {
935 $form->assign('quickConfig', $quickConfig);
936 if ($className == 'CRM_Contribute_Form_Contribution_Main') {
937 $form->_quickConfig
= $quickConfig;
939 $form->assign('priceSet', $form->_priceSet
);
941 $component = 'contribution';
942 if ($className == 'CRM_Member_Form_Membership') {
943 $component = 'membership';
946 if ($className == 'CRM_Contribute_Form_Contribution_Main') {
947 $feeBlock = &$form->_values
['fee'];
948 if (!empty($form->_useForMember
)) {
949 $component = 'membership';
953 $feeBlock = &$form->_priceSet
['fields'];
957 CRM_Utils_Hook
::buildAmount($component, $form, $feeBlock);
959 // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
960 $adminFieldVisible = FALSE;
961 if (CRM_Core_Permission
::check('administer CiviCRM')) {
962 $adminFieldVisible = TRUE;
965 foreach ($feeBlock as $id => $field) {
966 if (CRM_Utils_Array
::value('visibility', $field) == 'public' ||
967 (CRM_Utils_Array
::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
970 $options = CRM_Utils_Array
::value('options', $field);
971 if ($className == 'CRM_Contribute_Form_Contribution_Main' && $component = 'membership') {
972 $userid = $form->getVar('_membershipContactID');
973 $checklifetime = self
::checkCurrentMembership($options, $userid);
974 if ($checklifetime) {
975 $form->assign('ispricelifetime', TRUE);
978 if (!is_array($options) ||
!in_array($id, $validPriceFieldIds)) {
981 CRM_Price_BAO_PriceField
::addQuickFormElement($form,
982 'price_' . $field['id'],
985 CRM_Utils_Array
::value('is_required', $field, FALSE),
994 * Check the current Membership having end date null.
996 * @param array $options
998 * Probably actually contact ID.
1002 public static function checkCurrentMembership(&$options, $userid) {
1003 if (!$userid ||
empty($options)) {
1006 static $_contact_memberships = array();
1007 $checkLifetime = FALSE;
1008 foreach ($options as $key => $value) {
1009 if (!empty($value['membership_type_id'])) {
1010 if (!isset($_contact_memberships[$userid][$value['membership_type_id']])) {
1011 $_contact_memberships[$userid][$value['membership_type_id']] = CRM_Member_BAO_Membership
::getContactMembership($userid, $value['membership_type_id'], FALSE);
1013 $currentMembership = $_contact_memberships[$userid][$value['membership_type_id']];
1014 if (!empty($currentMembership) && empty($currentMembership['end_date'])) {
1015 unset($options[$key]);
1016 $checkLifetime = TRUE;
1020 if ($checkLifetime) {
1029 * Set daefult the price set fields.
1031 * @param CRM_Core_Form $form
1036 public static function setDefaultPriceSet(&$form, &$defaults) {
1037 if (!isset($form->_priceSet
) ||
empty($form->_priceSet
['fields'])) {
1041 foreach ($form->_priceSet
['fields'] as $key => $val) {
1042 foreach ($val['options'] as $keys => $values) {
1043 if ($values['is_default']) {
1044 if ($val['html_type'] == 'CheckBox') {
1045 $defaults["price_{$key}"][$keys] = 1;
1048 $defaults["price_{$key}"] = $keys;
1057 * Supports event create function by setting up required price sets, not tested but expect
1058 * it will work for contribution page
1059 * @param array $params
1060 * As passed to api/bao create fn.
1061 * @param CRM_Core_DAO $entity
1062 * Object for given entity.
1063 * @param string $entityName
1064 * Name of entity - e.g event.
1066 public static function setPriceSets(&$params, $entity, $entityName) {
1067 if (empty($params['price_set_id']) ||
!is_array($params['price_set_id'])) {
1070 // CRM-14069 note that we may as well start by assuming more than one.
1071 // currently the form does not pass in as an array & will be skipped
1072 // test is passing in as an array but I feel the api should have a metadata that allows
1073 // transform of single to array - seems good for managing transitions - in which case all api
1074 // calls that set price_set_id will hit this
1075 // e.g in getfields 'price_set_id' => array('blah', 'bao_type' => 'array') - causing
1076 // all separated values, strings, json half-separated values (in participant we hit this)
1077 // to be converted to json @ api layer
1078 $pse = new CRM_Price_DAO_PriceSetEntity();
1079 $pse->entity_table
= 'civicrm_' . $entityName;
1080 $pse->entity_id
= $entity->id
;
1081 while ($pse->fetch()) {
1082 if (!in_array($pse->price_set_id
, $params['price_set_id'])) {
1083 // note an even more aggressive form of this deletion currently happens in event form
1084 // past price sets discounts are made inaccessible by this as the discount_id is set to NULL
1085 // on the participant record
1086 if (CRM_Price_BAO_PriceSet
::removeFrom('civicrm_' . $entityName, $entity->id
)) {
1087 CRM_Core_BAO_Discount
::del($entity->id
, 'civicrm_' . $entityName);
1091 foreach ($params['price_set_id'] as $priceSetID) {
1092 CRM_Price_BAO_PriceSet
::addTo('civicrm_' . $entityName, $entity->id
, $priceSetID);
1093 //@todo - how should we do this - copied from form
1094 //if (!empty($params['price_field_id'])) {
1095 // $priceSetID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $params['price_field_id'], 'price_set_id');
1096 // CRM_Price_BAO_PriceSet::setIsQuickConfig($priceSetID, 0);
1102 * Get field ids of a price set.
1108 * Array of the field ids
1111 public static function getFieldIds($id) {
1112 $priceField = new CRM_Price_DAO_PriceField();
1113 $priceField->price_set_id
= $id;
1114 $priceField->find();
1115 while ($priceField->fetch()) {
1116 $var[] = $priceField->id
;
1122 * Copy a price set, including all the fields
1125 * The price set id to copy.
1127 * @return CRM_Price_DAO_PriceSet
1129 public static function copy($id) {
1130 $maxId = CRM_Core_DAO
::singleValueQuery("SELECT max(id) FROM civicrm_price_set");
1132 $title = ts('[Copy id %1]', array(1 => $maxId +
1));
1135 'title' => ' ' . $title,
1136 'name' => '__Copy_id_' . ($maxId +
1) . '_',
1140 $copy = &CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceSet',
1146 //copying all the blocks pertaining to the price set
1147 $copyPriceField = &CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceField',
1148 array('price_set_id' => $id),
1149 array('price_set_id' => $copy->id
)
1151 if (!empty($copyPriceField)) {
1152 $price = array_combine(self
::getFieldIds($id), self
::getFieldIds($copy->id
));
1154 //copy option group and values
1155 foreach ($price as $originalId => $copyId) {
1156 CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceFieldValue',
1157 array('price_field_id' => $originalId),
1158 array('price_field_id' => $copyId)
1164 CRM_Utils_Hook
::copy('Set', $copy);
1169 * check price set permission.
1176 public static function checkPermission($sid) {
1177 if ($sid && self
::eventPriceSetDomainID()) {
1178 $domain_id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $sid, 'domain_id', 'id');
1179 if (CRM_Core_Config
::domainID() != $domain_id) {
1180 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
1187 * Get the sum of participant count
1188 * for all fields of given price set.
1193 * @param bool $onlyActive
1195 * @return int|null|string
1197 public static function getPricesetCount($sid, $onlyActive = TRUE) {
1205 $where = 'AND value.is_active = 1 AND field.is_active = 1';
1208 static $pricesetFieldCount = array();
1209 if (!isset($pricesetFieldCount[$sid])) {
1211 SELECT sum(value.count) as totalCount
1212 FROM civicrm_price_field_value value
1213 INNER JOIN civicrm_price_field field ON ( field.id = value.price_field_id )
1214 INNER JOIN civicrm_price_set pset ON ( pset.id = field.price_set_id )
1218 $count = CRM_Core_DAO
::singleValueQuery($sql, array(1 => array($sid, 'Positive')));
1219 $pricesetFieldCount[$sid] = ($count) ?
$count : 0;
1222 return $pricesetFieldCount[$sid];
1230 public static function getMembershipCount($ids) {
1232 SELECT count( pfv.id ) AS count, pfv.id AS id
1233 FROM civicrm_price_field_value pfv
1234 INNER JOIN civicrm_membership_type mt ON mt.id = pfv.membership_type_id
1235 WHERE pfv.id IN ( $ids )
1236 GROUP BY mt.member_of_contact_id";
1238 $crmDAO = CRM_Core_DAO
::executeQuery($queryString);
1241 while ($crmDAO->fetch()) {
1242 $count[$crmDAO->id
] = $crmDAO->count
;
1249 * Check if auto renew option should be shown.
1251 * @param int $priceSetId
1255 * $autoRenewOption ( 0:hide, 1:optional 2:required )
1257 public static function checkAutoRenewForPriceSet($priceSetId) {
1258 // auto-renew option should be visible if membership types associated with all the fields has
1259 // been set for auto-renew option
1260 // Auto renew checkbox should be frozen if for all the membership type auto renew is required
1262 // get the membership type auto renew option and check if required or optional
1263 $query = 'SELECT mt.auto_renew, mt.duration_interval, mt.duration_unit
1264 FROM civicrm_price_field_value pfv
1265 INNER JOIN civicrm_membership_type mt ON pfv.membership_type_id = mt.id
1266 INNER JOIN civicrm_price_field pf ON pfv.price_field_id = pf.id
1267 WHERE pf.price_set_id = %1
1268 AND pf.is_active = 1
1269 AND pfv.is_active = 1';
1271 $params = array(1 => array($priceSetId, 'Integer'));
1273 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1274 $autoRenewOption = 2;
1275 $interval = $unit = array();
1276 while ($dao->fetch()) {
1277 if (!$dao->auto_renew
) {
1278 $autoRenewOption = 0;
1281 if ($dao->auto_renew
== 1) {
1282 $autoRenewOption = 1;
1285 $interval[$dao->duration_interval
] = $dao->duration_interval
;
1286 $unit[$dao->duration_unit
] = $dao->duration_unit
;
1289 if (count($interval) == 1 && count($unit) == 1 && $autoRenewOption > 0) {
1290 return $autoRenewOption;
1298 * Retrieve auto renew frequency and interval.
1300 * @param int $priceSetId
1304 * associate array of frequency interval and unit
1306 public static function getRecurDetails($priceSetId) {
1307 $query = 'SELECT mt.duration_interval, mt.duration_unit
1308 FROM civicrm_price_field_value pfv
1309 INNER JOIN civicrm_membership_type mt ON pfv.membership_type_id = mt.id
1310 INNER JOIN civicrm_price_field pf ON pfv.price_field_id = pf.id
1311 WHERE pf.price_set_id = %1 LIMIT 1';
1313 $params = array(1 => array($priceSetId, 'Integer'));
1314 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1316 return array($dao->duration_interval
, $dao->duration_unit
);
1322 public static function eventPriceSetDomainID() {
1323 return CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MULTISITE_PREFERENCES_NAME
,
1324 'event_price_set_domain_id',
1330 * Update the is_quick_config flag in the db.
1333 * Id of the database record.
1334 * @param bool $isQuickConfig we want to set the is_quick_config field.
1335 * Value we want to set the is_quick_config field.
1338 * DAO object on sucess, null otherwise
1340 public static function setIsQuickConfig($id, $isQuickConfig) {
1341 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceSet', $id, 'is_quick_config', $isQuickConfig);
1345 * Check if price set id provides option for
1346 * user to select both auto-renew and non-auto-renew memberships
1352 public static function checkMembershipPriceSet($id) {
1354 = "SELECT pfv.id, pfv.price_field_id, pfv.name, pfv.membership_type_id, pf.html_type, mt.auto_renew
1355 FROM civicrm_price_field_value pfv
1356 LEFT JOIN civicrm_price_field pf ON pf.id = pfv.price_field_id
1357 LEFT JOIN civicrm_price_set ps ON ps.id = pf.price_set_id
1358 LEFT JOIN civicrm_membership_type mt ON mt.id = pfv.membership_type_id
1362 $params = array(1 => array($id, 'Integer'));
1363 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1365 $autoRenew = array();
1366 //FIXME: do a comprehensive check of whether
1367 //2 membership types can be selected
1368 //instead of comparing all of them
1369 while ($dao->fetch()) {
1370 //temp fix for #CRM-10370
1371 //if its NULL consider it '0' i.e. 'No auto-renew option'
1372 $daoAutoRenew = $dao->auto_renew
;
1373 if ($daoAutoRenew === NULL) {
1376 if (!empty($autoRenew) && !in_array($daoAutoRenew, $autoRenew)) {
1379 $autoRenew[] = $daoAutoRenew;
1385 * Copy priceSet when event/contibution page is copied
1387 * @param string $baoName
1390 * Old event/contribution page id.
1392 * Newly created event/contribution page id.
1394 public static function copyPriceSet($baoName, $id, $newId) {
1395 $priceSetId = CRM_Price_BAO_PriceSet
::getFor($baoName, $id);
1397 $isQuickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1398 if ($isQuickConfig) {
1399 $copyPriceSet = CRM_Price_BAO_PriceSet
::copy($priceSetId);
1400 CRM_Price_BAO_PriceSet
::addTo($baoName, $newId, $copyPriceSet->id
);
1403 $copyPriceSet = &CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceSetEntity',
1406 'entity_table' => $baoName,
1408 array('entity_id' => $newId)
1411 // copy event discount
1412 if ($baoName == 'civicrm_event') {
1413 $discount = CRM_Core_BAO_Discount
::getOptionGroup($id, 'civicrm_event');
1414 foreach ($discount as $discountId => $setId) {
1416 $copyPriceSet = &CRM_Price_BAO_PriceSet
::copy($setId);
1418 CRM_Core_DAO
::copyGeneric(
1419 'CRM_Core_DAO_Discount',
1421 'id' => $discountId,
1424 'entity_id' => $newId,
1425 'price_set_id' => $copyPriceSet->id
,
1434 * Function to set tax_amount and tax_rate in LineItem.
1436 * @param array $field
1437 * @param array $lineItem
1438 * @param int $optionValueId
1442 public static function setLineItem($field, $lineItem, $optionValueId) {
1443 if ($field['html_type'] == 'Text') {
1444 $taxAmount = $field['options'][$optionValueId]['tax_amount'] * $lineItem[$optionValueId]['qty'];
1447 $taxAmount = $field['options'][$optionValueId]['tax_amount'];
1449 $taxRate = $field['options'][$optionValueId]['tax_rate'];
1450 $lineItem[$optionValueId]['tax_amount'] = $taxAmount;
1451 $lineItem[$optionValueId]['tax_rate'] = $taxRate;