3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * Business object for managing price sets.
22 class CRM_Price_BAO_PriceSet
extends CRM_Price_DAO_PriceSet
{
25 * Static field for default price set details.
29 public static $_defaultPriceSet = NULL;
34 public function __construct() {
35 parent
::__construct();
39 * Takes an associative array and creates a price set object.
41 * @param array $params
42 * (reference) an assoc array of name/value pairs.
44 * @return CRM_Price_DAO_PriceSet
46 public static function create(&$params) {
47 $hook = empty($params['id']) ?
'create' : 'edit';
48 CRM_Utils_Hook
::pre($hook, 'PriceSet', CRM_Utils_Array
::value('id', $params), $params);
50 if (empty($params['id']) && empty($params['name'])) {
51 $params['name'] = CRM_Utils_String
::munge($params['title'], '_', 242);
54 $validatePriceSet = TRUE;
55 if (!empty($params['extends']) && is_array($params['extends'])) {
56 if (!array_key_exists(CRM_Core_Component
::getComponentID('CiviEvent'), $params['extends'])
57 ||
!array_key_exists(CRM_Core_Component
::getComponentID('CiviMember'), $params['extends'])
59 $validatePriceSet = FALSE;
61 $params['extends'] = CRM_Utils_Array
::implodePadded($params['extends']);
64 $priceSetID = $params['id'] ??
NULL;
66 $priceSetBAO = new CRM_Price_BAO_PriceSet();
67 $priceSetBAO->copyValues($params);
68 if (self
::eventPriceSetDomainID()) {
69 $priceSetBAO->domain_id
= CRM_Core_Config
::domainID();
73 CRM_Utils_Hook
::post($hook, 'PriceSet', $priceSetBAO->id
, $priceSetBAO);
74 unset(\Civi
::$statics['CRM_Core_PseudoConstant']);
79 * Fetch object based on array of properties.
81 * @param array $params
82 * (reference ) an assoc array of name/value pairs.
83 * @param array $defaults
84 * (reference ) an assoc array to hold the flattened values.
86 * @return CRM_Price_DAO_PriceSet
88 public static function retrieve(&$params, &$defaults) {
89 return CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceSet', $params, $defaults);
93 * Update the is_active flag in the db.
96 * Id of the database record.
100 * true if we found and updated the object, else false
102 public static function setIsActive($id, $isActive) {
103 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceSet', $id, 'is_active', $isActive);
107 * Calculate the default price set id
108 * assigned to the contribution/membership etc
110 * @param string $entity
116 public static function getDefaultPriceSet($entity = 'contribution') {
117 if (isset(\Civi
::$statics[__CLASS__
][$entity])) {
118 return \Civi
::$statics[__CLASS__
][$entity];
120 $priceSetName = ($entity === 'membership') ?
'default_membership_type_amount' : 'default_contribution_amount';
123 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
124 FROM civicrm_price_set ps
125 LEFT JOIN civicrm_price_field pf ON pf.`price_set_id` = ps.id
126 LEFT JOIN civicrm_price_field_value pfv ON pfv.price_field_id = pf.id
127 WHERE ps.name = '{$priceSetName}'
130 $dao = CRM_Core_DAO
::executeQuery($sql);
131 while ($dao->fetch()) {
132 \Civi
::$statics[__CLASS__
][$entity][$dao->priceFieldValueID
] = [
133 'setID' => $dao->setID
,
134 'priceFieldID' => $dao->priceFieldID
,
135 'name' => $dao->name
,
136 'label' => $dao->label
,
137 'priceFieldValueID' => $dao->priceFieldValueID
,
138 'membership_type_id' => $dao->membership_type_id
,
139 'amount' => $dao->amount
,
140 'financial_type_id' => $dao->financial_type_id
,
144 return \Civi
::$statics[__CLASS__
][$entity];
148 * Get the price set title.
157 public static function getTitle($id) {
158 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $id, 'title');
162 * Return a list of all forms which use this price set.
166 * @param bool|string $simpleReturn - get raw data. Possible values: 'entity', 'table'
170 public static function getUsedBy($id, $simpleReturn = FALSE) {
172 $forms = self
::getFormsUsingPriceSet($id);
173 $tables = array_keys($forms);
174 // @todo - this is really clumsy overloading the signature like this. Instead
175 // move towards having a function that does not call reformatUsedByFormsWithEntityData
176 // and call that when that data is not used.
177 if ($simpleReturn == 'table') {
180 // @todo - this is painfully slow in some cases.
183 SELECT cli.entity_table, cli.entity_id
184 FROM civicrm_line_item cli
185 LEFT JOIN civicrm_price_field cpf ON cli.price_field_id = cpf.id
186 WHERE cpf.price_set_id = %1";
187 $params = [1 => [$id, 'Integer']];
188 $crmFormDAO = CRM_Core_DAO
::executeQuery($queryString, $params);
189 while ($crmFormDAO->fetch()) {
190 $forms[$crmFormDAO->entity_table
][] = $crmFormDAO->entity_id
;
191 $tables[] = $crmFormDAO->entity_table
;
197 // @todo - this is really clumsy overloading the signature like this. See above.
198 if ($simpleReturn == 'entity') {
201 $usedBy = self
::reformatUsedByFormsWithEntityData($forms, $usedBy);
207 * Delete the price set, including the fields.
213 * false if fields exist for this set, true if the
214 * set could be deleted
217 public static function deleteSet($id) {
218 // delete price fields
219 $priceField = new CRM_Price_DAO_PriceField();
220 $priceField->price_set_id
= $id;
222 while ($priceField->fetch()) {
223 // delete options first
224 CRM_Price_BAO_PriceField
::deleteField($priceField->id
);
227 $set = new CRM_Price_DAO_PriceSet();
229 return $set->delete();
233 * Link the price set with the specified table and id.
235 * @param string $entityTable
236 * @param int $entityId
237 * @param int $priceSetId
241 public static function addTo($entityTable, $entityId, $priceSetId) {
242 // verify that the price set exists
243 $dao = new CRM_Price_DAO_PriceSet();
244 $dao->id
= $priceSetId;
250 $dao = new CRM_Price_DAO_PriceSetEntity();
251 // find if this already exists
252 $dao->entity_id
= $entityId;
253 $dao->entity_table
= $entityTable;
256 // add or update price_set_id
257 $dao->price_set_id
= $priceSetId;
262 * Delete price set for the given entity and id.
264 * @param string $entityTable
265 * @param int $entityId
269 public static function removeFrom($entityTable, $entityId) {
270 $dao = new CRM_Price_DAO_PriceSetEntity();
271 $dao->entity_table
= $entityTable;
272 $dao->entity_id
= $entityId;
273 return $dao->delete();
277 * Find a price_set_id associated with the given table, id and usedFor
278 * Used For value for events:1, contribution:2, membership:3
280 * @param string $entityTable
281 * @param int $entityId
282 * @param int $usedFor
283 * ( price set that extends/used for particular component ).
285 * @param null $isQuickConfig
286 * @param null $setName
289 * price_set_id, or false if none found
291 public static function getFor($entityTable, $entityId, $usedFor = NULL, $isQuickConfig = NULL, &$setName = NULL) {
292 if (!$entityTable ||
!$entityId) {
296 $sql = 'SELECT ps.id as price_set_id, ps.name as price_set_name
297 FROM civicrm_price_set ps
298 INNER JOIN civicrm_price_set_entity pse ON ps.id = pse.price_set_id
299 WHERE pse.entity_table = %1 AND pse.entity_id = %2 ';
300 if ($isQuickConfig) {
301 $sql .= ' AND ps.is_quick_config = 0 ';
304 1 => [$entityTable, 'String'],
305 2 => [$entityId, 'Integer'],
308 $sql .= " AND ps.extends LIKE '%%3%' ";
309 $params[3] = [$usedFor, 'Integer'];
312 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
314 $setName = (isset($dao->price_set_name
)) ?
$dao->price_set_name
: FALSE;
315 return (isset($dao->price_set_id
)) ?
$dao->price_set_id
: FALSE;
319 * Find a price_set_id associated with the given option value or field ID.
321 * @param array $params
322 * (reference) an assoc array of name/value pairs.
323 * array may contain either option id or
327 * price set id on success, null otherwise
329 public static function getSetId(&$params) {
332 if ($oid = CRM_Utils_Array
::value('oid', $params)) {
333 $fieldValue = new CRM_Price_DAO_PriceFieldValue();
334 $fieldValue->id
= $oid;
335 if ($fieldValue->find(TRUE)) {
336 $fid = $fieldValue->price_field_id
;
340 $fid = $params['fid'] ??
NULL;
344 return CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', $fid, 'price_set_id');
351 * Return an associative array of all price sets.
353 * @param bool $withInactive
354 * Whether or not to include inactive entries.
355 * @param bool|string $extendComponentName name of the component like 'CiviEvent','CiviContribute'
356 * @param string $column name of the column.
359 * associative array of id => name
361 public static function getAssoc($withInactive = FALSE, $extendComponentName = FALSE, $column = 'title') {
364 DISTINCT ( price_set_id ) as id, s.{$column}
367 INNER JOIN civicrm_price_field f ON f.price_set_id = s.id
368 INNER JOIN civicrm_price_field_value v ON v.price_field_id = f.id
370 is_quick_config = 0 ";
372 if (!$withInactive) {
373 $query .= ' AND s.is_active = 1 ';
376 if (self
::eventPriceSetDomainID()) {
377 $query .= ' AND s.domain_id = ' . CRM_Core_Config
::domainID();
382 if ($extendComponentName) {
383 $componentId = CRM_Core_Component
::getComponentID($extendComponentName);
387 $query .= " AND s.extends LIKE '%$componentId%' ";
389 // Check permissioned financial types
390 CRM_Financial_BAO_FinancialType
::getAvailableFinancialTypes($financialType, CRM_Core_Action
::ADD
);
391 if ($financialType) {
392 $types = implode(',', array_keys($financialType));
393 $query .= ' AND s.financial_type_id IN (' . $types . ') AND v.financial_type_id IN (' . $types . ') ';
396 // Do not display any price sets
399 $query .= " GROUP BY s.id";
400 $dao = CRM_Core_DAO
::executeQuery($query);
401 while ($dao->fetch()) {
402 $priceSets[$dao->id
] = $dao->$column;
408 * Get price set details.
410 * An array containing price set details (including price fields) is returned
414 * @param bool $required
415 * Appears to have no effect based on reading the code.
416 * @param bool $doNotIncludeExpiredFields
417 * Should only fields where today's date falls within the valid range be returned?
420 * Array consisting of field details
422 public static function getSetDetail($setID, $required = TRUE, $doNotIncludeExpiredFields = FALSE) {
435 'is_display_amounts',
444 if ($required == TRUE) {
445 $priceFields[] = 'is_required';
449 $select = 'SELECT ' . implode(',', $priceFields);
450 $from = ' FROM civicrm_price_field';
453 1 => [$setID, 'Integer'],
455 $currentTime = date('YmdHis');
457 WHERE price_set_id = %1
459 AND ( active_on IS NULL OR active_on <= {$currentTime} )
462 if ($doNotIncludeExpiredFields) {
464 AND ( expire_on IS NULL OR expire_on >= {$currentTime} )
468 $orderBy = ' ORDER BY weight';
470 $sql = $select . $from . $where . $dateSelect . $orderBy;
472 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
474 $isDefaultContributionPriceSet = FALSE;
475 if ('default_contribution_amount' == CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $setID)) {
476 $isDefaultContributionPriceSet = TRUE;
479 $visibility = CRM_Core_PseudoConstant
::visibility('name');
480 while ($dao->fetch()) {
483 $setTree[$setID]['fields'][$fieldID] = [];
484 $setTree[$setID]['fields'][$fieldID]['id'] = $fieldID;
486 foreach ($priceFields as $field) {
487 if ($field == 'id' ||
is_null($dao->$field)) {
491 if ($field == 'visibility_id') {
492 $setTree[$setID]['fields'][$fieldID]['visibility'] = $visibility[$dao->$field];
494 $setTree[$setID]['fields'][$fieldID][$field] = $dao->$field;
496 $setTree[$setID]['fields'][$fieldID]['options'] = CRM_Price_BAO_PriceField
::getOptions($fieldID, FALSE, FALSE, $isDefaultContributionPriceSet);
499 // also get the pre and post help from this price set
501 SELECT extends, financial_type_id, help_pre, help_post, is_quick_config, min_amount
502 FROM civicrm_price_set
504 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
506 $setTree[$setID]['extends'] = $dao->extends;
507 $setTree[$setID]['financial_type_id'] = $dao->financial_type_id
;
508 $setTree[$setID]['help_pre'] = $dao->help_pre
;
509 $setTree[$setID]['help_post'] = $dao->help_post
;
510 $setTree[$setID]['is_quick_config'] = $dao->is_quick_config
;
511 $setTree[$setID]['min_amount'] = $dao->min_amount
;
517 * Get the Price Field ID.
519 * We call this function when more than one being present would represent an error
520 * starting format derived from current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))
521 * @param array $priceSet
523 * @throws CRM_Core_Exception
526 public static function getOnlyPriceFieldID(array $priceSet) {
527 if (count($priceSet['fields']) > 1) {
528 throw new CRM_Core_Exception(ts('expected only one price field to be in price set but multiple are present'));
530 return (int) implode('_', array_keys($priceSet['fields']));
534 * Get the Price Field Value ID. We call this function when more than one being present would represent an error
535 * current(CRM_Price_BAO_PriceSet::getSetDetail($priceSetId))
536 * @param array $priceSet
538 * @throws CRM_Core_Exception
541 public static function getOnlyPriceFieldValueID(array $priceSet) {
542 $priceFieldID = self
::getOnlyPriceFieldID($priceSet);
543 if (count($priceSet['fields'][$priceFieldID]['options']) > 1) {
544 throw new CRM_Core_Exception(ts('expected only one price field to be in price set but multiple are present'));
546 return (int) implode('_', array_keys($priceSet['fields'][$priceFieldID]['options']));
550 * Initiate price set such that various non-BAO things are set on the form.
552 * This function is not really a BAO function so the location is misleading.
554 * @param CRM_Core_Form $form
556 * @param string $entityTable
557 * @param bool $doNotIncludeExpiredFields
558 * @param int $priceSetId
561 public static function initSet(&$form, $entityTable = 'civicrm_event', $doNotIncludeExpiredFields = FALSE, $priceSetId = NULL) {
563 //check if price set is is_config
564 if (is_numeric($priceSetId)) {
565 if (CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config') && $form->getVar('_name') != 'Participant') {
566 $form->assign('quickConfig', 1);
571 if ($form->_action
& CRM_Core_Action
::UPDATE
) {
572 $entityId = $entity = NULL;
574 switch ($entityTable) {
575 case 'civicrm_event':
576 $entity = 'participant';
577 if (in_array(CRM_Utils_System
::getClassName($form), ['CRM_Event_Form_Participant', 'CRM_Event_Form_Task_Register'])) {
578 $entityId = $form->_id
;
581 $entityId = $form->_participantId
;
585 case 'civicrm_contribution_page':
586 case 'civicrm_contribution':
587 $entity = 'contribution';
588 $entityId = $form->_id
;
592 if ($entityId && $entity) {
593 $form->_values
['line_items'] = CRM_Price_BAO_LineItem
::getLineItems($entityId, $entity);
601 $form->_priceSetId
= $priceSetId;
602 $priceSet = self
::getSetDetail($priceSetId, $required, $doNotIncludeExpiredFields);
603 $form->_priceSet
= $priceSet[$priceSetId] ??
NULL;
604 $form->_values
['fee'] = $form->_priceSet
['fields'] ??
NULL;
606 //get the price set fields participant count.
607 if ($entityTable == 'civicrm_event') {
608 //get option count info.
609 $form->_priceSet
['optionsCountTotal'] = self
::getPricesetCount($priceSetId);
610 if ($form->_priceSet
['optionsCountTotal']) {
611 $optionsCountDetails = [];
612 if (!empty($form->_priceSet
['fields'])) {
613 foreach ($form->_priceSet
['fields'] as $field) {
614 foreach ($field['options'] as $option) {
615 $count = CRM_Utils_Array
::value('count', $option, 0);
616 $optionsCountDetails['fields'][$field['id']]['options'][$option['id']] = $count;
620 $form->_priceSet
['optionsCountDetails'] = $optionsCountDetails;
623 //get option max value info.
624 $optionsMaxValueTotal = 0;
625 $optionsMaxValueDetails = [];
627 if (!empty($form->_priceSet
['fields'])) {
628 foreach ($form->_priceSet
['fields'] as $field) {
629 foreach ($field['options'] as $option) {
630 $maxVal = CRM_Utils_Array
::value('max_value', $option, 0);
631 $optionsMaxValueDetails['fields'][$field['id']]['options'][$option['id']] = $maxVal;
632 $optionsMaxValueTotal +
= $maxVal;
637 $form->_priceSet
['optionsMaxValueTotal'] = $optionsMaxValueTotal;
638 if ($optionsMaxValueTotal) {
639 $form->_priceSet
['optionsMaxValueDetails'] = $optionsMaxValueDetails;
642 $form->set('priceSetId', $form->_priceSetId
);
643 $form->set('priceSet', $form->_priceSet
);
648 * Get line item purchase information.
650 * This function takes the input parameters and interprets out of it what has been purchased.
653 * This is the output of the function CRM_Price_BAO_PriceSet::getSetDetail($priceSetID, FALSE, FALSE);
654 * And, it would make sense to introduce caching into that function and call it from here rather than
655 * require the $fields array which is passed from pillar to post around the form in order to pass it in here.
656 * @param array $params
657 * Params reflecting form input e.g with fields 'price_5' => 7, 'price_8' => array(7, 8)
659 * Line item array to be altered.
660 * @param int $priceSetID
662 * @todo $priceSetID is a pseudoparam for permit override - we should stop passing it where we
663 * don't specifically need it & find a better way where we do.
665 public static function processAmount($fields, &$params, &$lineItem, $priceSetID = NULL) {
667 $totalPrice = $totalTax = 0;
668 foreach ($fields as $id => $field) {
669 if (empty($params["price_{$id}"]) ||
670 (empty($params["price_{$id}"]) && $params["price_{$id}"] == NULL)
672 // skip if nothing was submitted for this field
676 [$params, $lineItem] = self
::getLine($params, $lineItem, $priceSetID, $field, $id);
680 $totalParticipant = 0;
681 if (is_array($lineItem)) {
682 foreach ($lineItem as $values) {
683 $totalPrice +
= $values['line_total'] +
$values['tax_amount'];
684 $totalTax +
= $values['tax_amount'];
685 $totalParticipant +
= $values['participant_count'];
686 // This is a bit nasty. The logic of 'quick config' was because price set configuration was
687 // (and still is) too difficult to replace the 'quick config' price set configuration on the contribution
690 // However, because the quick config concept existed all sorts of logic was hung off it
691 // and function behaviour sometimes depends on whether 'price set' is set - although actually it
692 // is always set at the functional level. In this case we are dealing with the default 'quick config'
693 // price set having a label of 'Contribution Amount' which could wind up creating a 'funny looking' label.
694 // The correct answer is probably for it to have an empty label in the DB - the label is never shown so it is a
697 // But, in the interests of being careful when capacity is low - avoiding the known default value
699 // Crucially a test has been added so a better solution can be implemented later with some comfort.
700 // @todo - stop setting amount level in this function & call the getAmountLevel function to retrieve it.
701 if ($values['label'] !== ts('Contribution Amount')) {
702 $amount_level[] = $values['label'] . ' - ' . (float) $values['qty'];
707 $displayParticipantCount = '';
708 if ($totalParticipant > 0) {
709 $displayParticipantCount = ' Participant Count -' . $totalParticipant;
711 // @todo - stop setting amount level in this function & call the getAmountLevel function to retrieve it.
712 if (!empty($amount_level)) {
713 $params['amount_level'] = CRM_Utils_Array
::implodePadded($amount_level);
714 if (!empty($displayParticipantCount)) {
715 $params['amount_level'] = CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $amount_level) . $displayParticipantCount . CRM_Core_DAO
::VALUE_SEPARATOR
;
719 $params['amount'] = $totalPrice;
720 $params['tax_amount'] = $totalTax;
724 * Get the text to record for amount level.
726 * @param array $params
727 * Submitted parameters
728 * - priceSetId is required to be set in the calling function
729 * (we don't e-notice check it to enforce that - all payments DO have a price set - even if it is the
730 * default one & this function asks that be set if it is the case).
733 * Text for civicrm_contribution.amount_level field.
735 public static function getAmountLevelText($params) {
736 $priceSetID = $params['priceSetId'];
737 $priceFieldSelection = self
::filterPriceFieldsFromParams($priceSetID, $params);
738 $priceFieldMetadata = self
::getCachedPriceSetDetail($priceSetID);
739 $displayParticipantCount = NULL;
742 foreach ($priceFieldMetadata['fields'] as $field) {
743 if (!empty($priceFieldSelection[$field['id']])) {
745 if ($field['is_enter_qty']) {
746 $qtyString = ' - ' . (float) $params['price_' . $field['id']];
748 // We deliberately & specifically exclude contribution amount as it has a specific meaning.
749 // ie. it represents the default price field for a contribution. Another approach would be not
750 // to give it a label if we don't want it to show.
751 if ($field['label'] !== ts('Contribution Amount')) {
752 $amount_level[] = $field['label'] . $qtyString;
756 return CRM_Core_DAO
::VALUE_SEPARATOR
. implode(CRM_Core_DAO
::VALUE_SEPARATOR
, $amount_level) . $displayParticipantCount . CRM_Core_DAO
::VALUE_SEPARATOR
;
760 * Get the fields relevant to the price field from the parameters.
762 * E.g we are looking for price_5 => 7 out of a big array of input parameters.
764 * @param int $priceSetID
765 * @param array $params
768 * Price fields found in the params array
770 public static function filterPriceFieldsFromParams($priceSetID, $params) {
771 $priceSet = self
::getCachedPriceSetDetail($priceSetID);
773 foreach ($priceSet['fields'] as $field) {
774 if (!empty($params['price_' . $field['id']])) {
775 $return[$field['id']] = $params['price_' . $field['id']];
782 * Wrapper for getSetDetail with caching.
784 * We seem to be passing this array around in a painful way - presumably to avoid the hit
785 * of loading it - so lets make it callable with caching.
787 * Why not just add caching to the other function? We could do - it just seemed a bit unclear the best caching pattern
788 * & the function was already pretty fugly. Also, I feel like we need to migrate the interaction with price-sets into
789 * a more granular interaction - ie. retrieve specific data using specific functions on this class & have the form
790 * think less about the price sets.
792 * @param int $priceSetID
796 public static function getCachedPriceSetDetail($priceSetID) {
797 $cacheKey = __CLASS__
. __FUNCTION__
. '_' . $priceSetID;
798 $cache = CRM_Utils_Cache
::singleton();
799 $values = $cache->get($cacheKey);
800 if (empty($values)) {
801 $data = self
::getSetDetail($priceSetID);
802 $values = $data[$priceSetID];
803 $cache->set($cacheKey, $values);
809 * Build the price set form.
811 * @param CRM_Core_Form $form
815 public static function buildPriceSet(&$form) {
816 $priceSetId = $form->get('priceSetId');
821 $validFieldsOnly = TRUE;
822 $className = CRM_Utils_System
::getClassName($form);
823 if (in_array($className, [
824 'CRM_Contribute_Form_Contribution',
825 'CRM_Member_Form_Membership',
827 $validFieldsOnly = FALSE;
830 $priceSet = self
::getSetDetail($priceSetId, TRUE, $validFieldsOnly);
831 $form->_priceSet
= $priceSet[$priceSetId] ??
NULL;
832 $validPriceFieldIds = array_keys($form->_priceSet
['fields']);
833 $form->_quickConfig
= $quickConfig = 0;
834 if (CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config')) {
838 $form->assign('quickConfig', $quickConfig);
839 if ($className == 'CRM_Contribute_Form_Contribution_Main') {
840 $form->_quickConfig
= $quickConfig;
843 // Mark which field should have the auto-renew checkbox, if any. CRM-18305
844 if (!empty($form->_membershipTypeValues
) && is_array($form->_membershipTypeValues
)) {
845 $autoRenewMembershipTypes = [];
846 foreach ($form->_membershipTypeValues
as $membershipTypeValue) {
847 if ($membershipTypeValue['auto_renew']) {
848 $autoRenewMembershipTypes[] = $membershipTypeValue['id'];
851 foreach ($form->_priceSet
['fields'] as $field) {
852 if (array_key_exists('options', $field) && is_array($field['options'])) {
853 foreach ($field['options'] as $option) {
854 if (!empty($option['membership_type_id'])) {
855 if (in_array($option['membership_type_id'], $autoRenewMembershipTypes)) {
856 $form->_priceSet
['auto_renew_membership_field'] = $field['id'];
857 // Only one field can offer auto_renew memberships, so break here.
865 $form->_priceSet
['id'] = $form->_priceSet
['id'] ??
$priceSetId;
866 $form->assign('priceSet', $form->_priceSet
);
868 $component = 'contribution';
869 if ($className == 'CRM_Member_Form_Membership') {
870 $component = 'membership';
873 if ($className == 'CRM_Contribute_Form_Contribution_Main') {
874 $feeBlock = &$form->_values
['fee'];
875 if (!empty($form->_useForMember
)) {
876 $component = 'membership';
880 $feeBlock = &$form->_priceSet
['fields'];
883 // Call the buildAmount hook.
884 CRM_Utils_Hook
::buildAmount($component, $form, $feeBlock);
886 self
::addPriceFieldsToForm($form, $feeBlock, $validFieldsOnly, $className, $validPriceFieldIds);
890 * Apply ACLs on Financial Type to the price options in a fee block.
892 * @param array $feeBlock
893 * Fee block: array of price fields.
895 * @deprecated not used in civi universe as at Oct 2020.
899 public static function applyACLFinancialTypeStatusToFeeBlock(&$feeBlock) {
900 CRM_Core_Error
::deprecatedFunctionWarning('enacted in financialtypeacl extension');
901 if (CRM_Financial_BAO_FinancialType
::isACLFinancialTypeStatus()) {
902 foreach ($feeBlock as $key => $value) {
903 foreach ($value['options'] as $k => $options) {
904 if (!CRM_Core_Permission
::check('add contributions of type ' . CRM_Contribute_PseudoConstant
::financialType($options['financial_type_id']))) {
905 unset($feeBlock[$key]['options'][$k]);
908 if (empty($feeBlock[$key]['options'])) {
909 unset($feeBlock[$key]);
916 * Check the current Membership having end date null.
918 * @param array $options
920 * Probably actually contact ID.
924 public static function checkCurrentMembership(&$options, $userid) {
925 if (!$userid ||
empty($options)) {
928 static $_contact_memberships = [];
929 $checkLifetime = FALSE;
930 foreach ($options as $key => $value) {
931 if (!empty($value['membership_type_id'])) {
932 if (!isset($_contact_memberships[$userid][$value['membership_type_id']])) {
933 $_contact_memberships[$userid][$value['membership_type_id']] = CRM_Member_BAO_Membership
::getContactMembership($userid, $value['membership_type_id'], FALSE);
935 $currentMembership = $_contact_memberships[$userid][$value['membership_type_id']];
936 if (!empty($currentMembership) && empty($currentMembership['end_date'])) {
937 unset($options[$key]);
938 $checkLifetime = TRUE;
942 if ($checkLifetime) {
951 * Set daefult the price set fields.
953 * @param CRM_Core_Form $form
958 public static function setDefaultPriceSet(&$form, &$defaults) {
959 if (!isset($form->_priceSet
) ||
empty($form->_priceSet
['fields'])) {
963 foreach ($form->_priceSet
['fields'] as $val) {
964 foreach ($val['options'] as $keys => $values) {
965 // build price field index which is passed via URL
966 // url format will be appended by "&price_5=11"
967 $priceFieldName = 'price_' . $values['price_field_id'];
968 $priceFieldValue = self
::getPriceFieldValueFromURL($form, $priceFieldName);
969 if (!empty($priceFieldValue)) {
970 self
::setDefaultPriceSetField($priceFieldName, $priceFieldValue, $val['html_type'], $defaults);
971 // break here to prevent overwriting of default due to 'is_default'
972 // option configuration. The value sent via URL get's higher priority.
975 elseif ($values['is_default']) {
976 self
::setDefaultPriceSetField($priceFieldName, $keys, $val['html_type'], $defaults);
984 * Get the value of price field if passed via url
986 * @param string $priceFieldName
987 * @param string $priceFieldValue
988 * @param string $priceFieldType
989 * @param array $defaults
993 public static function setDefaultPriceSetField($priceFieldName, $priceFieldValue, $priceFieldType, &$defaults) {
994 if ($priceFieldType == 'CheckBox') {
995 $defaults[$priceFieldName][$priceFieldValue] = 1;
998 $defaults[$priceFieldName] = $priceFieldValue;
1003 * Get the value of price field if passed via url
1005 * @param CRM_Core_Form $form
1006 * @param string $priceFieldName
1008 * @return mixed $priceFieldValue
1010 public static function getPriceFieldValueFromURL(&$form, $priceFieldName) {
1011 $priceFieldValue = CRM_Utils_Request
::retrieve($priceFieldName, 'String', $form, FALSE, NULL, 'GET');
1012 if (!empty($priceFieldValue)) {
1013 return $priceFieldValue;
1018 * Supports event create function by setting up required price sets, not tested but expect
1019 * it will work for contribution page
1020 * @param array $params
1021 * As passed to api/bao create fn.
1022 * @param CRM_Core_DAO $entity
1023 * Object for given entity.
1024 * @param string $entityName
1025 * Name of entity - e.g event.
1027 public static function setPriceSets(&$params, $entity, $entityName) {
1028 if (empty($params['price_set_id']) ||
!is_array($params['price_set_id'])) {
1031 // CRM-14069 note that we may as well start by assuming more than one.
1032 // currently the form does not pass in as an array & will be skipped
1033 // test is passing in as an array but I feel the api should have a metadata that allows
1034 // transform of single to array - seems good for managing transitions - in which case all api
1035 // calls that set price_set_id will hit this
1036 // e.g in getfields 'price_set_id' => array('blah', 'bao_type' => 'array') - causing
1037 // all separated values, strings, json half-separated values (in participant we hit this)
1038 // to be converted to json @ api layer
1039 $pse = new CRM_Price_DAO_PriceSetEntity();
1040 $pse->entity_table
= 'civicrm_' . $entityName;
1041 $pse->entity_id
= $entity->id
;
1042 while ($pse->fetch()) {
1043 if (!in_array($pse->price_set_id
, $params['price_set_id'])) {
1044 // note an even more aggressive form of this deletion currently happens in event form
1045 // past price sets discounts are made inaccessible by this as the discount_id is set to NULL
1046 // on the participant record
1047 if (CRM_Price_BAO_PriceSet
::removeFrom('civicrm_' . $entityName, $entity->id
)) {
1048 CRM_Core_BAO_Discount
::del($entity->id
, 'civicrm_' . $entityName);
1052 foreach ($params['price_set_id'] as $priceSetID) {
1053 CRM_Price_BAO_PriceSet
::addTo('civicrm_' . $entityName, $entity->id
, $priceSetID);
1054 //@todo - how should we do this - copied from form
1055 //if (!empty($params['price_field_id'])) {
1056 // $priceSetID = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceField', $params['price_field_id'], 'price_set_id');
1057 // CRM_Price_BAO_PriceSet::setIsQuickConfig($priceSetID, 0);
1063 * Get field ids of a price set.
1069 * Array of the field ids
1072 public static function getFieldIds($id) {
1073 $priceField = new CRM_Price_DAO_PriceField();
1074 $priceField->price_set_id
= $id;
1075 $priceField->find();
1076 while ($priceField->fetch()) {
1077 $var[] = $priceField->id
;
1083 * Copy a price set, including all the fields
1086 * The price set id to copy.
1088 * @return CRM_Price_DAO_PriceSet
1090 public static function copy($id) {
1091 $maxId = CRM_Core_DAO
::singleValueQuery("SELECT max(id) FROM civicrm_price_set");
1092 $priceSet = civicrm_api3('PriceSet', 'getsingle', ['id' => $id]);
1094 $newTitle = preg_replace('/\[Copy id \d+\]$/', "", $priceSet['title']);
1095 $title = ts('[Copy id %1]', [1 => $maxId +
1]);
1098 'title' => trim($newTitle) . ' ' . $title,
1099 'name' => substr($priceSet['name'], 0, 20) . 'price_set_' . ($maxId +
1),
1103 $copy = CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceSet',
1109 //copying all the blocks pertaining to the price set
1110 $copyPriceField = CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceField',
1111 ['price_set_id' => $id],
1112 ['price_set_id' => $copy->id
]
1114 if (!empty($copyPriceField)) {
1115 $price = array_combine(self
::getFieldIds($id), self
::getFieldIds($copy->id
));
1117 //copy option group and values
1118 foreach ($price as $originalId => $copyId) {
1119 CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceFieldValue',
1120 ['price_field_id' => $originalId],
1121 ['price_field_id' => $copyId]
1127 CRM_Utils_Hook
::copy('Set', $copy);
1128 unset(\Civi
::$statics['CRM_Core_PseudoConstant']);
1133 * check price set permission.
1139 * @throws \CRM_Core_Exception
1141 public static function checkPermission($sid) {
1142 if ($sid && self
::eventPriceSetDomainID()) {
1143 $domain_id = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $sid, 'domain_id', 'id');
1144 if (CRM_Core_Config
::domainID() != $domain_id) {
1145 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
1152 * Get the sum of participant count
1153 * for all fields of given price set.
1158 * @param bool $onlyActive
1160 * @return int|null|string
1162 public static function getPricesetCount($sid, $onlyActive = TRUE) {
1170 $where = 'AND value.is_active = 1 AND field.is_active = 1';
1173 static $pricesetFieldCount = [];
1174 if (!isset($pricesetFieldCount[$sid])) {
1176 SELECT sum(value.count) as totalCount
1177 FROM civicrm_price_field_value value
1178 INNER JOIN civicrm_price_field field ON ( field.id = value.price_field_id )
1179 INNER JOIN civicrm_price_set pset ON ( pset.id = field.price_set_id )
1183 $count = CRM_Core_DAO
::singleValueQuery($sql, [1 => [$sid, 'Positive']]);
1184 $pricesetFieldCount[$sid] = ($count) ?
$count : 0;
1187 return $pricesetFieldCount[$sid];
1191 * Return a count of priceFieldValueIDs that are memberships by organisation and membership type
1193 * @param string $priceFieldValueIDs
1194 * Comma separated string of priceFieldValue IDs
1197 * Returns an array of counts by membership organisation
1199 public static function getMembershipCount($priceFieldValueIDs) {
1201 SELECT count( pfv.id ) AS count, mt.member_of_contact_id AS id
1202 FROM civicrm_price_field_value pfv
1203 INNER JOIN civicrm_membership_type mt ON mt.id = pfv.membership_type_id
1204 WHERE pfv.id IN ( $priceFieldValueIDs )
1205 GROUP BY mt.member_of_contact_id ";
1207 $crmDAO = CRM_Core_DAO
::executeQuery($queryString);
1210 while ($crmDAO->fetch()) {
1211 $count[$crmDAO->id
] = $crmDAO->count
;
1218 * Check if auto renew option should be shown.
1220 * The auto-renew option should be visible if membership types associated with all the fields has
1221 * been set for auto-renew option.
1223 * Auto renew checkbox should be frozen if for all the membership type auto renew is required
1225 * @param int $priceSetId
1229 * $autoRenewOption ( 0:hide, 1:optional 2:required )
1231 public static function checkAutoRenewForPriceSet($priceSetId) {
1232 $query = 'SELECT DISTINCT mt.auto_renew, mt.duration_interval, mt.duration_unit,
1233 pf.html_type, pf.id as price_field_id
1234 FROM civicrm_price_field_value pfv
1235 INNER JOIN civicrm_membership_type mt ON pfv.membership_type_id = mt.id
1236 INNER JOIN civicrm_price_field pf ON pfv.price_field_id = pf.id
1237 WHERE pf.price_set_id = %1
1238 AND pf.is_active = 1
1239 AND pfv.is_active = 1
1240 ORDER BY price_field_id';
1242 $params = [1 => [$priceSetId, 'Integer']];
1244 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1246 //CRM-18050: Check count of price set fields which has been set with auto-renew option.
1247 //If price set field is already present with auto-renew option then, it will restrict for adding another price set field with auto-renew option.
1252 $autoRenewOption = 2;
1254 while ($dao->fetch()) {
1255 if (!$dao->auto_renew
) {
1256 // If any one can't be renewed none can.
1259 if ($dao->auto_renew
== 1) {
1260 $autoRenewOption = 1;
1263 if ($dao->html_type
== 'Checkbox' && !in_array($dao->duration_interval
. $dao->duration_unit
, $priceFields[$dao->price_field_id
])) {
1264 // Checkbox fields cannot support auto-renew if they have more than one duration configuration
1265 // as more than one can be selected. Radio and select are either-or so they can have more than one duration.
1268 $priceFields[$dao->price_field_id
][] = $dao->duration_interval
. $dao->duration_unit
;
1269 foreach ($priceFields as $priceFieldID => $durations) {
1270 if ($priceFieldID != $dao->price_field_id
&& !in_array($dao->duration_interval
. $dao->duration_unit
, $durations)) {
1271 // Another price field has a duration configuration that differs so we can't offer auto-renew.
1277 return $autoRenewOption;
1281 * Retrieve auto renew frequency and interval.
1283 * @param int $priceSetId
1287 * associate array of frequency interval and unit
1289 public static function getRecurDetails($priceSetId) {
1290 $query = 'SELECT mt.duration_interval, mt.duration_unit
1291 FROM civicrm_price_field_value pfv
1292 INNER JOIN civicrm_membership_type mt ON pfv.membership_type_id = mt.id
1293 INNER JOIN civicrm_price_field pf ON pfv.price_field_id = pf.id
1294 WHERE pf.price_set_id = %1 LIMIT 1';
1296 $params = [1 => [$priceSetId, 'Integer']];
1297 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1299 return [$dao->duration_interval
, $dao->duration_unit
];
1305 public static function eventPriceSetDomainID() {
1306 return Civi
::settings()->get('event_price_set_domain_id');
1310 * Update the is_quick_config flag in the db.
1313 * Id of the database record.
1314 * @param bool $isQuickConfig we want to set the is_quick_config field.
1315 * Value we want to set the is_quick_config field.
1318 * true if we found and updated the object, else false
1320 public static function setIsQuickConfig($id, $isQuickConfig) {
1321 return CRM_Core_DAO
::setFieldValue('CRM_Price_DAO_PriceSet', $id, 'is_quick_config', $isQuickConfig);
1325 * Check if price set id provides option for user to select both auto-renew and non-auto-renew memberships
1331 public static function isMembershipPriceSetContainsMixOfRenewNonRenew($id) {
1332 $membershipTypes = self
::getMembershipTypesFromPriceSet($id);
1333 if (!empty($membershipTypes['autorenew']) && !empty($membershipTypes['non_renew'])) {
1340 * Get an array of the membership types in a price set.
1345 * Membership types in the price set
1347 public static function getMembershipTypesFromPriceSet($id) {
1349 = "SELECT pfv.id, pfv.price_field_id, pfv.name, pfv.membership_type_id, pf.html_type, mt.auto_renew
1350 FROM civicrm_price_field_value pfv
1351 LEFT JOIN civicrm_price_field pf ON pf.id = pfv.price_field_id
1352 LEFT JOIN civicrm_price_set ps ON ps.id = pf.price_set_id
1353 LEFT JOIN civicrm_membership_type mt ON mt.id = pfv.membership_type_id
1357 $params = [1 => [$id, 'Integer']];
1358 $dao = CRM_Core_DAO
::executeQuery($query, $params);
1360 $membershipTypes = [
1363 'autorenew_required' => [],
1364 'autorenew_optional' => [],
1366 while ($dao->fetch()) {
1367 if (empty($dao->membership_type_id
)) {
1370 $membershipTypes['all'][] = $dao->membership_type_id
;
1371 if (!empty($dao->auto_renew
)) {
1372 $membershipTypes['autorenew'][] = $dao->membership_type_id
;
1373 if ($dao->auto_renew
== 2) {
1374 $membershipTypes['autorenew_required'][] = $dao->membership_type_id
;
1377 $membershipTypes['autorenew_optional'][] = $dao->membership_type_id
;
1381 $membershipTypes['non_renew'][] = $dao->membership_type_id
;
1384 return $membershipTypes;
1388 * Copy priceSet when event/contibution page is copied
1390 * @param string $baoName
1393 * Old event/contribution page id.
1395 * Newly created event/contribution page id.
1397 public static function copyPriceSet($baoName, $id, $newId) {
1398 $priceSetId = CRM_Price_BAO_PriceSet
::getFor($baoName, $id);
1400 $isQuickConfig = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $priceSetId, 'is_quick_config');
1401 if ($isQuickConfig) {
1402 $copyPriceSet = CRM_Price_BAO_PriceSet
::copy($priceSetId);
1403 CRM_Price_BAO_PriceSet
::addTo($baoName, $newId, $copyPriceSet->id
);
1406 $copyPriceSet = CRM_Core_DAO
::copyGeneric('CRM_Price_DAO_PriceSetEntity',
1409 'entity_table' => $baoName,
1411 ['entity_id' => $newId]
1414 // copy event discount
1415 if ($baoName == 'civicrm_event') {
1416 $discount = CRM_Core_BAO_Discount
::getOptionGroup($id, 'civicrm_event');
1417 foreach ($discount as $discountId => $setId) {
1419 $copyPriceSet = &CRM_Price_BAO_PriceSet
::copy($setId);
1421 CRM_Core_DAO
::copyGeneric(
1422 'CRM_Core_DAO_Discount',
1424 'id' => $discountId,
1427 'entity_id' => $newId,
1428 'price_set_id' => $copyPriceSet->id
,
1437 * Function to set tax_amount and tax_rate in LineItem.
1439 * @param array $field
1440 * @param array $lineItem
1441 * @param int $optionValueId
1442 * @param float $totalTax
1446 public static function setLineItem($field, $lineItem, $optionValueId, &$totalTax) {
1447 // Here we round - i.e. after multiplying by quantity
1448 if ($field['html_type'] == 'Text') {
1449 $taxAmount = round($field['options'][$optionValueId]['tax_amount'] * $lineItem[$optionValueId]['qty'], 2);
1452 $taxAmount = round($field['options'][$optionValueId]['tax_amount'], 2);
1454 $taxRate = $field['options'][$optionValueId]['tax_rate'];
1455 $lineItem[$optionValueId]['tax_amount'] = $taxAmount;
1456 $lineItem[$optionValueId]['tax_rate'] = $taxRate;
1457 $totalTax +
= $taxAmount;
1462 * Get the first price set value IDs from a parameters array.
1464 * In practice this is really used when we only expect one to exist.
1466 * @param array $params
1469 * Array of the ids of the price set values.
1471 public static function parseFirstPriceSetValueIDFromParams($params) {
1472 $priceSetValueIDs = self
::parsePriceSetValueIDsFromParams($params);
1473 return reset($priceSetValueIDs);
1477 * Get the price set value IDs from a set of parameters
1479 * @param array $params
1482 * Array of the ids of the price set values.
1484 public static function parsePriceSetValueIDsFromParams($params) {
1485 $priceSetParams = self
::parsePriceSetArrayFromParams($params);
1486 $priceSetValueIDs = [];
1487 foreach ($priceSetParams as $priceSetParam) {
1488 foreach (array_keys($priceSetParam) as $priceValueID) {
1489 $priceSetValueIDs[] = $priceValueID;
1492 return $priceSetValueIDs;
1496 * Get the price set value IDs from a set of parameters
1498 * @param array $params
1501 * Array of price fields filtered from the params.
1503 public static function parsePriceSetArrayFromParams($params) {
1504 $priceSetParams = [];
1505 foreach ($params as $field => $value) {
1506 $parts = explode('_', $field);
1507 if (count($parts) == 2 && $parts[0] == 'price' && is_numeric($parts[1]) && is_array($value)) {
1508 $priceSetParams[$field] = $value;
1511 return $priceSetParams;
1515 * Get non-deductible amount from price options
1517 * @param int $priceSetId
1518 * @param array $lineItem
1521 * calculated non-deductible amount.
1523 public static function getNonDeductibleAmountFromPriceSet($priceSetId, $lineItem) {
1524 $nonDeductibleAmount = 0;
1525 if (!empty($lineItem[$priceSetId])) {
1526 foreach ($lineItem[$priceSetId] as $options) {
1527 $nonDeductibleAmount +
= $options['non_deductible_amount'] * $options['qty'];
1531 return $nonDeductibleAmount;
1535 * Get an array of all forms using a given price set.
1540 * Pages using the price set, keyed by type. e.g
1542 * 'civicrm_contribution_page' => array(2,5,6),
1543 * 'civicrm_event' => array(5,6),
1544 * 'civicrm_event_template' => array(7),
1547 public static function getFormsUsingPriceSet($id) {
1550 SELECT entity_table, entity_id
1551 FROM civicrm_price_set_entity
1552 WHERE price_set_id = %1";
1553 $params = [1 => [$id, 'Integer']];
1554 $crmFormDAO = CRM_Core_DAO
::executeQuery($queryString, $params);
1556 while ($crmFormDAO->fetch()) {
1557 $forms[$crmFormDAO->entity_table
][] = $crmFormDAO->entity_id
;
1563 * @param array $forms
1564 * Array of forms that use a price set keyed by entity. e.g
1566 * 'civicrm_contribution_page' => array(2,5,6),
1567 * 'civicrm_event' => array(5,6),
1568 * 'civicrm_event_template' => array(7),
1572 * Array of entities suppliemented with per entity information.
1574 * array('civicrm_event' => array(7 => array('title' => 'x'...))
1576 * @throws \Exception
1578 protected static function reformatUsedByFormsWithEntityData($forms) {
1580 foreach ($forms as $table => $entities) {
1582 case 'civicrm_event':
1583 $ids = implode(',', $entities);
1584 $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
1585 FROM civicrm_event ce
1586 LEFT JOIN civicrm_option_value ON
1587 ( ce.event_type_id = civicrm_option_value.value )
1588 LEFT JOIN civicrm_option_group ON
1589 ( civicrm_option_group.id = civicrm_option_value.option_group_id )
1591 civicrm_option_group.name = 'event_type' AND
1594 $crmDAO = CRM_Core_DAO
::executeQuery($queryString);
1595 while ($crmDAO->fetch()) {
1596 if ($crmDAO->isTemplate
) {
1597 $usedBy['civicrm_event_template'][$crmDAO->id
]['title'] = $crmDAO->templateTitle
;
1598 $usedBy['civicrm_event_template'][$crmDAO->id
]['eventType'] = $crmDAO->eventType
;
1599 $usedBy['civicrm_event_template'][$crmDAO->id
]['isPublic'] = $crmDAO->isPublic
;
1602 $usedBy[$table][$crmDAO->id
]['title'] = $crmDAO->title
;
1603 $usedBy[$table][$crmDAO->id
]['eventType'] = $crmDAO->eventType
;
1604 $usedBy[$table][$crmDAO->id
]['startDate'] = $crmDAO->startDate
;
1605 $usedBy[$table][$crmDAO->id
]['endDate'] = $crmDAO->endDate
;
1606 $usedBy[$table][$crmDAO->id
]['isPublic'] = $crmDAO->isPublic
;
1611 case 'civicrm_contribution_page':
1612 $ids = implode(',', $entities);
1613 $queryString = "SELECT cp.id as id, cp.title as title, cp.start_date as startDate, cp.end_date as endDate,ct.name as type
1614 FROM civicrm_contribution_page cp, civicrm_financial_type ct
1615 WHERE ct.id = cp.financial_type_id AND
1618 $crmDAO = CRM_Core_DAO
::executeQuery($queryString);
1619 while ($crmDAO->fetch()) {
1620 $usedBy[$table][$crmDAO->id
]['title'] = $crmDAO->title
;
1621 $usedBy[$table][$crmDAO->id
]['type'] = $crmDAO->type
;
1622 $usedBy[$table][$crmDAO->id
]['startDate'] = $crmDAO->startDate
;
1623 $usedBy[$table][$crmDAO->id
]['endDate'] = $crmDAO->endDate
;
1627 case 'civicrm_contribution':
1628 case 'civicrm_membership':
1629 case 'civicrm_participant':
1630 $usedBy[$table] = 1;
1634 throw new CRM_Core_Exception("$table is not supported in PriceSet::usedBy()");
1642 * Get the relevant line item.
1644 * Note this is part of code being cleaned up / refactored & may change.
1646 * @param array $params
1647 * @param array $lineItem
1648 * @param int $priceSetID
1649 * @param array $field
1654 public static function getLine(&$params, &$lineItem, $priceSetID, $field, $id): array {
1656 switch ($field['html_type']) {
1658 $firstOption = reset($field['options']);
1659 $params["price_{$id}"] = [$firstOption['id'] => $params["price_{$id}"]];
1660 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem);
1661 $optionValueId = key($field['options']);
1663 if (CRM_Utils_Array
::value('name', $field['options'][$optionValueId]) === 'contribution_amount') {
1664 $taxRates = CRM_Core_PseudoConstant
::getTaxRates();
1665 if (array_key_exists($params['financial_type_id'], $taxRates)) {
1666 $field['options'][key($field['options'])]['tax_rate'] = $taxRates[$params['financial_type_id']];
1667 $taxAmount = CRM_Contribute_BAO_Contribution_Utils
::calculateTaxAmount($field['options'][$optionValueId]['amount'], $field['options'][$optionValueId]['tax_rate']);
1668 $field['options'][$optionValueId]['tax_amount'] = round($taxAmount['tax_amount'], 2);
1671 if (!empty($field['options'][$optionValueId]['tax_rate'])) {
1672 $lineItem = self
::setLineItem($field, $lineItem, $optionValueId, $totalTax);
1677 //special case if user select -none-
1678 if ($params["price_{$id}"] <= 0) {
1681 $params["price_{$id}"] = [$params["price_{$id}"] => 1];
1682 $optionValueId = CRM_Utils_Array
::key(1, $params["price_{$id}"]);
1684 // CRM-18701 Sometimes the amount in the price set is overridden by the amount on the form.
1685 // This is notably the case with memberships and we need to put this amount
1686 // on the line item rather than the calculated amount.
1687 // This seems to only affect radio link items as that is the use case for the 'quick config'
1688 // set up (which allows a free form field).
1689 // @todo $priceSetID is a pseudoparam for permit override - we should stop passing it where we
1690 // don't specifically need it & find a better way where we do.
1691 $amount_override = NULL;
1693 if ($priceSetID && count(self
::filterPriceFieldsFromParams($priceSetID, $params)) === 1) {
1694 $amount_override = CRM_Utils_Array
::value('total_amount', $params);
1696 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem, $amount_override);
1697 if (!empty($field['options'][$optionValueId]['tax_rate'])) {
1698 $lineItem = self
::setLineItem($field, $lineItem, $optionValueId, $totalTax);
1699 if ($amount_override) {
1700 $lineItem[$optionValueId]['line_total'] = $lineItem[$optionValueId]['unit_price'] = CRM_Utils_Rule
::cleanMoney($lineItem[$optionValueId]['line_total'] - $lineItem[$optionValueId]['tax_amount']);
1706 $params["price_{$id}"] = [$params["price_{$id}"] => 1];
1707 $optionValueId = CRM_Utils_Array
::key(1, $params["price_{$id}"]);
1709 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem);
1710 if (!empty($field['options'][$optionValueId]['tax_rate'])) {
1711 $lineItem = self
::setLineItem($field, $lineItem, $optionValueId, $totalTax);
1717 CRM_Price_BAO_LineItem
::format($id, $params, $field, $lineItem);
1718 foreach ($params["price_{$id}"] as $optionId => $option) {
1719 if (!empty($field['options'][$optionId]['tax_rate'])) {
1720 $lineItem = self
::setLineItem($field, $lineItem, $optionId, $totalTax);
1725 return [$params, $lineItem];
1729 * Add the relevant price fields to the form.
1731 * @param \CRM_Core_Form $form
1732 * @param array $feeBlock
1733 * @param bool $validFieldsOnly
1734 * @param string $className
1735 * @param array $validPriceFieldIds
1737 protected static function addPriceFieldsToForm(CRM_Core_Form
$form, $feeBlock, bool $validFieldsOnly, string $className, array $validPriceFieldIds) {
1738 $hideAdminValues = !CRM_Core_Permission
::check('edit contributions');
1739 // CRM-14492 Admin price fields should show up on event registration if user has 'administer CiviCRM' permissions
1740 $adminFieldVisible = CRM_Core_Permission
::check('administer CiviCRM');
1741 foreach ($feeBlock as $id => $field) {
1742 if (CRM_Utils_Array
::value('visibility', $field) == 'public' ||
1743 (CRM_Utils_Array
::value('visibility', $field) == 'admin' && $adminFieldVisible == TRUE) ||
1746 $options = $field['options'] ??
NULL;
1747 if ($className == 'CRM_Contribute_Form_Contribution_Main' && $component = 'membership') {
1748 $userid = $form->getVar('_membershipContactID');
1749 $checklifetime = self
::checkCurrentMembership($options, $userid);
1750 if ($checklifetime) {
1751 $form->assign('ispricelifetime', TRUE);
1755 $formClasses = ['CRM_Contribute_Form_Contribution', 'CRM_Member_Form_Membership'];
1757 if (!is_array($options) ||
!in_array($id, $validPriceFieldIds)) {
1760 elseif ($hideAdminValues && !in_array($className, $formClasses)) {
1761 foreach ($options as $key => $currentOption) {
1762 if ($currentOption['visibility_id'] == CRM_Price_BAO_PriceField
::getVisibilityOptionID('admin')) {
1763 unset($options[$key]);
1767 if (!empty($options)) {
1768 CRM_Price_BAO_PriceField
::addQuickFormElement($form,
1769 'price_' . $field['id'],
1772 CRM_Utils_Array
::value('is_required', $field, FALSE),