);
/**
- * Get the entity id being edited.
+ * Set entity fields to be assigned to the form.
+ */
+ protected function setEntityFields() {
+ $this->entityFields = [
+ 'join_date' => [
+ 'name' => 'join_date',
+ 'description' => ts('Member Since'),
+ ],
+ 'start_date' => [
+ 'name' => 'start_date',
+ 'description' => ts('Start Date'),
+ ],
+ 'end_date' => [
+ 'name' => 'end_date',
+ 'description' => ts('End Date'),
+ ],
+ ];
+ }
+
+ /**
+ * Set the delete message.
*
- * @return int|null
+ * We do this from the constructor in order to do a translation.
*/
- public function getEntityId() {
- return $this->_id;
+ public function setDeleteMessage() {
+ $this->deleteMessage = '<span class="font-red bold">'
+ . ts("WARNING: Deleting this membership will also delete any related payment (contribution) records." . ts("This action cannot be undone.")
+ . '</span><p>'
+ . ts("Consider modifying the membership status instead if you want to maintain an audit trail and avoid losing payment data. You can set the status to Cancelled by editing the membership and clicking the Status Override checkbox.")
+ . '</p><p>'
+ . ts("Click 'Delete' if you want to continue.") . '</p>');
}
+ /**
+ * Overriding this entity trait function as not yet tested.
+ *
+ * We continue to rely on legacy handling.
+ */
+ public function addCustomDataToForm() {}
+
+
+ /**
+ * Overriding this entity trait function as not yet tested.
+ *
+ * We continue to rely on legacy handling.
+ */
+ public function addFormButtons() {}
+
/**
* Get selected membership type from the form values.
*
// This string makes up part of the class names, differentiating them (not sure why) from the membership fields.
$this->assign('formClass', 'membership');
parent::preProcess();
+ if ($this->isUpdateToExistingRecurringMembership()) {
+ $this->entityFields['end_date']['is_freeze'] = TRUE;
+ }
// get price set id.
$this->_priceSetId = CRM_Utils_Array::value('priceSetId', $_GET);
$this->set('priceSetId', $this->_priceSetId);
// $defaults['credit_card_exp_date'] = array( 'Y' => '2012', 'M' => '05' );
}
- $dates = array('join_date', 'start_date', 'end_date');
- foreach ($dates as $key) {
- if (!empty($defaults[$key])) {
- list($defaults[$key]) = CRM_Utils_Date::setDateDefaults(CRM_Utils_Array::value($key, $defaults));
- }
- }
-
//setting default join date if there is no join date
if (empty($defaults['join_date'])) {
- $defaults['join_date'] = $now;
+ $defaults['join_date'] = date('Y-m-d H:i:s');
}
if (!empty($defaults['membership_end_date'])) {
*/
public function buildQuickForm() {
+ $this->buildQuickEntityForm();
$this->assign('currency', CRM_Core_Config::singleton()->defaultCurrencySymbol);
-
+ $isUpdateToExistingRecurringMembership = $this->isUpdateToExistingRecurringMembership();
// build price set form.
$buildPriceSet = FALSE;
if ($this->_priceSetId || !empty($_POST['price_set_id'])) {
);
$sel->setOptions(array($selMemTypeOrg, $selOrgMemType));
- $elements = array();
- if ($sel) {
- $elements[] = $sel;
+ if ($isUpdateToExistingRecurringMembership) {
+ $sel->freeze();
}
- $this->applyFilter('__ALL__', 'trim');
-
if ($this->_action & CRM_Core_Action::ADD) {
$this->add('text', 'num_terms', ts('Number of Terms'), array('size' => 6));
}
- $this->addDate('join_date', ts('Member Since'), FALSE, array('formatType' => 'activityDate'));
- $this->addDate('start_date', ts('Start Date'), FALSE, array('formatType' => 'activityDate'));
- $endDate = $this->addDate('end_date', ts('End Date'), FALSE, array('formatType' => 'activityDate'));
- if ($endDate) {
- $elements[] = $endDate;
- }
-
$this->add('text', 'source', ts('Source'),
CRM_Core_DAO::getAttribute('CRM_Member_DAO_Membership', 'source')
);
$statusOverride = $this->addElement('select', 'is_override', ts('Status Override?'),
CRM_Member_StatusOverrideTypes::getSelectOptions()
);
- if ($statusOverride) {
- $elements[] = $statusOverride;
+ if ($statusOverride && $isUpdateToExistingRecurringMembership) {
+ $statusOverride->freeze();
}
$this->add('datepicker', 'status_override_end_date', ts('Status Override End Date'), '', FALSE, array('minDate' => time(), 'time' => FALSE));
$this->assign('displayName', $this->_memberDisplayName);
}
- $isRecur = FALSE;
- if ($this->_action & CRM_Core_Action::UPDATE) {
- $recurContributionId = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id,
- 'contribution_recur_id'
+ if ($isUpdateToExistingRecurringMembership && CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
+ $this->assign('cancelAutoRenew',
+ CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
);
- if ($recurContributionId && !CRM_Member_BAO_Membership::isSubscriptionCancelled($this->_id)) {
- $isRecur = TRUE;
- if (CRM_Member_BAO_Membership::isCancelSubscriptionSupported($this->_id)) {
- $this->assign('cancelAutoRenew',
- CRM_Utils_System::url('civicrm/contribute/unsubscribe', "reset=1&mid={$this->_id}")
- );
- }
- foreach ($elements as $elem) {
- $elem->freeze();
- }
- }
}
- $this->assign('isRecur', $isRecur);
+
+ $this->assign('isRecur', $isUpdateToExistingRecurringMembership);
$this->addFormRule(array('CRM_Member_Form_Membership', 'formRule'), $this);
$mailingInfo = Civi::settings()->get('mailing_backend');
$formValues = $this->setPriceSetParameters($formValues);
$params = $softParams = $ids = array();
- $allMemberStatus = CRM_Member_PseudoConstant::membershipStatus();
- $allContributionStatus = CRM_Contribute_PseudoConstant::contributionStatus(NULL, 'name');
$this->processBillingAddress();
if ($this->_id) {
$params['tax_amount'] = $formValues['tax_amount'];
}
$params['total_amount'] = CRM_Utils_Array::value('amount', $formValues);
- $submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $formValues);
if (!empty($lineItem[$this->_priceSetId])) {
foreach ($lineItem[$this->_priceSetId] as &$li) {
if (!empty($li['membership_type_id'])) {
///CRM-11529 for quick config backoffice transactions
//when financial_type_id is passed in form, update the
//lineitems with the financial type selected in form
+ $submittedFinancialType = CRM_Utils_Array::value('financial_type_id', $formValues);
if ($isQuickConfig && $submittedFinancialType) {
$li['financial_type_id'] = $submittedFinancialType;
}
}
}
- // max related memberships - take from form or inherit from membership type
foreach ($this->_memTypeSelected as $memType) {
if (array_key_exists('max_related', $formValues)) {
+ // max related memberships - take from form or inherit from membership type
$membershipTypeValues[$memType]['max_related'] = CRM_Utils_Array::value('max_related', $formValues);
}
$membershipTypeValues[$memType]['custom'] = CRM_Core_BAO_CustomField::postProcess($formValues,
$softParams['contact_id'] = $this->_contactID;
}
}
+
+ $pendingMembershipStatusId = CRM_Core_PseudoConstant::getKey('CRM_Member_BAO_Membership', 'status_id', 'Pending');
+
if (!empty($formValues['record_contribution'])) {
$recordContribution = array(
'total_amount',
}
}
+ $completedContributionStatusId = CRM_Core_PseudoConstant::getKey('CRM_Contribute_BAO_Contribution', 'contribution_status_id', 'Completed');
if (empty($params['is_override']) &&
- CRM_Utils_Array::value('contribution_status_id', $params) != array_search('Completed', $allContributionStatus)
+ CRM_Utils_Array::value('contribution_status_id', $params) != $completedContributionStatusId
) {
- $params['status_id'] = array_search('Pending', $allMemberStatus);
+ $params['status_id'] = $pendingMembershipStatusId;
$params['skipStatusCal'] = TRUE;
$params['is_pay_later'] = 1;
$this->assign('is_pay_later', 1);
$ids['contribution'] = $contribution->id;
$params['contribution_recur_id'] = $paymentParams['contributionRecurID'];
}
+ $paymentStatus = NULL;
if ($params['total_amount'] > 0.0) {
$payment = $this->_paymentProcessor['object'];
try {
$result = $payment->doPayment($paymentParams);
$formValues = array_merge($formValues, $result);
+ $paymentStatus = CRM_Core_PseudoConstant::getName('CRM_Contribute_BAO_Contribution', 'contribution_status_id', $formValues['payment_status_id']);
// Assign amount to template if payment was successful.
$this->assign('amount', $params['total_amount']);
}
}
}
- if ($formValues['payment_status_id'] != array_search('Completed', $allContributionStatus)) {
- $params['status_id'] = array_search('Pending', $allMemberStatus);
+ if ($paymentStatus !== 'Completed') {
+ $params['status_id'] = $pendingMembershipStatusId;
$params['skipStatusCal'] = TRUE;
// unset send-receipt option, since receipt will be sent when ipn is received.
unset($formValues['send_receipt'], $formValues['send_receipt']);
}
}
$now = date('YmdHis');
- $params['receive_date'] = $now;
+ $params['receive_date'] = date('YmdHis');
$params['invoice_id'] = $formValues['invoiceID'];
$params['contribution_source'] = ts('%1 Membership Signup: Credit card or direct debit (by %2)',
array(1 => $membershipType, 2 => $userName)
*
* @param CRM_Member_BAO_Membership $membership
* @param string $endDate
- * @param bool $receiptSend
*
* @return string
*/
- protected function getStatusMessageForUpdate($membership, $endDate, $receiptSend) {
+ protected function getStatusMessageForUpdate($membership, $endDate) {
// End date can be modified by hooks, so if end date is set then use it.
$endDate = ($membership->end_date) ? $membership->end_date : $endDate;
$endDate = CRM_Utils_Date::customFormat($endDate);
$statusMsg .= ' ' . ts('The membership End Date is %1.', array(1 => $endDate));
}
-
- if ($receiptSend) {
- $statusMsg .= ' ' . ts('A confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail));
- }
return $statusMsg;
}
* Get status message for create action.
*
* @param string $endDate
- * @param bool $receiptSend
* @param array $membershipTypes
* @param array $createdMemberships
* @param bool $isRecur
* @param array $calcDates
- * @param bool $mailSent
*
* @return array|string
*/
- protected function getStatusMessageForCreate($endDate, $receiptSend, $membershipTypes, $createdMemberships,
- $isRecur, $calcDates, $mailSent) {
+ protected function getStatusMessageForCreate($endDate, $membershipTypes, $createdMemberships,
+ $isRecur, $calcDates) {
// FIX ME: fix status messages
$statusMsg = array();
}
}
$statusMsg = implode('<br/>', $statusMsg);
- if ($receiptSend && !empty($mailSent)) {
- $statusMsg .= ' ' . ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail));
- }
return $statusMsg;
}
* @param $createdMemberships
* @param $isRecur
* @param $calcDates
- * @param $mailSend
+ * @param $mailSent
*/
- protected function setStatusMessage($membership, $endDate, $receiptSend, $membershipTypes, $createdMemberships, $isRecur, $calcDates, $mailSend) {
- $statusMsg = '';
+ protected function setStatusMessage($membership, $endDate, $receiptSend, $membershipTypes, $createdMemberships, $isRecur, $calcDates, $mailSent) {
if (($this->_action & CRM_Core_Action::UPDATE)) {
- $statusMsg = $this->getStatusMessageForUpdate($membership, $endDate, $receiptSend);
+ $this->addStatusMessage($this->getStatusMessageForUpdate($membership, $endDate));
}
elseif (($this->_action & CRM_Core_Action::ADD)) {
- $statusMsg = $this->getStatusMessageForCreate($endDate, $receiptSend, $membershipTypes, $createdMemberships,
- $isRecur, $calcDates, $mailSend);
+ $this->addStatusMessage($this->getStatusMessageForCreate($endDate, $membershipTypes, $createdMemberships,
+ $isRecur, $calcDates));
+ }
+ if ($receiptSend && $mailSent) {
+ $this->addStatusMessage(ts('A membership confirmation and receipt has been sent to %1.', array(1 => $this->_contributorEmail)));
}
- CRM_Core_Session::setStatus($statusMsg, ts('Complete'), 'success');
+ CRM_Core_Session::setStatus($this->getStatusMessage(), ts('Complete'), 'success');
//CRM-15187
// display message when membership type is changed
if (($this->_action & CRM_Core_Action::UPDATE) && $this->_id && !in_array($this->_memType, $this->_memTypeSelected)) {
}
}
+ /**
+ * @return bool
+ */
+ protected function isUpdateToExistingRecurringMembership() {
+ $isRecur = FALSE;
+ if ($this->_action & CRM_Core_Action::UPDATE
+ && CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->getEntityId(),
+ 'contribution_recur_id')
+ && !CRM_Member_BAO_Membership::isSubscriptionCancelled($this->getEntityId())) {
+
+ $isRecur = TRUE;
+ }
+ return $isRecur;
+ }
+
}