CRM/Contact/Form/RelatedContact.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  */
  34
  35 /**
  36  * This class generates form components generic to all the contact types.
  37  *
  38  * It delegates the work to lower level subclasses and integrates the changes
  39  * back in. It also uses a lot of functionality with the CRM API's, so any change
  40  * made here could potentially affect the API etc. Be careful, be aware, use unit tests.
  41  */
  42 class CRM_Contact_Form_RelatedContact extends CRM_Core_Form {
  43
  44   /**
  45    * The contact type of the form
  46    *
  47    * @var string
  48    */
  49   protected $_contactType;
  50
  51   /**
  52    * The contact id, used when editing the form
  53    *
  54    * @var int
  55    */
  56   public $_contactId;
  57
  58   /**
  59    * Form defaults
  60    *
  61    * @var array
  62    */
  63   protected $_defaults = array();
  64
  65   /**
  66    * Build all the data structures needed to build the form.
  67    */
  68   public function preProcess() {
  69     // reset action from the session
  70     $this->_action = CRM_Utils_Request::retrieve('action', 'String',
  71       $this, FALSE, 'update'
  72     );
  73     $this->_contactId = CRM_Utils_Request::retrieve('cid', 'Positive', $this, TRUE);
  74
  75     $rcid = CRM_Utils_Request::retrieve('rcid', 'Positive', $this);
  76     $rcid = $rcid ? "&id={$rcid}" : '';
  77     $session = CRM_Core_Session::singleton();
  78     $session->pushUserContext(CRM_Utils_System::url('civicrm/user', "reset=1{$rcid}"));
  79
  80     if ($this->_contactId) {
  81       $contact = new CRM_Contact_DAO_Contact();
  82       $contact->id = $this->_contactId;
  83       if (!$contact->find(TRUE)) {
  84         CRM_Core_Error::statusBounce(ts('contact does not exist: %1', array(1 => $this->_contactId)));
  85       }
  86       $this->_contactType = $contact->contact_type;
  87
  88       // check for permissions
  89       if (!CRM_Contact_BAO_Contact_Permission::allow($this->_contactId, CRM_Core_Permission::EDIT)) {
  90         CRM_Core_Error::statusBounce(ts('You do not have the necessary permission to edit this contact.'));
  91       }
  92
  93       list($displayName, $contactImage) = CRM_Contact_BAO_Contact::getDisplayAndImage($this->_contactId);
  94       CRM_Utils_System::setTitle($displayName, $contactImage . ' ' . $displayName);
  95     }
  96     else {
  97       CRM_Core_Error::statusBounce(ts('Could not get a contact_id and/or contact_type'));
  98     }
  99   }
 100
 101   /**
 102    * Set default values for the form. Note that in edit/view mode
 103    * the default values are retrieved from the database
 104    *
 105    *
 106    * @return void
 107    */
 108   public function setDefaultValues() {
 109     return $this->_defaults;
 110   }
 111
 112   /**
 113    * Build the form object.
 114    */
 115   public function buildQuickForm() {
 116     $params = array();
 117     $params['id'] = $params['contact_id'] = $this->_contactId;
 118     $contact = CRM_Contact_BAO_Contact::retrieve($params, $this->_defaults);
 119
 120     $countryID = '';
 121     $stateID = '';
 122     if (!empty($this->_defaults['address'][1])) {
 123       $countryID = CRM_Utils_Array::value('country_id',
 124         $this->_defaults['address'][1]
 125       );
 126       $stateID = CRM_Utils_Array::value('state_province_id',
 127         $this->_defaults['address'][1]
 128       );
 129     }
 130     CRM_Contact_BAO_Contact_Utils::buildOnBehalfForm($this,
 131       $this->_contactType,
 132       $countryID,
 133       $stateID,
 134       ts('Contact Information')
 135     );
 136
 137     $this->addButtons(array(
 138       array(
 139         'type' => 'next',
 140         'name' => ts('Save'),
 141         'isDefault' => TRUE,
 142       ),
 143       array(
 144         'type' => 'cancel',
 145         'name' => ts('Cancel'),
 146       ),
 147     ));
 148   }
 149
 150   /**
 151    * Form submission of new/edit contact is processed.
 152    */
 153   public function postProcess() {
 154     // store the submitted values in an array
 155     $params = $this->controller->exportValues($this->_name);
 156
 157     $locType = CRM_Core_BAO_LocationType::getDefault();
 158     foreach (array(
 159                'phone',
 160                'email',
 161                'address',
 162              ) as $locFld) {
 163       if (!empty($this->_defaults[$locFld]) && $this->_defaults[$locFld][1]['location_type_id']) {
 164         $params[$locFld][1]['is_primary'] = $this->_defaults[$locFld][1]['is_primary'];
 165         $params[$locFld][1]['location_type_id'] = $this->_defaults[$locFld][1]['location_type_id'];
 166       }
 167       else {
 168         $params[$locFld][1]['is_primary'] = 1;
 169         $params[$locFld][1]['location_type_id'] = $locType->id;
 170       }
 171     }
 172
 173     $params['contact_type'] = $this->_contactType;
 174     //CRM-14904
 175     if (isset($this->_defaults['contact_sub_type'])) {
 176       $params['contact_sub_type'] = $this->_defaults['contact_sub_type'];
 177     }
 178     $params['contact_id'] = $this->_contactId;
 179
 180     $contact = CRM_Contact_BAO_Contact::create($params, TRUE);
 181
 182     // set status message.
 183     if ($this->_contactId) {
 184       $message = ts('%1 has been updated.', array(1 => $contact->display_name));
 185     }
 186     else {
 187       $message = ts('%1 has been created.', array(1 => $contact->display_name));
 188     }
 189     CRM_Core_Session::setStatus($message, ts('Contact Saved'), 'success');
 190   }
 191 }