4 +--------------------------------------------------------------------+
5 | CiviCRM version 4.6 |
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
46 * @throws API_Exception
47 * @example RelationshipCreate.php Std Create example
49 * @return array API Result Array
50 * {@getfields relationship_create}
54 function civicrm_api3_relationship_create($params) {
55 _civicrm_api3_handle_relationship_type($params);
56 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params, 'Relationship');
60 * Adjust Metadata for Create action
62 * @param array $params
63 * Array or parameters determined by getfields.
65 function _civicrm_api3_relationship_create_spec(&$params) {
66 $params['contact_id_a']['api.required'] = 1;
67 $params['contact_id_b']['api.required'] = 1;
68 $params['relationship_type_id']['api.required'] = 1;
69 $params['is_active']['api.default'] = 1;
73 * Delete a relationship
75 * @param array $params
77 * @return array API Result Array
78 * {@getfields relationship_delete}
79 * @example RelationshipDelete.php Delete Example
84 function civicrm_api3_relationship_delete($params) {
86 if (!CRM_Utils_Rule
::integer($params['id'])) {
87 return civicrm_api3_create_error('Invalid value for relationship ID');
90 $relationBAO = new CRM_Contact_BAO_Relationship();
91 $relationBAO->id
= $params['id'];
92 if (!$relationBAO->find(TRUE)) {
93 return civicrm_api3_create_error('Relationship id is not valid');
96 $relationBAO->del($params['id']);
97 return civicrm_api3_create_success('Deleted relationship successfully');
102 * get the relationship
104 * @param array $params
106 * @todo Result is inconsistent depending on whether contact_id is passed in :
107 * - if you pass in contact_id - it just returns all relationships for 'contact_id'
108 * - if you don't pass in contact_id then it does a filter on the relationship table (DAO based search)
110 * @return Array API Result Array
111 * {@getfields relationship_get}
112 * @example RelationshipGet.php
115 function civicrm_api3_relationship_get($params) {
116 $options = _civicrm_api3_get_options_from_params($params);
118 if (empty($params['contact_id'])) {
119 if(!empty($params['membership_type_id']) && empty($params['relationship_type_id'])) {
120 CRM_Contact_BAO_Relationship
::membershipTypeToRelationshipTypes($params);
122 $relationships = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params, FALSE, 'Relationship');
125 $relationships = CRM_Contact_BAO_Relationship
::getRelationship($params['contact_id'],
126 CRM_Utils_Array
::value('status_id', $params),
128 CRM_Utils_Array
::value('is_count', $options),
129 CRM_Utils_Array
::value('id', $params),
136 //perhaps we should add a 'getcount' but at this stage lets just handle getcount output
137 if($options['is_count']) {
138 return array('count' => $relationships);
140 foreach ($relationships as $relationshipId => $values) {
141 _civicrm_api3_custom_data_get($relationships[$relationshipId], 'Relationship', $relationshipId, NULL, CRM_Utils_Array
::value('relationship_type_id',$values));
143 return civicrm_api3_create_success($relationships, $params);
147 * legacy handling for relationship_type parameter
149 * @param array $params
150 * Associative array of property name/value.
151 * pairs to insert in new contact.
153 function _civicrm_api3_handle_relationship_type(&$params) {
154 if (empty($params['relationship_type_id']) && !empty($params['relationship_type'])) {
155 $relationTypes = CRM_Core_PseudoConstant
::relationshipType('name');
156 foreach ($relationTypes as $relationshipTypeId => $relationshipValue) {
157 if (CRM_Utils_Array
::key(ucfirst($params['relationship_type']), $relationshipValue)) {
158 $params['relationship_type_id'] = $relationshipTypeId;