3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2019 |
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-2019
35 * form to process actions on Membership
37 class CRM_Member_Form_MembershipBlock
extends CRM_Contribute_Form_ContributionPage
{
40 * Store membership price set id
43 protected $_memPriceSetId = NULL;
46 * Set default values for the form. Note that in edit/view mode
47 * the default values are retrieved from the database
52 public function setDefaultValues() {
53 //parent::setDefaultValues();
55 if (isset($this->_id
)) {
56 $defaults = CRM_Member_BAO_Membership
::getMembershipBlock($this->_id
);
58 $defaults['member_is_active'] = $defaults['is_active'];
60 // Set Display Minimum Fee default to true if we are adding a new membership block
61 if (!isset($defaults['id'])) {
62 $defaults['display_min_fee'] = 1;
65 $this->assign('membershipBlockId', $defaults['id']);
68 ($priceSetId = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $this->_id
, 3, 1))
70 $defaults['member_price_set_id'] = $priceSetId;
71 $this->_memPriceSetId
= $priceSetId;
74 // for membership_types
75 // if ( isset( $defaults['membership_types'] ) ) {
76 $priceSetId = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $this->_id
, 3);
77 $this->assign('isQuick', 1);
78 $this->_memPriceSetId
= $priceSetId;
81 CRM_Core_DAO
::commonRetrieveAll('CRM_Price_DAO_PriceField', 'price_set_id', $priceSetId, $pFIDs, $return = [
86 foreach ($pFIDs as $pid => $pValue) {
87 if ($pValue['html_type'] == 'Radio' && $pValue['name'] == 'membership_amount') {
88 $defaults['mem_price_field_id'] = $pValue['id'];
89 $defaults['membership_type_label'] = $pValue['label'];
93 if (!empty($defaults['mem_price_field_id'])) {
95 $priceFieldOptions = CRM_Price_BAO_PriceFieldValue
::getValues($defaults['mem_price_field_id'], $options, 'id', 1);
96 foreach ($options as $k => $v) {
97 $newMembershipType[$v['membership_type_id']] = 1;
98 if (!empty($defaults['auto_renew'])) {
99 $defaults["auto_renew_" . $v['membership_type_id']] = $defaults['auto_renew'][$v['membership_type_id']];
102 $defaults['membership_type'] = $newMembershipType;
111 * Build the form object.
115 public function buildQuickForm() {
116 $membershipTypes = CRM_Member_BAO_MembershipType
::getMembershipTypes();
118 if (!empty($membershipTypes)) {
119 $this->addElement('checkbox', 'member_is_active', ts('Membership Section Enabled?'));
121 $this->addElement('text', 'new_title', ts('Title - New Membership'), CRM_Core_DAO
::getAttribute('CRM_Member_DAO_MembershipBlock', 'new_title'));
123 $this->add('wysiwyg', 'new_text', ts('Introductory Message - New Memberships'), CRM_Core_DAO
::getAttribute('CRM_Member_DAO_MembershipBlock', 'new_text'));
125 $this->addElement('text', 'renewal_title', ts('Title - Renewals'), CRM_Core_DAO
::getAttribute('CRM_Member_DAO_MembershipBlock', 'renewal_title'));
127 $this->add('wysiwyg', 'renewal_text', ts('Introductory Message - Renewals'), CRM_Core_DAO
::getAttribute('CRM_Member_DAO_MembershipBlock', 'renewal_text'));
129 $this->addElement('checkbox', 'is_required', ts('Require Membership Signup'));
130 $this->addElement('checkbox', 'display_min_fee', ts('Display Membership Fee'));
131 $this->addElement('checkbox', 'is_separate_payment', ts('Separate Membership Payment'));
132 $this->addElement('text', 'membership_type_label', ts('Membership Types Label'), ['placeholder' => ts('Membership')]);
134 $paymentProcessor = CRM_Core_PseudoConstant
::paymentProcessor(FALSE, FALSE, 'is_recur = 1');
135 $paymentProcessorIds = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
136 $this->_id
, 'payment_processor'
138 $paymentProcessorId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $paymentProcessorIds);
140 foreach ($paymentProcessorId as $dontCare => $id) {
141 if (!array_key_exists($id, $paymentProcessor)) {
147 $membership = $membershipDefault = $params = [];
148 foreach ($membershipTypes as $k => $v) {
149 $membership[] = $this->createElement('advcheckbox', $k, NULL, $v);
150 $membershipDefault[] = $this->createElement('radio', NULL, NULL, NULL, $k);
151 $membershipRequired[$k] = NULL;
153 $autoRenew = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType', $k, 'auto_renew');
154 $membershipRequired[$k] = $autoRenew;
155 $autoRenewOptions = [];
157 $autoRenewOptions = [ts('Not offered'), ts('Give option'), ts('Required')];
158 $this->addElement('select', "auto_renew_$k", ts('Auto-renew'), $autoRenewOptions);
160 if ($autoRenew == 2) {
161 $this->freeze("auto_renew_$k");
162 $params['id'] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipBlock', $this->_id
, 'id', 'entity_id');
164 $this->_renewOption
[$k] = $autoRenew;
170 if (!empty($params['id'])) {
171 $params['membership_types'] = serialize($membershipRequired);
172 CRM_Member_BAO_MembershipBlock
::create($params);
174 $this->add('hidden', "mem_price_field_id", '', ['id' => "mem_price_field_id"]);
175 $this->assign('is_recur', $isRecur);
176 if (isset($this->_renewOption
)) {
177 $this->assign('auto_renew', $this->_renewOption
);
179 $this->addGroup($membership, 'membership_type', ts('Membership Types'));
180 $this->addGroup($membershipDefault, 'membership_type_default', ts('Membership Types Default'))
181 ->setAttribute('allowClear', TRUE);
183 $this->addFormRule(['CRM_Member_Form_MembershipBlock', 'formRule'], $this->_id
);
185 $price = CRM_Price_BAO_PriceSet
::getAssoc(FALSE, 'CiviMember');
186 if (CRM_Utils_System
::isNull($price)) {
187 $this->assign('price', FALSE);
190 $this->assign('price', TRUE);
192 //$this->add('select', 'member_price_set_id', ts('Membership Price Set'), (['' => ts('- none -')] + $price));
194 $this->addField('member_price_set_id', [
195 'entity' => 'PriceSet',
196 'name' => 'price_set_id',
200 $session = CRM_Core_Session
::singleton();
201 $single = $session->get('singleForm');
206 'name' => ts('Save'),
207 'spacing' => ' ',
212 'name' => ts('Cancel'),
217 parent
::buildQuickForm();
224 * @param array $params
225 * (ref.) an assoc array of name/value pairs.
228 * @param int $contributionPageId
231 * mixed true or array of errors
233 public static function formRule($params, $files, $contributionPageId = NULL) {
236 if (!empty($params['member_price_set_id'])) {
237 //check if this price set has membership type both auto-renew and non-auto-renew memberships.
238 $bothTypes = CRM_Price_BAO_PriceSet
::isMembershipPriceSetContainsMixOfRenewNonRenew($params['member_price_set_id']);
240 //check for supporting payment processors
241 //if both auto-renew and non-auto-renew memberships
243 $paymentProcessorIds = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage',
244 $contributionPageId, 'payment_processor'
247 $paymentProcessorId = explode(CRM_Core_DAO
::VALUE_SEPARATOR
, $paymentProcessorIds);
249 if (!empty($paymentProcessorId)) {
250 foreach ($paymentProcessorId as $pid) {
252 $processor = Civi\Payment\System
::singleton()->getById($pid);
253 if (!$processor->supports('MultipleConcurrentPayments')) {
254 $errors['member_price_set_id'] = ts('The membership price set associated with this online contribution allows a user to select BOTH an auto-renew AND a non-auto-renew membership. This requires submitting multiple processor transactions, and is not supported for one or more of the payment processors enabled under the Amounts tab.');
261 if (!empty($params['member_is_active'])) {
263 // don't allow price set w/ membership signup, CRM-5095
264 if ($contributionPageId && ($setID = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $contributionPageId, NULL, 1))) {
266 $extends = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceSet', $setID, 'extends');
267 if ($extends != CRM_Core_Component
::getComponentID('CiviMember')) {
268 $errors['member_is_active'] = ts('You cannot enable both Membership Signup and a Contribution Price Set on the same online contribution page.');
273 if (!empty($params['member_price_set_id'])) {
277 if (!isset($params['membership_type']) ||
278 (!is_array($params['membership_type']))
280 $errors['membership_type'] = ts('Please select at least one Membership Type to include in the Membership section of this page.');
283 $membershipType = array_values($params['membership_type']);
284 $isRecur = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage', $contributionPageId, 'is_recur');
285 if (array_sum($membershipType) == 0) {
286 $errors['membership_type'] = ts('Please select at least one Membership Type to include in the Membership section of this page.');
288 elseif (array_sum($membershipType) > CRM_Price_Form_Field
::NUM_OPTION
) {
290 $errors['membership_type'] = ts('You cannot select more than %1 choices. For more complex functionality, please use a Price Set.', [1 => CRM_Price_Form_Field
::NUM_OPTION
]);
293 if (empty($params['is_separate_payment']) && array_sum($membershipType) != 0) {
294 $errors['is_separate_payment'] = ts('You need to enable Separate Membership Payment when online contribution page is configured for both Membership and Recurring Contribution');
296 elseif (!empty($params['is_separate_payment'])) {
297 foreach ($params['membership_type'] as $mt => $dontCare) {
298 if (!empty($params["auto_renew_$mt"])) {
299 $errors["auto_renew_$mt"] = ts('You cannot enable both Recurring Contributions and Auto-renew memberships on the same online contribution page');
308 //if Membership status is not present, then display an error message
309 $dao = new CRM_Member_BAO_MembershipStatus();
311 $errors['_qf_default'] = ts('Add status rules, before configuring membership');
314 //give error if default is selected for an unchecked membership type
315 if (!empty($params['membership_type_default']) && !$params['membership_type'][$params['membership_type_default']]) {
316 $errors['membership_type_default'] = ts('Can\'t set default option for an unchecked membership type.');
319 if ($contributionPageId) {
320 $amountBlock = CRM_Core_DAO
::getFieldValue('CRM_Contribute_DAO_ContributionPage', $contributionPageId, 'amount_block_is_active');
322 if (!$amountBlock && !empty($params['is_separate_payment'])) {
323 $errors['is_separate_payment'] = ts('Please enable the contribution amount section to use this option.');
329 return empty($errors) ?
TRUE : $errors;
337 public function postProcess() {
338 // get the submitted form values.
339 $params = $this->controller
->exportValues($this->_name
);
341 if ($params['membership_type']) {
342 // we do this in case the user has hit the forward/back button
343 $dao = new CRM_Member_DAO_MembershipBlock();
344 $dao->entity_table
= 'civicrm_contribution_page';
345 $dao->entity_id
= $this->_id
;
347 $membershipID = $dao->id
;
349 $params['id'] = $membershipID;
352 $membershipTypes = [];
353 if (is_array($params['membership_type'])) {
354 foreach ($params['membership_type'] as $k => $v) {
356 $membershipTypes[$k] = CRM_Utils_Array
::value("auto_renew_$k", $params);
361 if ($this->_id
&& !empty($params['member_price_set_id'])) {
362 CRM_Core_DAO
::setFieldValue('CRM_Contribute_DAO_ContributionPage', $this->_id
, 'amount_block_is_active', 0);
365 // check for price set.
366 $priceSetID = CRM_Utils_Array
::value('member_price_set_id', $params);
367 if (!empty($params['member_is_active']) && is_array($membershipTypes) && !$priceSetID) {
368 $usedPriceSetId = CRM_Price_BAO_PriceSet
::getFor('civicrm_contribution_page', $this->_id
, 2);
369 if (empty($params['mem_price_field_id']) && !$usedPriceSetId) {
370 $pageTitle = strtolower(CRM_Utils_String
::munge($this->_values
['title'], '_', 245));
371 $setParams['title'] = $this->_values
['title'];
372 if (!CRM_Core_DAO
::getFieldValue('CRM_Price_BAO_PriceSet', $pageTitle, 'id', 'name')) {
373 $setParams['name'] = $pageTitle;
375 elseif (!CRM_Core_DAO
::getFieldValue('CRM_Price_BAO_PriceSet', $pageTitle . '_' . $this->_id
, 'id', 'name')) {
376 $setParams['name'] = $pageTitle . '_' . $this->_id
;
379 $timeSec = explode(".", microtime(TRUE));
380 $setParams['name'] = $pageTitle . '_' . date('is', $timeSec[0]) . $timeSec[1];
382 $setParams['is_quick_config'] = 1;
383 $setParams['extends'] = CRM_Core_Component
::getComponentID('CiviMember');
384 $setParams['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_values
);
385 $priceSet = CRM_Price_BAO_PriceSet
::create($setParams);
386 $priceSetID = $priceSet->id
;
387 $fieldParams['price_set_id'] = $priceSet->id
;
389 elseif ($usedPriceSetId) {
390 $setParams['extends'] = CRM_Core_Component
::getComponentID('CiviMember');
391 $setParams['financial_type_id'] = CRM_Utils_Array
::value('financial_type_id', $this->_values
);
392 $setParams['id'] = $usedPriceSetId;
393 $priceSet = CRM_Price_BAO_PriceSet
::create($setParams);
394 $priceSetID = $priceSet->id
;
395 $fieldParams['price_set_id'] = $priceSet->id
;
398 $fieldParams['id'] = CRM_Utils_Array
::value('mem_price_field_id', $params);
399 $priceSetID = CRM_Core_DAO
::getFieldValue('CRM_Price_DAO_PriceField', CRM_Utils_Array
::value('mem_price_field_id', $params), 'price_set_id');
401 $editedFieldParams = [
402 'price_set_id' => $priceSetID,
403 'name' => 'membership_amount',
406 CRM_Price_BAO_PriceField
::retrieve($editedFieldParams, $editedResults);
407 if (empty($editedResults['id'])) {
408 $fieldParams['name'] = strtolower(CRM_Utils_String
::munge('Membership Amount', '_', 245));
409 if (empty($params['mem_price_field_id'])) {
410 CRM_Utils_Weight
::updateOtherWeights('CRM_Price_DAO_PriceField', 0, 1, ['price_set_id' => $priceSetID]);
412 $fieldParams['weight'] = 1;
415 $fieldParams['id'] = CRM_Utils_Array
::value('id', $editedResults);
418 $fieldParams['label'] = !empty($params['membership_type_label']) ?
$params['membership_type_label'] : ts('Membership');
419 $fieldParams['is_active'] = 1;
420 $fieldParams['html_type'] = 'Radio';
421 $fieldParams['is_required'] = !empty($params['is_required']) ?
1 : 0;
422 $fieldParams['is_display_amounts'] = !empty($params['display_min_fee']) ?
1 : 0;
425 if (!empty($fieldParams['id'])) {
426 CRM_Core_PseudoConstant
::populate($options, 'CRM_Price_DAO_PriceFieldValue', TRUE, 'membership_type_id', NULL, " price_field_id = {$fieldParams['id']} ");
429 foreach ($membershipTypes as $memType => $memAutoRenew) {
430 if ($priceFieldID = CRM_Utils_Array
::key($memType, $options)) {
431 $fieldParams['option_id'][$rowCount] = $priceFieldID;
432 unset($options[$priceFieldID]);
434 $membetype = CRM_Member_BAO_MembershipType
::getMembershipTypeDetails($memType);
435 $fieldParams['option_label'][$rowCount] = CRM_Utils_Array
::value('name', $membetype);
436 $fieldParams['option_amount'][$rowCount] = CRM_Utils_Array
::value('minimum_fee', $membetype, 0);
437 $fieldParams['option_weight'][$rowCount] = CRM_Utils_Array
::value('weight', $membetype);
438 $fieldParams['option_description'][$rowCount] = CRM_Utils_Array
::value('description', $membetype);
439 $fieldParams['default_option'] = CRM_Utils_Array
::value('membership_type_default', $params);
440 $fieldParams['option_financial_type_id'][$rowCount] = CRM_Utils_Array
::value('financial_type_id', $membetype);
442 $fieldParams['membership_type_id'][$rowCount] = $memType;
443 // [$rowCount] = $membetype[''];
446 foreach ($options as $priceFieldID => $memType) {
447 CRM_Price_BAO_PriceFieldValue
::setIsActive($priceFieldID, '0');
449 $priceField = CRM_Price_BAO_PriceField
::create($fieldParams);
451 elseif (!$priceSetID) {
455 $params['is_required'] = CRM_Utils_Array
::value('is_required', $params, FALSE);
456 $params['is_active'] = CRM_Utils_Array
::value('member_is_active', $params, FALSE);
459 $params['membership_types'] = 'null';
460 $params['membership_type_default'] = CRM_Utils_Array
::value('membership_type_default', $params, 'null');
461 $params['membership_types'] = serialize($membershipTypes);
462 $params['display_min_fee'] = CRM_Utils_Array
::value('display_min_fee', $params, FALSE);
463 $params['is_separate_payment'] = CRM_Utils_Array
::value('is_separate_payment', $params, FALSE);
465 $params['entity_table'] = 'civicrm_contribution_page';
466 $params['entity_id'] = $this->_id
;
468 $dao = new CRM_Member_DAO_MembershipBlock();
469 $dao->copyValues($params);
472 if ($priceSetID && $params['is_active']) {
473 CRM_Price_BAO_PriceSet
::addTo('civicrm_contribution_page', $this->_id
, $priceSetID);
476 if ($deletePriceSet ||
!CRM_Utils_Array
::value('member_is_active', $params, FALSE)) {
478 if ($this->_memPriceSetId
) {
481 'price_set_id' => $this->_memPriceSetId
,
482 'html_type' => 'radio',
483 'name' => 'contribution_amount',
486 CRM_Core_DAO
::commonRetrieve('CRM_Price_DAO_PriceField', $conditionParams, $pFIDs);
487 if (empty($pFIDs['id'])) {
488 CRM_Price_BAO_PriceSet
::removeFrom('civicrm_contribution_page', $this->_id
);
489 CRM_Price_BAO_PriceSet
::setIsQuickConfig($this->_memPriceSetId
, '0');
493 CRM_Price_BAO_PriceField
::setIsActive($params['mem_price_field_id'], '0');
498 parent
::endPostProcess();
502 * Return a descriptive name for the page, used in wizard header
506 public function getTitle() {
507 return ts('Memberships');