CRM/Member/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * Base class for offline membership / membership type / membership renewal and membership status forms
  38  *
  39  */
  40 class CRM_Member_Form extends CRM_Contribute_Form_AbstractEditPayment {
  41
  42   /**
  43    * The id of the object being edited / created
  44    *
  45    * @var int
  46    */
  47   public $_id;
  48
  49   /**
  50    * Membership Type ID
  51    * @var
  52    */
  53   protected $_memType;
  54
  55   /**
  56    * Array of from email ids
  57    * @var array
  58    */
  59   protected $_fromEmails = array();
  60
  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.'));
  65     }
  66     parent::preProcess();
  67     $params = array();
  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);
  71
  72     $this->setContextVariables($params);
  73
  74     $this->assign('context', $this->_context);
  75     $this->assign('membershipMode', $this->_mode);
  76   }
  77
  78   /**
  79    * Set default values for the form. MobileProvider that in edit/view mode
  80    * the default values are retrieved from the database
  81    *
  82    *
  83    * @return array
  84    *   defaults
  85    */
  86   public function setDefaultValues() {
  87     $defaults = array();
  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');
  93       }
  94
  95       if (isset($defaults['status'])) {
  96         $this->assign('membershipStatus', $defaults['status']);
  97       }
  98     }
  99
 100     if ($this->_action & CRM_Core_Action::ADD) {
 101       $defaults['is_active'] = 1;
 102     }
 103
 104     if (isset($defaults['member_of_contact_id']) &&
 105       $defaults['member_of_contact_id']
 106     ) {
 107       $defaults['member_org'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
 108         $defaults['member_of_contact_id'], 'display_name'
 109       );
 110     }
 111     return $defaults;
 112   }
 113
 114   /**
 115    * Build the form object.
 116    */
 117   public function buildQuickForm() {
 118     if ($this->_mode) {
 119       $this->add('select', 'payment_processor_id',
 120         ts('Payment Processor'),
 121         $this->_processors, TRUE,
 122         array('onChange' => "buildAutoRenew( null, this.value );")
 123       );
 124       CRM_Core_Payment_Form::buildPaymentForm($this, $this->_paymentProcessor, FALSE);
 125     }
 126     if ($this->_action & CRM_Core_Action::RENEW) {
 127       $this->addButtons(array(
 128           array(
 129             'type' => 'upload',
 130             'name' => ts('Renew'),
 131             'isDefault' => TRUE,
 132           ),
 133           array(
 134             'type' => 'cancel',
 135             'name' => ts('Cancel'),
 136           ),
 137         )
 138       );
 139     }
 140     elseif ($this->_action & CRM_Core_Action::DELETE) {
 141       $this->addButtons(array(
 142           array(
 143             'type' => 'next',
 144             'name' => ts('Delete'),
 145             'isDefault' => TRUE,
 146           ),
 147           array(
 148             'type' => 'cancel',
 149             'name' => ts('Cancel'),
 150           ),
 151         )
 152       );
 153     }
 154     else {
 155       $this->addButtons(array(
 156           array(
 157             'type' => 'upload',
 158             'name' => ts('Save'),
 159             'isDefault' => TRUE,
 160           ),
 161           array(
 162             'type' => 'upload',
 163             'name' => ts('Save and New'),
 164             'subName' => 'new',
 165           ),
 166           array(
 167             'type' => 'cancel',
 168             'name' => ts('Cancel'),
 169           ),
 170         )
 171       );
 172     }
 173   }
 174
 175   /**
 176    * Extract values from the contact create boxes on the form and assign appropriately  to
 177    *
 178    *  - $this->_contributorEmail,
 179    *  - $this->_memberEmail &
 180    *  - $this->_contributionName
 181    *  - $this->_memberName
 182    *  - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
 183    *  - $this->_contributorContactId - id of the contributor
 184    *  - $this->_receiptContactId
 185    *
 186    * If the member & contributor are the same then the values will be the same. But if different people paid
 187    * then they weill differ
 188    *
 189    * @param array $formValues
 190    *   values from form. The important values we are looking for are.
 191    *  - contact_id
 192    *  - soft_credit_contact_id
 193    */
 194   public function storeContactFields($formValues) {
 195     // in a 'standalone form' (contact id not in the url) the contact will be in the form values
 196     if (!empty($formValues['contact_id'])) {
 197       $this->_contactID = $formValues['contact_id'];
 198     }
 199
 200     list($this->_memberDisplayName,
 201       $this->_memberEmail
 202       ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 203
 204     //CRM-10375 Where the payer differs to the member the payer should get the email.
 205     // here we store details in order to do that
 206     if (!empty($formValues['soft_credit_contact_id'])) {
 207       $this->_receiptContactId = $this->_contributorContactID = $formValues['soft_credit_contact_id'];
 208       list($this->_contributorDisplayName,
 209         $this->_contributorEmail) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contributorContactID);
 210     }
 211     else {
 212       $this->_receiptContactId = $this->_contributorContactID = $this->_contactID;
 213       $this->_contributorDisplayName = $this->_memberDisplayName;
 214       $this->_contributorEmail = $this->_memberEmail;
 215     }
 216   }
 217
 218   protected function setContextVariables($params) {
 219     $variables = array(
 220       'action' => '_action',
 221       'context' => '_context',
 222       'id' => '_id',
 223       'cid' => '_contactID',
 224       'mode' => '_mode',
 225     );
 226     foreach ($variables as $paramKey => $classVar) {
 227       if (isset($params[$paramKey]) && !isset($this->$classVar)) {
 228         $this->$classVar = $params[$paramKey];
 229       }
 230     }
 231
 232     if ($this->_mode) {
 233       $this->assignPaymentRelatedVariables();
 234     }
 235
 236     if ($this->_id) {
 237       $this->_memType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $this->_id, 'membership_type_id');
 238       $this->_membershipIDs[] = $this->_id;
 239     }
 240     $this->_fromEmails = CRM_Core_BAO_Email::getFromEmail();
 241   }
 242
 243 }