Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
6a488035 TO |
2 | /* |
3 | +--------------------------------------------------------------------+ | |
39de6fd5 | 4 | | CiviCRM version 4.6 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
731a0992 | 6 | | Copyright CiviCRM LLC (c) 2004-2014 | |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
244bbdd8 | 29 | * This api exposes CiviCRM LocationType records. |
6a488035 TO |
30 | * |
31 | * @package CiviCRM_APIv3 | |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
244bbdd8 | 35 | * Add a LocationType. |
6a488035 | 36 | * |
c490a46a | 37 | * @param array $params |
77b97be7 | 38 | * |
a6c01b45 | 39 | * @return array |
1747ab99 | 40 | * API result array. |
6a488035 | 41 | */ |
6a488035 TO |
42 | function civicrm_api3_location_type_create($params) { |
43 | //set display_name equal to name if it's not defined | |
44 | if (!array_key_exists('display_name', $params) && array_key_exists('name', $params)) { | |
45 | $params['display_name'] = $params['name']; | |
46 | } | |
47 | ||
48 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
49 | } | |
50 | ||
11e09c59 | 51 | /** |
0aa0303c EM |
52 | * Adjust Metadata for Create action. |
53 | * | |
54 | * The metadata is used for setting defaults, documentation & validation. | |
6a488035 | 55 | * |
cf470720 | 56 | * @param array $params |
b081365f | 57 | * Array of parameters determined by getfields. |
6a488035 | 58 | */ |
6a488035 TO |
59 | function _civicrm_api3_location_type_create_spec(&$params) { |
60 | $params['is_active']['api.default'] = 1; | |
61 | $params['name']['api.required'] = 1; | |
62 | } | |
63 | ||
64 | /** | |
244bbdd8 | 65 | * Deletes an existing LocationType. |
6a488035 | 66 | * |
cf470720 | 67 | * @param array $params |
6a488035 | 68 | * |
a6c01b45 | 69 | * @return array |
1747ab99 | 70 | * API result array. |
6a488035 | 71 | */ |
6a488035 TO |
72 | function civicrm_api3_location_type_delete($params) { |
73 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
74 | } | |
75 | ||
76 | /** | |
244bbdd8 | 77 | * Retrieve one or more LocationTypes. |
6a488035 | 78 | * |
cf470720 TO |
79 | * @param array $params |
80 | * An associative array of name/value pairs. | |
6a488035 | 81 | * |
a6c01b45 | 82 | * @return array |
1747ab99 | 83 | * API result array. |
6a488035 | 84 | */ |
6a488035 | 85 | function civicrm_api3_location_type_get($params) { |
6a488035 TO |
86 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
87 | } |