3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
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
37 * Base class for offline membership / membership type / membership renewal and membership status forms
40 class CRM_Member_Form
extends CRM_Contribute_Form_AbstractEditPayment
{
43 * The id of the object being edited / created
56 * Array of from email ids
59 protected $_fromEmails = array();
61 public function preProcess() {
62 // Check for edit permission.
63 if (!CRM_Core_Permission
::checkActionPermission('CiviMember', $this->_action
)) {
64 CRM_Core_Error
::fatal(ts('You do not have permission to access this page.'));
68 $params['context'] = CRM_Utils_Request
::retrieve('context', 'String', $this, FALSE, 'membership');
69 $params['id'] = CRM_Utils_Request
::retrieve('id', 'Positive', $this);
70 $params['mode'] = CRM_Utils_Request
::retrieve('mode', 'String', $this);
72 $this->setContextVariables($params);
74 $this->assign('context', $this->_context
);
75 $this->assign('membershipMode', $this->_mode
);
79 * Set default values for the form. MobileProvider that in edit/view mode
80 * the default values are retrieved from the database
86 public function setDefaultValues() {
88 if (isset($this->_id
)) {
89 $params = array('id' => $this->_id
);
90 CRM_Member_BAO_Membership
::retrieve($params, $defaults);
91 if (isset($defaults['minimum_fee'])) {
92 $defaults['minimum_fee'] = CRM_Utils_Money
::format($defaults['minimum_fee'], NULL, '%a');
95 if (isset($defaults['status'])) {
96 $this->assign('membershipStatus', $defaults['status']);
100 if ($this->_action
& CRM_Core_Action
::ADD
) {
101 $defaults['is_active'] = 1;
104 if (isset($defaults['member_of_contact_id']) &&
105 $defaults['member_of_contact_id']
107 $defaults['member_org'] = CRM_Core_DAO
::getFieldValue('CRM_Contact_DAO_Contact',
108 $defaults['member_of_contact_id'], 'display_name'
115 * Build the form object.
117 public function buildQuickForm() {
120 $this->add('select', 'payment_processor_id',
121 ts('Payment Processor'),
122 $this->_processors
, TRUE,
123 array('onChange' => "buildAutoRenew( null, this.value );")
125 CRM_Core_Payment_Form
::buildPaymentForm($this, $this->_paymentProcessor
, FALSE, TRUE);
127 // Build the form for auto renew. This is displayed when in credit card mode or update mode.
128 // The reason for showing it in update mode is not that clear.
129 $autoRenew = array();
130 $recurProcessor = array();
131 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
132 if (!empty($recurProcessor)) {
133 $autoRenew = array();
134 if (!empty($membershipType)) {
140 FROM civicrm_membership_type
141 WHERE id IN ( ' . implode(' , ', array_keys($membershipType)) . ' )';
142 $recurMembershipTypes = CRM_Core_DAO
::executeQuery($sql);
143 while ($recurMembershipTypes->fetch()) {
144 $autoRenew[$recurMembershipTypes->id
] = $recurMembershipTypes->auto_renew
;
151 $this->_recurMembershipTypes
[$recurMembershipTypes->id
][$fld] = $recurMembershipTypes->$fld;
157 if (!empty($this->_recurPaymentProcessors
)) {
158 $this->assign('allowAutoRenew', TRUE);
162 $this->assign('autoRenew', json_encode($autoRenew));
163 $autoRenewElement = $this->addElement('checkbox', 'auto_renew', ts('Membership renewed automatically'),
164 NULL, array('onclick' => "showHideByValue('auto_renew','','send-receipt','table-row','radio',true); showHideNotice( );")
166 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
167 $autoRenewElement->freeze();
172 $this->assign('recurProcessor', json_encode($recurProcessor));
174 if ($this->_mode ||
($this->_action
& CRM_Core_Action
::UPDATE
)) {
175 $this->addElement('checkbox',
177 ts('Membership renewed automatically'),
179 array('onclick' => "buildReceiptANDNotice( );")
182 $this->assignPaymentRelatedVariables();
184 $this->assign('autoRenewOptions', json_encode($autoRenew));
186 if ($this->_action
& CRM_Core_Action
::RENEW
) {
187 $this->addButtons(array(
190 'name' => ts('Renew'),
195 'name' => ts('Cancel'),
200 elseif ($this->_action
& CRM_Core_Action
::DELETE
) {
201 $this->addButtons(array(
204 'name' => ts('Delete'),
209 'name' => ts('Cancel'),
215 $this->addButtons(array(
218 'name' => ts('Save'),
223 'name' => ts('Save and New'),
228 'name' => ts('Cancel'),
236 * Extract values from the contact create boxes on the form and assign appropriately to
238 * - $this->_contributorEmail,
239 * - $this->_memberEmail &
240 * - $this->_contributionName
241 * - $this->_memberName
242 * - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
243 * - $this->_contributorContactId - id of the contributor
244 * - $this->_receiptContactId
246 * If the member & contributor are the same then the values will be the same. But if different people paid
247 * then they weill differ
249 * @param array $formValues
250 * values from form. The important values we are looking for are.
252 * - soft_credit_contact_id
254 public function storeContactFields($formValues) {
255 // in a 'standalone form' (contact id not in the url) the contact will be in the form values
256 if (!empty($formValues['contact_id'])) {
257 $this->_contactID
= $formValues['contact_id'];
260 list($this->_memberDisplayName
,
262 ) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contactID
);
264 //CRM-10375 Where the payer differs to the member the payer should get the email.
265 // here we store details in order to do that
266 if (!empty($formValues['soft_credit_contact_id'])) {
267 $this->_receiptContactId
= $this->_contributorContactID
= $formValues['soft_credit_contact_id'];
268 list($this->_contributorDisplayName
,
269 $this->_contributorEmail
) = CRM_Contact_BAO_Contact_Location
::getEmailDetails($this->_contributorContactID
);
272 $this->_receiptContactId
= $this->_contributorContactID
= $this->_contactID
;
273 $this->_contributorDisplayName
= $this->_memberDisplayName
;
274 $this->_contributorEmail
= $this->_memberEmail
;
278 protected function setContextVariables($params) {
280 'action' => '_action',
281 'context' => '_context',
283 'cid' => '_contactID',
286 foreach ($variables as $paramKey => $classVar) {
287 if (isset($params[$paramKey]) && !isset($this->$classVar)) {
288 $this->$classVar = $params[$paramKey];
293 $this->assignPaymentRelatedVariables();
297 $this->_memType
= CRM_Core_DAO
::getFieldValue('CRM_Member_DAO_Membership', $this->_id
, 'membership_type_id');
298 $this->_membershipIDs
[] = $this->_id
;
300 $this->_fromEmails
= CRM_Core_BAO_Email
::getFromEmail();