Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | /** | |
c28e1768 | 29 | * This api exposes CiviCRM relationship types. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
6a488035 | 34 | /** |
9d32e6f7 | 35 | * Create relationship type. |
6a488035 | 36 | * |
cf470720 | 37 | * @param array $params |
2e66abf8 | 38 | * Array per getfields metadata. |
6a488035 | 39 | * |
72b3a70c | 40 | * @return array |
6a488035 TO |
41 | */ |
42 | function civicrm_api3_relationship_type_create($params) { | |
43 | ||
0782c7b9 | 44 | // @todo should we when id is empty? |
45 | if (!isset($params['label_a_b']) && !empty($params['name_a_b'])) { | |
6a488035 TO |
46 | $params['label_a_b'] = $params['name_a_b']; |
47 | } | |
48 | ||
0782c7b9 | 49 | if (!isset($params['label_b_a']) && !empty($params['name_b_a'])) { |
6a488035 TO |
50 | $params['label_b_a'] = $params['name_b_a']; |
51 | } | |
52 | ||
0782c7b9 | 53 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'RelationshipType'); |
6a488035 | 54 | } |
11e09c59 TO |
55 | |
56 | /** | |
0aa0303c EM |
57 | * Adjust Metadata for Create action. |
58 | * | |
59 | * The metadata is used for setting defaults, documentation & validation. | |
1c88e578 | 60 | * |
cf470720 | 61 | * @param array $params |
b081365f | 62 | * Array of parameters determined by getfields. |
6a488035 TO |
63 | */ |
64 | function _civicrm_api3_relationship_type_create_spec(&$params) { | |
6a488035 TO |
65 | $params['name_a_b']['api.required'] = 1; |
66 | $params['name_b_a']['api.required'] = 1; | |
4471f8ca | 67 | $params['is_active']['api.default'] = 1; |
6a488035 TO |
68 | } |
69 | ||
70 | /** | |
9d32e6f7 EM |
71 | * Get all relationship types. |
72 | * | |
d0997921 | 73 | * @param array $params |
d1b0d05e | 74 | * |
645ee340 | 75 | * @return array |
6a488035 TO |
76 | */ |
77 | function civicrm_api3_relationship_type_get($params) { | |
6a488035 TO |
78 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
79 | } | |
80 | ||
81 | /** | |
9d32e6f7 | 82 | * Delete a relationship type. |
6a488035 | 83 | * |
488e7aba | 84 | * @param array $params |
6a488035 | 85 | * |
a6c01b45 | 86 | * @return array |
72b3a70c | 87 | * API Result Array |
6a488035 TO |
88 | */ |
89 | function civicrm_api3_relationship_type_delete($params) { | |
b2402735 | 90 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
6a488035 | 91 | } |
bc255d1d CW |
92 | |
93 | /** | |
9d32e6f7 EM |
94 | * Get list defaults for relationship types. |
95 | * | |
bc255d1d CW |
96 | * @see _civicrm_api3_generic_getlist_defaults |
97 | * | |
98 | * @param array $request | |
dc64d047 | 99 | * |
bc255d1d CW |
100 | * @return array |
101 | */ | |
102 | function _civicrm_api3_relationship_type_getlist_defaults($request) { | |
cf8f0fff | 103 | return [ |
bc255d1d CW |
104 | 'label_field' => 'label_a_b', |
105 | 'search_field' => 'label_a_b', | |
cf8f0fff | 106 | ]; |
cbcb7579 | 107 | } |