3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
35 * Base class for offline membership / membership type / membership renewal and membership status forms
38 class CRM_Member_Form
extends CRM_Contribute_Form_AbstractEditPayment
{
41 * The id of the object being edited / created
54 * Array of from email ids
57 protected $_fromEmails = array();
60 * Details of all enabled membership types.
64 protected $allMembershipTypeDetails = array();
67 * Array of membership type IDs and whether they permit autorenewal.
71 protected $membershipTypeRenewalStatus = array();
74 * Price set ID configured for the form.
81 * Price set details as an array.
88 * Values submitted to the form, processed along the way.
92 protected $_params = array();
94 public function preProcess() {
95 // Check for edit permission.
96 if (!CRM_Core_Permission
::checkActionPermission('CiviMember', $this->_action
)) {
97 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
101 $params['context'] = CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'membership');
102 $params['id'] = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
103 $params['mode'] = CRM_Utils_Request
::retrieve('mode', 'String', $this);
105 $this->setContextVariables($params);
107 $this->assign('context', $this->_context
);
108 $this->assign('membershipMode', $this->_mode
);
109 $this->allMembershipTypeDetails
= CRM_Member_BAO_Membership
::buildMembershipTypeValues($this, array(), TRUE);
110 foreach ($this->allMembershipTypeDetails
as $index => $membershipType) {
111 if ($membershipType['auto_renew']) {
112 $this->_recurMembershipTypes
[$index] = $membershipType;
113 $this->membershipTypeRenewalStatus
[$index] = $membershipType['auto_renew'];
119 * Set default values for the form. MobileProvider that in edit/view mode
120 * the default values are retrieved from the database
126 public function setDefaultValues() {
128 if (isset($this->_id
)) {
129 $params = array('id' => $this->_id
);
130 CRM_Member_BAO_Membership
::retrieve($params, $defaults);
131 if (isset($defaults['minimum_fee'])) {
132 $defaults['minimum_fee'] = CRM_Utils_Money
::format($defaults['minimum_fee'], NULL, '%a');
135 if (isset($defaults['status'])) {
136 $this->assign('membershipStatus', $defaults['status']);
140 if ($this->_action
& CRM_Core_Action
::ADD
) {
141 $defaults['is_active'] = 1;
144 if (isset($defaults['member_of_contact_id']) &&
145 $defaults['member_of_contact_id']
147 $defaults['member_org'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
148 $defaults['member_of_contact_id'], 'display_name'
155 * Build the form object.
157 public function buildQuickForm() {
160 $this->add('select', 'payment_processor_id',
161 ts('Payment Processor'),
162 $this->_processors
, TRUE,
163 array('onChange' => "buildAutoRenew( null, this.value );")
165 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE);
167 // Build the form for auto renew. This is displayed when in credit card mode or update mode.
168 // The reason for showing it in update mode is not that clear.
169 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
170 if (!empty($this->_recurPaymentProcessors
)) {
171 $this->assign('allowAutoRenew', TRUE);
174 $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
175 NULL, array('onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );")
177 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
178 $autoRenewElement->freeze();
181 $this->assign('recurProcessor', json_encode($this->_recurPaymentProcessors
));
182 $this->addElement('checkbox',
184 ts('Membership renewed automatically'),
186 array('onclick' => "buildReceiptANDNotice( );")
189 $this->assignPaymentRelatedVariables();
191 $this->assign('autoRenewOptions', json_encode($this->membershipTypeRenewalStatus
));
193 if ($this->_action
& CRM_Core_Action
::RENEW
) {
194 $this->addButtons(array(
197 'name' => ts('Renew'),
202 'name' => ts('Cancel'),
207 elseif ($this->_action
& CRM_Core_Action
::DELETE
) {
208 $this->addButtons(array(
211 'name' => ts('Delete'),
216 'name' => ts('Cancel'),
222 $this->addButtons(array(
225 'name' => ts('Save'),
230 'name' => ts('Save and New'),
235 'name' => ts('Cancel'),
243 * Extract values from the contact create boxes on the form and assign appropriately to
245 * - $this->_contributorEmail,
246 * - $this->_memberEmail &
247 * - $this->_contributionName
248 * - $this->_memberName
249 * - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
250 * - $this->_contributorContactId - id of the contributor
251 * - $this->_receiptContactId
253 * If the member & contributor are the same then the values will be the same. But if different people paid
254 * then they weill differ
256 * @param array $formValues
257 * values from form. The important values we are looking for are.
259 * - soft_credit_contact_id
261 public function storeContactFields($formValues) {
262 // in a 'standalone form' (contact id not in the url) the contact will be in the form values
263 if (!empty($formValues['contact_id'])) {
264 $this->_contactID
= $formValues['contact_id'];
267 list($this->_memberDisplayName
,
269 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
271 //CRM-10375 Where the payer differs to the member the payer should get the email.
272 // here we store details in order to do that
273 if (!empty($formValues['soft_credit_contact_id'])) {
274 $this->_receiptContactId
= $this->_contributorContactID
= $formValues['soft_credit_contact_id'];
275 list($this->_contributorDisplayName
,
276 $this->_contributorEmail
) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contributorContactID
);
279 $this->_receiptContactId
= $this->_contributorContactID
= $this->_contactID
;
280 $this->_contributorDisplayName
= $this->_memberDisplayName
;
281 $this->_contributorEmail
= $this->_memberEmail
;
286 * Set variables in a way that can be accessed from different places.
288 * This is part of refactoring for unit testability on the submit function.
290 * @param array $params
292 protected function setContextVariables($params) {
294 'action' => '_action',
295 'context' => '_context',
297 'cid' => '_contactID',
300 foreach ($variables as $paramKey => $classVar) {
301 if (isset($params[$paramKey]) && !isset($this->$classVar)) {
302 $this->$classVar = $params[$paramKey];
307 $this->assignPaymentRelatedVariables();
311 $this->_memType
= CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'membership_type_id');
312 $this->_membershipIDs
[] = $this->_id
;
314 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();
318 * Create a recurring contribution record.
320 * Recurring contribution parameters are set explicitly rather than merging paymentParams because it's hard
321 * to know the downstream impacts if we keep passing around the same array.
323 * @param $paymentParams
326 * @throws \CiviCRM_API3_Exception
328 protected function processRecurringContribution($paymentParams) {
329 $membershipID = $paymentParams['membership_type_id'][1];
330 $contributionRecurParams = array(
331 'contact_id' => $paymentParams['contactID'],
332 'amount' => $paymentParams['total_amount'],
333 'payment_processor_id' => $paymentParams['payment_processor_id'],
334 'campaign_id' => CRM_Utils_Array
::value('campaign_id', $paymentParams),
335 'financial_type_id' => $paymentParams['financial_type_id'],
336 'is_email_receipt' => CRM_Utils_Array
::value('is_email_receipt', $paymentParams),
337 // This is not great as it could also be direct debit - but is consistent with elsewhere & all need fixing.
338 'payment_instrument_id' => 1,
339 'invoice_id' => CRM_Utils_Array
::value('invoiceID ', $paymentParams),
343 'frequency_interval' => 'duration_interval',
344 'frequency_unit' => 'duration_unit',
346 $membershipType = civicrm_api3('MembershipType', 'getsingle', array(
347 'id' => $membershipID,
348 'return' => $mapping,
351 foreach ($mapping as $recurringFieldName => $membershipTypeFieldName) {
352 $contributionRecurParams[$recurringFieldName] = $membershipType[$membershipTypeFieldName];
355 $contributionRecur = civicrm_api3('ContributionRecur', 'create', $contributionRecurParams);
356 $returnParams = array(
357 'contributionRecurID' => $contributionRecur['id'],
360 return $returnParams;
364 * Ensure price parameters are set.
366 * If they are not set it means a quick config option has been chosen so we
367 * fill them in here to make the two flows the same. They look like 'price_2' => 2 etc.
369 * @param array $formValues
371 protected function ensurePriceParamsAreSet(&$formValues) {
372 foreach ($formValues as $key => $value) {
373 if ((substr($key, 0, 6) == 'price_') && is_int(substr($key, 7))) {
377 $priceFields = CRM_Member_BAO_Membership
::setQuickConfigMembershipParameters(
378 $formValues['membership_type_id'][0],
379 $formValues['membership_type_id'][1],
380 $formValues['total_amount'],
383 $formValues = array_merge($formValues, $priceFields['price_fields']);
387 * Get the details for the selected price set.
389 * @param array $params
390 * Parameters submitted to the form.
394 protected static function getPriceSetDetails($params) {
395 $priceSetID = CRM_Utils_Array
::value('price_set_id', $params);
397 return CRM_Price_BAO_PriceSet
::getSetDetail($priceSetID);
400 $priceSet = CRM_Price_BAO_PriceSet
::getDefaultPriceSet('membership');
401 $priceSet = reset($priceSet);
402 return CRM_Price_BAO_PriceSet
::getSetDetail($priceSet['setID']);
407 * Get the selected price set id.
409 * @param array $params
410 * Parameters submitted to the form.
414 protected static function getPriceSetID($params) {
415 $priceSetID = CRM_Utils_Array
::value('price_set_id', $params);
417 $priceSetDetails = self
::getPriceSetDetails($params);
418 return key($priceSetDetails);
424 * Store parameters relating to price sets.
426 * @param array $formValues
430 protected function setPriceSetParameters($formValues) {
431 $this->_priceSetId
= self
::getPriceSetID($formValues);
432 $priceSetDetails = self
::getPriceSetDetails($formValues);
433 $this->_priceSet
= $priceSetDetails[$this->_priceSetId
];
434 // process price set and get total amount and line items.
435 $this->ensurePriceParamsAreSet($formValues);
440 * Assign billing name to the template.
442 protected function assignBillingName() {
444 if (!empty($this->_params
['billing_first_name'])) {
445 $name = $this->_params
['billing_first_name'];
448 if (!empty($this->_params
['billing_middle_name'])) {
449 $name .= " {$this->_params['billing_middle_name']}";
452 if (!empty($this->_params
['billing_last_name'])) {
453 $name .= " {$this->_params['billing_last_name']}";
455 $this->assign('billingName', $name);
459 * Wrapper function for unit tests.
461 * @param array $formValues
463 public function testSubmit($formValues) {
464 $this->_memType
= $formValues['membership_type_id'][1];
465 $this->_params
= $formValues;