api/v3/Relationship.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.6                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 relationship functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_Relationship
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: Relationship.php 30486 2010-11-02 16:12:09Z shot $
  37  *
  38  */
  39
  40 /**
  41  * Add or update a relationship
  42  *
  43  * @param  array $params input parameters
  44  *
  45  * @throws API_Exception
  46  * @example RelationshipCreate.php Std Create example
  47  *
  48  * @return array API Result Array
  49  * {@getfields relationship_create}
  50  * @static void
  51  * @access public
  52  */
  53 function civicrm_api3_relationship_create($params) {
  54
  55   $values = array();
  56   _civicrm_api3_relationship_format_params($params, $values);
  57   $ids = array();
  58   $action = CRM_Core_Action::ADD;
  59
  60   if (!empty($params['id'])) {
  61     $ids['contactTarget'] = $values['contact_id_b'];
  62     $action = CRM_Core_Action::UPDATE;
  63   }
  64
  65   $values['relationship_type_id'] = $values['relationship_type_id'] . '_a_b';
  66   if(!empty($params['contact_id_b'])){
  67     $values['contact_check'] = array($params['contact_id_b'] => $params['contact_id_b']);
  68   }
  69   if(!empty($values['contact_id_a'])){
  70     $ids['contact'] = $values['contact_id_a'];
  71   }
  72   $relationshipBAO = CRM_Contact_BAO_Relationship::create($values, $ids);
  73
  74   if ($relationshipBAO[1]) {
  75     throw new API_Exception('Relationship is not valid');
  76   }
  77   elseif ($relationshipBAO[2]) {
  78     throw new API_Exception('Relationship already exists');
  79   }
  80   // Handle related memberships CRM-13652
  81   if (!empty($params['contact_id_a'])) {
  82     CRM_Contact_BAO_Relationship::relatedMemberships($params['contact_id_a'], $values, $ids, $action);
  83   }
  84   $id = $relationshipBAO[4][0];
  85   $values = array();
  86   _civicrm_api3_object_to_array($relationshipBAO[5][$id], $values[$id]);
  87   return civicrm_api3_create_success($values, $params, 'relationship', 'create');
  88 }
  89
  90 /**
  91  * Adjust Metadata for Create action
  92  *
  93  * @param array $params array or parameters determined by getfields
  94  */
  95 function _civicrm_api3_relationship_create_spec(&$params) {
  96   $params['contact_id_a']['api.required'] = 1;
  97   $params['contact_id_b']['api.required'] = 1;
  98   $params['relationship_type_id']['api.required'] = 1;
  99   $params['is_active']['api.default'] = 1;
 100 }
 101
 102 /**
 103  * Delete a relationship
 104  *
 105  * @param  array $params
 106  *
 107  * @return array API Result Array
 108  * {@getfields relationship_delete}
 109  * @example RelationshipDelete.php Delete Example
 110  *
 111  * @static void
 112  * @access public
 113  */
 114 function civicrm_api3_relationship_delete($params) {
 115
 116   if (!CRM_Utils_Rule::integer($params['id'])) {
 117     return civicrm_api3_create_error('Invalid value for relationship ID');
 118   }
 119
 120   $relationBAO = new CRM_Contact_BAO_Relationship();
 121   $relationBAO->id = $params['id'];
 122   if (!$relationBAO->find(TRUE)) {
 123     return civicrm_api3_create_error('Relationship id is not valid');
 124   }
 125   else {
 126     $relationBAO->del($params['id']);
 127     return civicrm_api3_create_success('Deleted relationship successfully');
 128   }
 129 }
 130
 131 /**
 132  * get the relationship
 133  *
 134  * @param array   $params input parameters.
 135  * @todo  Result is inconsistent depending on whether contact_id is passed in :
 136  * -  if you pass in contact_id - it just returns all relationships for 'contact_id'
 137  * -  if you don't pass in contact_id then it does a filter on the relationship table (DAO based search)
 138  *
 139  * @return  Array API Result Array
 140  * {@getfields relationship_get}
 141  * @example RelationshipGet.php
 142  * @access  public
 143  */
 144 function civicrm_api3_relationship_get($params) {
 145   $options = _civicrm_api3_get_options_from_params($params);
 146
 147   if (empty($params['contact_id'])) {
 148     if(!empty($params['membership_type_id']) && empty($params['relationship_type_id'])) {
 149       CRM_Contact_BAO_Relationship::membershipTypeToRelationshipTypes($params);
 150     }
 151     $relationships = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Relationship');
 152   }
 153   else {
 154     $relationships = CRM_Contact_BAO_Relationship::getRelationship($params['contact_id'],
 155       CRM_Utils_Array::value('status_id', $params),
 156       0,
 157       CRM_Utils_Array::value('is_count', $options),
 158       CRM_Utils_Array::value('id', $params),
 159       NULL,
 160       NULL,
 161       FALSE,
 162       $params
 163     );
 164   }
 165   //perhaps we should add a 'getcount' but at this stage lets just handle getcount output
 166   if($options['is_count']) {
 167     return array('count' => $relationships);
 168   }
 169   foreach ($relationships as $relationshipId => $values) {
 170     _civicrm_api3_custom_data_get($relationships[$relationshipId], 'Relationship', $relationshipId, NULL, CRM_Utils_Array::value('relationship_type_id',$values));
 171   }
 172   return civicrm_api3_create_success($relationships, $params);
 173 }
 174
 175 /**
 176  * take the input parameter list as specified in the data model and
 177  * convert it into the same format that we use in QF and BAO object
 178  *
 179  * @param array $params Associative array of property name/value
 180  *                             pairs to insert in new contact.
 181  * @param array $values The reformatted properties that we can use internally
 182  *                            '
 183  *
 184  * @throws Exception
 185  * @return array|CRM_Error
 186  * @access public
 187  */
 188 function _civicrm_api3_relationship_format_params($params, &$values) {
 189   // copy all the relationship fields as is
 190
 191   $fields = CRM_Contact_DAO_Relationship::fields();
 192   _civicrm_api3_store_values($fields, $params, $values);
 193
 194   $relationTypes = CRM_Core_PseudoConstant::relationshipType('name');
 195   if (!empty($params['id'])) {
 196     $relation = new CRM_Contact_BAO_Relationship();
 197     $relation->id = $params['id'];
 198     if (!$relation->find(TRUE)) {
 199       throw new Exception('Relationship id is not valid');
 200     }
 201     else {
 202       if ((isset($params['contact_id_a']) && $params['contact_id_a'] != $relation->contact_id_a) ||
 203         (isset($params['contact_id_b']) && $params['contact_id_b'] != $relation->contact_id_b)
 204       ) {
 205         throw new Exception('Cannot change the contacts once relationship has been created');
 206       }
 207       else {
 208         // since the BAO function is not std & won't accept just 'id' (aargh) let's
 209         // at least return our BAO here
 210         $values = array();
 211         _civicrm_api3_object_to_array($relation, $values);
 212         $values = array_merge($values, $params);
 213         // and we need to reformat our date fields....
 214         $dateFields = array('start_date', 'end_date');
 215         foreach ($dateFields as $dateField){
 216           $values[$dateField] = CRM_Utils_Date::processDate($values[$dateField]);
 217         }
 218       }
 219     }
 220   }
 221
 222   foreach ($params as $key => $value) {
 223     // ignore empty values or empty arrays etc
 224     if (CRM_Utils_System::isNull($value)) {
 225       continue;
 226     }
 227
 228     switch ($key) {
 229       case 'contact_id_a':
 230       case 'contact_id_b':
 231         if (!CRM_Utils_Rule::integer($value)) {
 232           throw new Exception("contact_id not valid: $value");
 233         }
 234         $dao     = new CRM_Core_DAO();
 235         $qParams = array();
 236         $svq     = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
 237           $qParams
 238         );
 239         if (!$svq) {
 240           throw new Exception("Invalid Contact ID: There is no contact record with contact_id = $value.");
 241         }
 242         break;
 243
 244       case 'relationship_type':
 245         foreach ($relationTypes as $relTypId => $relValue) {
 246           if (CRM_Utils_Array::key(ucfirst($value), $relValue)) {
 247             $relationshipTypeId = $relTypId;
 248             break;
 249           }
 250         }
 251
 252         if ($relationshipTypeId) {
 253           if (!empty($values['relationship_type_id']) &&
 254             $relationshipTypeId != $values['relationship_type_id']
 255           ) {
 256             throw new Exception('Mismatched Relationship Type and Relationship Type Id');
 257           }
 258           $values['relationship_type_id'] = $params['relationship_type_id'] = $relationshipTypeId;
 259         }
 260         else {
 261           throw new Exception('Invalid Relationship Type');
 262         }
 263       case 'relationship_type_id':
 264         if ($key == 'relationship_type_id' && !array_key_exists($value, $relationTypes)) {
 265           throw new Exception("$key not a valid: $value");
 266         }
 267
 268         // execute for both relationship_type and relationship_type_id
 269         $relation = $relationTypes[$params['relationship_type_id']];
 270         if (!empty($params['contact_id_a']) && $relation['contact_type_a'] &&
 271           $relation['contact_type_a'] != CRM_Contact_BAO_Contact::getContactType($params['contact_id_a'])
 272         ) {
 273           throw new Exception("Contact ID :{$params['contact_id_a']} is not of contact type {$relation['contact_type_a']}");
 274         }
 275         if (!empty($params['contact_id_b']) && $relation['contact_type_b'] &&
 276           $relation['contact_type_b'] != CRM_Contact_BAO_Contact::getContactType($params['contact_id_b'])
 277         ) {
 278           throw new Exception("Contact ID :{$params['contact_id_b']} is not of contact type {$relation['contact_type_b']}");
 279         }
 280         break;
 281
 282       default:
 283         break;
 284     }
 285   }
 286
 287   if (array_key_exists('note', $params)) {
 288     $values['note'] = $params['note'];
 289   }
 290   _civicrm_api3_custom_format_params($params, $values, 'Relationship');
 291
 292   return array();
 293 }