CRM/Member/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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-2013
  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_Core_Form {
  41
  42   /**
  43    * The id of the object being edited / created
  44    *
  45    * @var int
  46    */
  47   protected $_id;
  48
  49   /**
  50    * The name of the BAO object for this form
  51    *
  52    * @var string
  53    */
  54   protected $_BAOName;
  55
  56   function preProcess() {
  57     $this->_id = $this->get('id');
  58     $this->_BAOName = $this->get('BAOName');
  59   }
  60
  61   /**
  62    * This function sets the default values for the form. MobileProvider that in edit/view mode
  63    * the default values are retrieved from the database
  64    *
  65    * @access public
  66    *
  67    * @return None
  68    */
  69   function setDefaultValues() {
  70     $defaults = array();
  71
  72     if (isset($this->_id)) {
  73       $params = array('id' => $this->_id);
  74       require_once (str_replace('_', DIRECTORY_SEPARATOR, $this->_BAOName) . ".php");
  75       eval($this->_BAOName . '::retrieve( $params, $defaults );');
  76     }
  77
  78     if (isset($defaults['minimum_fee'])) {
  79       $defaults['minimum_fee'] = CRM_Utils_Money::format($defaults['minimum_fee'], NULL, '%a');
  80     }
  81
  82     if (isset($defaults['status'])) {
  83       $this->assign('membershipStatus', $defaults['status']);
  84     }
  85
  86     if ($this->_action & CRM_Core_Action::ADD) {
  87       $defaults['is_active'] = 1;
  88     }
  89
  90     if (isset($defaults['member_of_contact_id']) &&
  91       $defaults['member_of_contact_id']
  92     ) {
  93       $defaults['member_org'] = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_Contact',
  94         $defaults['member_of_contact_id'], 'display_name'
  95       );
  96     }
  97     return $defaults;
  98   }
  99
 100   /**
 101    * Function to actually build the form
 102    *
 103    * @return None
 104    * @access public
 105    */
 106   public function buildQuickForm() {
 107     if ($this->_action & CRM_Core_Action::RENEW) {
 108       $this->addButtons(array(
 109           array(
 110             'type' => 'upload',
 111             'name' => ts('Renew'),
 112             'isDefault' => TRUE
 113           ),
 114           array(
 115             'type' => 'cancel',
 116             'name' => ts('Cancel')
 117           )
 118         )
 119       );
 120     }
 121     elseif ($this->_action & CRM_Core_Action::DELETE) {
 122       $this->addButtons(array(
 123           array(
 124             'type' => 'next',
 125             'name' => ts('Delete'),
 126             'isDefault' => TRUE
 127           ),
 128           array(
 129             'type' => 'cancel',
 130             'name' => ts('Cancel')
 131           )
 132         )
 133       );
 134     }
 135     else {
 136       $this->addButtons(array(
 137           array(
 138             'type' => 'upload',
 139             'name' => ts('Save'),
 140             'isDefault' => TRUE
 141           ),
 142           array(
 143             'type' => 'upload',
 144             'name' => ts('Save and New'),
 145             'subName' => 'new'
 146           ),
 147           array(
 148             'type' => 'cancel',
 149             'name' => ts('Cancel')
 150           )
 151         )
 152       );
 153     }
 154   }
 155
 156   /*
 157    * Function to extract values from the contact create boxes on the form and assign appropriatley  to
 158    *
 159    *  - $this->_contributorEmail,
 160    *  - $this->_memberEmail &
 161    *  - $this->_contributonName
 162    *  - $this->_memberName
 163    *  - $this->_contactID (effectively memberContactId but changing might have spin-off effects)
 164    *  - $this->_contributorContactId - id of the contributor
 165    *  - $this->_receiptContactId
 166    *
 167    * If the member & contributor are the same then the values will be the same. But if different people paid
 168    * then they weill differ
 169    *
 170    * @param $formValues array values from form. The important values we are looking for are
 171    *  - contact_select_id[1]
 172    *  - contribution_contact_select_id[1]
 173    */
 174   function storeContactFields($formValues){
 175     // in a 'standalone form' (contact id not in the url) the contact will be in the form values
 176     if (CRM_Utils_Array::value('contact_select_id', $formValues)) {
 177       $this->_contactID = $formValues['contact_select_id'][1];
 178     }
 179
 180     list($this->_memberDisplayName,
 181          $this->_memberEmail
 182     ) = CRM_Contact_BAO_Contact_Location::getEmailDetails($this->_contactID);
 183
 184     //CRM-10375 Where the payer differs to the member the payer should get the email.
 185     // here we store details in order to do that
 186     if (CRM_Utils_Array::value('contribution_contact_select_id', $formValues) && CRM_Utils_Array::value('1', $formValues['contribution_contact_select_id'])) {
 187       $this->_receiptContactId = $this->_contributorContactID = $formValues['contribution_contact_select_id'][1];
 188        list( $this->_contributorDisplayName,
 189          $this->_contributorEmail ) = CRM_Contact_BAO_Contact_Location::getEmailDetails( $this->_contributorContactID );
 190     }
 191     else {
 192       $this->_receiptContactId = $this->_contributorContactID = $this->_contactID;
 193       $this->_contributorDisplayName = $this->_memberDisplayName;
 194       $this->_contributorEmail = $this->_memberEmail;
 195     }
 196   }
 197 }
 198