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 * Base class for offline membership / membership type / membership renewal and membership status forms
22 class CRM_Member_Form
extends CRM_Contribute_Form_AbstractEditPayment
{
24 use CRM_Core_Form_EntityFormTrait
;
33 * Array of from email ids
36 protected $_fromEmails = [];
39 * Details of all enabled membership types.
43 protected $allMembershipTypeDetails = [];
46 * Array of membership type IDs and whether they permit autorenewal.
50 protected $membershipTypeRenewalStatus = [];
53 * Price set ID configured for the form.
60 * Price set details as an array.
67 * The order being processed.
69 * @var \CRM_Financial_BAO_Order
74 * Explicitly declare the entity api name.
76 public function getDefaultEntity() {
83 protected $statusMessage = [];
86 * Add to the status message.
90 protected function addStatusMessage($message) {
91 $this->statusMessage
[] = $message;
95 * Get the status message.
99 protected function getStatusMessage() {
100 return implode(' ', $this->statusMessage
);
104 * Values submitted to the form, processed along the way.
108 protected $_params = [];
111 * Fields for the entity to be assigned to the template.
113 * Fields may have keys
114 * - name (required to show in tpl from the array)
115 * - description (optional, will appear below the field)
116 * - not-auto-addable - this class will not attempt to add the field using addField.
117 * (this will be automatically set if the field does not have html in it's metadata
118 * or is not a core field on the form's entity).
119 * - help (option) add help to the field - e.g ['id' => 'id-source', 'file' => 'CRM/Contact/Form/Contact']]
120 * - template - use a field specific template to render this field
122 * - is_freeze (field should be frozen).
126 protected $entityFields = [];
128 public function preProcess() {
129 // Check for edit permission.
130 if (!CRM_Core_Permission
::checkActionPermission('CiviMember', $this->_action
)) {
131 CRM_Core_Error
::statusBounce(ts('You do not have permission to access this page.'));
133 if (!CRM_Member_BAO_Membership
::statusAvailabilty()) {
134 // all possible statuses are disabled - redirect back to contact form
135 CRM_Core_Error
::statusBounce(ts('There are no configured membership statuses. You cannot add this membership until your membership statuses are correctly configured'));
138 parent
::preProcess();
140 $params['context'] = CRM_Utils_Request
::retrieve('context', 'Alphanumeric', $this, FALSE, 'membership');
141 $params['id'] = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
142 $params['mode'] = CRM_Utils_Request
::retrieve('mode', 'Alphanumeric', $this);
144 $this->setContextVariables($params);
146 $this->assign('context', $this->_context
);
147 $this->assign('membershipMode', $this->_mode
);
148 $this->allMembershipTypeDetails
= CRM_Member_BAO_Membership
::buildMembershipTypeValues($this, [], TRUE);
149 foreach ($this->allMembershipTypeDetails
as $index => $membershipType) {
150 if ($membershipType['auto_renew']) {
151 $this->_recurMembershipTypes
[$index] = $membershipType;
152 $this->membershipTypeRenewalStatus
[$index] = $membershipType['auto_renew'];
158 * Set default values for the form. MobileProvider that in edit/view mode
159 * the default values are retrieved from the database
165 public function setDefaultValues() {
167 if (isset($this->_id
)) {
168 $params = ['id' => $this->_id
];
169 CRM_Member_BAO_Membership
::retrieve($params, $defaults);
170 if (isset($defaults['minimum_fee'])) {
171 $defaults['minimum_fee'] = CRM_Utils_Money
::formatLocaleNumericRoundedForDefaultCurrency($defaults['minimum_fee']);
174 if (isset($defaults['status'])) {
175 $this->assign('membershipStatus', $defaults['status']);
178 if (!empty($defaults['is_override'])) {
179 $defaults['is_override'] = CRM_Member_StatusOverrideTypes
::PERMANENT
;
181 if (!empty($defaults['status_override_end_date'])) {
182 $defaults['is_override'] = CRM_Member_StatusOverrideTypes
::UNTIL_DATE
;
186 if ($this->_action
& CRM_Core_Action
::ADD
) {
187 $defaults['is_active'] = 1;
190 if (isset($defaults['member_of_contact_id']) &&
191 $defaults['member_of_contact_id']
193 $defaults['member_org'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
194 $defaults['member_of_contact_id'], 'display_name'
197 if (!empty($defaults['membership_type_id'])) {
198 $this->_memType
= $defaults['membership_type_id'];
200 if (is_numeric($this->_memType
)) {
201 $defaults['membership_type_id'] = [];
202 $defaults['membership_type_id'][0] = CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_MembershipType',
204 'member_of_contact_id',
207 $defaults['membership_type_id'][1] = $this->_memType
;
210 $defaults['membership_type_id'] = $this->_memType
;
216 * Build the form object.
218 public function buildQuickForm() {
219 $this->assignSalesTaxMetadataToTemplate();
221 $this->addPaymentProcessorSelect(TRUE, FALSE, TRUE);
222 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE, $this->getDefaultPaymentInstrumentId());
223 $this->assign('recurProcessor', json_encode($this->_recurPaymentProcessors
));
224 // Build the form for auto renew. This is displayed when in credit card mode or update mode.
225 // The reason for showing it in update mode is not that clear.
226 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
227 if (!empty($this->_recurPaymentProcessors
)) {
228 $this->assign('allowAutoRenew', TRUE);
231 $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
232 NULL, ['onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );"]
234 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
235 $autoRenewElement->freeze();
238 $this->addElement('checkbox',
240 ts('Membership renewed automatically')
244 $this->assign('autoRenewOptions', json_encode($this->membershipTypeRenewalStatus
));
246 if ($this->_action
& CRM_Core_Action
::RENEW
) {
250 'name' => ts('Renew'),
255 'name' => ts('Cancel'),
259 elseif ($this->_action
& CRM_Core_Action
::DELETE
) {
263 'name' => ts('Delete'),
268 'name' => ts('Cancel'),
276 'name' => ts('Save'),
281 'name' => ts('Save and New'),
286 'name' => ts('Cancel'),
293 * Extract values from the contact create boxes on the form and assign appropriately to
295 * - $this->_contributorEmail,
296 * - $this->_memberEmail &
297 * - $this->_contributionName
298 * - $this->_memberName
299 * - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
300 * - $this->_contributorContactId - id of the contributor
301 * - $this->_receiptContactId
303 * If the member & contributor are the same then the values will be the same. But if different people paid
304 * then they weill differ
306 * @param array $formValues
307 * values from form. The important values we are looking for are.
309 * - soft_credit_contact_id
311 public function storeContactFields($formValues) {
312 // in a 'standalone form' (contact id not in the url) the contact will be in the form values
313 if (!empty($formValues['contact_id'])) {
314 $this->_contactID
= $formValues['contact_id'];
317 [$this->_memberDisplayName
, $this->_memberEmail
] = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
319 //CRM-10375 Where the payer differs to the member the payer should get the email.
320 // here we store details in order to do that
321 if (!empty($formValues['soft_credit_contact_id'])) {
322 $this->_receiptContactId
= $this->_contributorContactID
= $formValues['soft_credit_contact_id'];
323 [$this->_contributorDisplayName
, $this->_contributorEmail
] = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contributorContactID
);
326 $this->_receiptContactId
= $this->_contributorContactID
= $this->_contactID
;
327 $this->_contributorDisplayName
= $this->_memberDisplayName
;
328 $this->_contributorEmail
= $this->_memberEmail
;
333 * Set variables in a way that can be accessed from different places.
335 * This is part of refactoring for unit testability on the submit function.
337 * @param array $params
339 protected function setContextVariables($params) {
341 'action' => '_action',
342 'context' => '_context',
344 'cid' => '_contactID',
347 foreach ($variables as $paramKey => $classVar) {
348 if (isset($params[$paramKey]) && !isset($this->$classVar)) {
349 $this->$classVar = $params[$paramKey];
354 $this->_memType
= CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'membership_type_id');
355 $this->_membershipIDs
[] = $this->_id
;
357 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
361 * Create a recurring contribution record.
363 * @param array $contributionRecurParams
365 * @param int $membershipTypeID
368 * @throws \CiviCRM_API3_Exception
370 protected function processRecurringContribution($contributionRecurParams, $membershipTypeID) {
373 'frequency_interval' => 'duration_interval',
374 'frequency_unit' => 'duration_unit',
376 $membershipType = civicrm_api3('MembershipType', 'getsingle', [
377 'id' => $membershipTypeID,
378 'return' => $mapping,
381 $returnParams = ['is_recur' => TRUE];
382 foreach ($mapping as $recurringFieldName => $membershipTypeFieldName) {
383 $contributionRecurParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
384 $returnParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
387 $contributionRecur = civicrm_api3('ContributionRecur', 'create', $contributionRecurParams);
388 $returnParams['contributionRecurID'] = $contributionRecur['id'];
389 return $returnParams;
393 * Ensure price parameters are set.
395 * If they are not set it means a quick config option has been chosen so we
396 * fill them in here to make the two flows the same. They look like 'price_2' => 2 etc.
398 * @param array $formValues
400 protected function ensurePriceParamsAreSet(&$formValues) {
401 foreach ($formValues as $key => $value) {
402 if ((substr($key, 0, 6) == 'price_') && is_numeric(substr($key, 6))) {
406 $priceFields = CRM_Member_BAO_Membership
::setQuickConfigMembershipParameters(
407 $formValues['membership_type_id'][0],
408 $formValues['membership_type_id'][1],
409 CRM_Utils_Array
::value('total_amount', $formValues),
412 $formValues = array_merge($formValues, $priceFields['price_fields']);
416 * Get the details for the selected price set.
418 * @param array $params
419 * Parameters submitted to the form.
423 protected function getPriceSetDetails(array $params): ?
array {
424 $priceSetID = $params['price_set_id'] ??
NULL;
426 return CRM_Price_BAO_PriceSet
::getSetDetail($priceSetID);
429 $priceSet = CRM_Price_BAO_PriceSet
::getDefaultPriceSet('membership');
430 $priceSet = reset($priceSet);
431 return CRM_Price_BAO_PriceSet
::getSetDetail($priceSet['setID']);
436 * Get the selected price set id.
438 * @param array $params
439 * Parameters submitted to the form.
443 protected function getPriceSetID(array $params): int {
444 $priceSetID = $params['price_set_id'] ??
NULL;
446 $priceSetDetails = $this->getPriceSetDetails($params);
447 return (int) key($priceSetDetails);
449 return (int) $priceSetID;
453 * Store parameters relating to price sets.
455 * @param array $formValues
459 protected function setPriceSetParameters(array $formValues): array {
460 // process price set and get total amount and line items.
461 $this->_priceSetId
= $this->getPriceSetID($formValues);
462 $this->ensurePriceParamsAreSet($formValues);
463 $priceSetDetails = $this->getPriceSetDetails($formValues);
464 $this->_priceSet
= $priceSetDetails[$this->_priceSetId
];
465 $this->order
= new CRM_Financial_BAO_Order();
466 $this->order
->setPriceSelectionFromUnfilteredInput($formValues);
467 $this->order
->setPriceSetID($this->getPriceSetID($formValues));
468 if (isset($formValues['total_amount'])) {
469 $this->order
->setOverrideTotalAmount($formValues['total_amount']);
471 $this->order
->setOverrideFinancialTypeID((int) $formValues['financial_type_id']);
476 * Wrapper function for unit tests.
478 * @param array $formValues
480 public function testSubmit(array $formValues): void
{
481 $this->exportedValues
= $formValues;
482 $this->setContextVariables($formValues);
483 $this->_memType
= $formValues['membership_type_id'][1];
484 $this->_params
= $formValues;
489 * Get order related params.
491 * In practice these are contribution params but later they cann be used with the Order api.
495 * @throws \CiviCRM_API3_Exception
497 protected function getOrderParams(): array {
499 'lineItems' => [$this->_priceSetId
=> $this->order
->getLineItems()],
500 // This is one of those weird & wonderful legacy params we aim to get rid of.
501 'processPriceSet' => TRUE,
502 'tax_amount' => $this->order
->getTotalTaxAmount(),