4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.5 |
6 +--------------------------------------------------------------------+
7 | Copyright CiviCRM LLC (c) 2004-2014 |
8 +--------------------------------------------------------------------+
9 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * File for the CiviCRM APIv3 relationship functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_Relationship
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: Relationship.php 30486 2010-11-02 16:12:09Z shot $
41 * Add or update a relationship
43 * @param array $params input parameters
45 * @throws API_Exception
46 * @example RelationshipCreate.php Std Create example
48 * @return array API Result Array
49 * {@getfields relationship_create}
53 function civicrm_api3_relationship_create($params) {
56 _civicrm_api3_relationship_format_params($params, $values);
58 $action = CRM_Core_Action
::ADD
;
60 if (!empty($params['id'])) {
61 $ids['contactTarget'] = $values['contact_id_b'];
62 $action = CRM_Core_Action
::UPDATE
;
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']);
69 if(!empty($values['contact_id_a'])){
70 $ids['contact'] = $values['contact_id_a'];
72 $relationshipBAO = CRM_Contact_BAO_Relationship
::create($values, $ids);
74 if ($relationshipBAO[1]) {
75 throw new API_Exception('Relationship is not valid');
77 elseif ($relationshipBAO[2]) {
78 throw new API_Exception('Relationship already exists');
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);
84 $id = $relationshipBAO[4][0];
86 _civicrm_api3_object_to_array($relationshipBAO[5][$id], $values[$id]);
87 return civicrm_api3_create_success($values, $params, 'relationship', 'create');
91 * Adjust Metadata for Create action
93 * @param array $params array or parameters determined by getfields
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;
103 * Delete a relationship
105 * @param array $params
107 * @return array API Result Array
108 * {@getfields relationship_delete}
109 * @example RelationshipDelete.php Delete Example
114 function civicrm_api3_relationship_delete($params) {
116 if (!CRM_Utils_Rule
::integer($params['id'])) {
117 return civicrm_api3_create_error('Invalid value for relationship ID');
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');
126 $relationBAO->del($params['id']);
127 return civicrm_api3_create_success('Deleted relationship successfully');
132 * Function to get the relationship
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)
139 * @return Array API Result Array
140 * {@getfields relationship_get}
141 * @example RelationshipGet.php
144 function civicrm_api3_relationship_get($params) {
145 $options = _civicrm_api3_get_options_from_params($params);
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);
151 $relationships = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE);
154 $relationships = array();
155 $relationships = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'],
156 CRM_Utils_Array
::value('status_id', $params),
158 CRM_Utils_Array
::value('is_count', $options),
159 CRM_Utils_Array
::value('id', $params),
166 //perhaps we should add a 'getcount' but at this stage lets just handle getcount output
167 if($options['is_count']) {
168 return array('count' => $relationships);
170 foreach ($relationships as $relationshipId => $values) {
171 _civicrm_api3_custom_data_get($relationships[$relationshipId], 'Relationship', $relationshipId, NULL, CRM_Utils_Array
::value('relationship_type_id',$values));
173 return civicrm_api3_create_success($relationships, $params);
177 * take the input parameter list as specified in the data model and
178 * convert it into the same format that we use in QF and BAO object
180 * @param array $params Associative array of property name/value
181 * pairs to insert in new contact.
182 * @param array $values The reformatted properties that we can use internally
186 * @return array|CRM_Error
189 function _civicrm_api3_relationship_format_params($params, &$values) {
190 // copy all the relationship fields as is
192 $fields = CRM_Contact_DAO_Relationship
::fields();
193 _civicrm_api3_store_values($fields, $params, $values);
195 $relationTypes = CRM_Core_PseudoConstant
::relationshipType('name');
196 if (!empty($params['id'])) {
197 $relation = new CRM_Contact_BAO_Relationship();
198 $relation->id
= $params['id'];
199 if (!$relation->find(TRUE)) {
200 throw new Exception('Relationship id is not valid');
203 if ((isset($params['contact_id_a']) && $params['contact_id_a'] != $relation->contact_id_a
) ||
204 (isset($params['contact_id_b']) && $params['contact_id_b'] != $relation->contact_id_b
)
206 throw new Exception('Cannot change the contacts once relationship has been created');
209 // since the BAO function is not std & won't accept just 'id' (aargh) let's
210 // at least return our BAO here
212 _civicrm_api3_object_to_array($relation, $values);
213 $values = array_merge($values, $params);
214 // and we need to reformat our date fields....
215 $dateFields = array('start_date', 'end_date');
216 foreach ($dateFields as $dateField){
217 $values[$dateField] = CRM_Utils_Date
::processDate($values[$dateField]);
223 foreach ($params as $key => $value) {
224 // ignore empty values or empty arrays etc
225 if (CRM_Utils_System
::isNull($value)) {
232 if (!CRM_Utils_Rule
::integer($value)) {
233 throw new Exception("contact_id not valid: $value");
235 $dao = new CRM_Core_DAO();
237 $svq = $dao->singleValueQuery("SELECT id FROM civicrm_contact WHERE id = $value",
241 throw new Exception("Invalid Contact ID: There is no contact record with contact_id = $value.");
245 case 'relationship_type':
246 foreach ($relationTypes as $relTypId => $relValue) {
247 if (CRM_Utils_Array
::key(ucfirst($value), $relValue)) {
248 $relationshipTypeId = $relTypId;
253 if ($relationshipTypeId) {
254 if (!empty($values['relationship_type_id']) &&
255 $relationshipTypeId != $values['relationship_type_id']
257 throw new Exception('Mismatched Relationship Type and Relationship Type Id');
259 $values['relationship_type_id'] = $params['relationship_type_id'] = $relationshipTypeId;
262 throw new Exception('Invalid Relationship Type');
264 case 'relationship_type_id':
265 if ($key == 'relationship_type_id' && !array_key_exists($value, $relationTypes)) {
266 throw new Exception("$key not a valid: $value");
269 // execute for both relationship_type and relationship_type_id
270 $relation = $relationTypes[$params['relationship_type_id']];
271 if (!empty($params['contact_id_a']) && $relation['contact_type_a'] &&
272 $relation['contact_type_a'] != CRM_Contact_BAO_Contact
::getContactType($params['contact_id_a'])
274 throw new Exception("Contact ID :{$params['contact_id_a']} is not of contact type {$relation['contact_type_a']}");
276 if (!empty($params['contact_id_b']) && $relation['contact_type_b'] &&
277 $relation['contact_type_b'] != CRM_Contact_BAO_Contact
::getContactType($params['contact_id_b'])
279 throw new Exception("Contact ID :{$params['contact_id_b']} is not of contact type {$relation['contact_type_b']}");
288 if (array_key_exists('note', $params)) {
289 $values['note'] = $params['note'];
291 _civicrm_api3_custom_format_params($params, $values, 'Relationship');