CRM/Contact/Form/RelatedContact.php

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