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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * File for the CiviCRM APIv3 location type functions | |
30 | * | |
31 | * @package CiviCRM_APIv3 | |
32 | * @subpackage API_LocationType | |
33 | * | |
731a0992 | 34 | * @copyright CiviCRM LLC (c) 2004-2014 |
6a488035 TO |
35 | * @version $Id: LocationType.php 2012-11-02 Jon Goldberg $ |
36 | */ | |
37 | ||
38 | /** | |
39 | * Add a Location Type | |
40 | * | |
41 | * Allowed @params array keys are: | |
42 | * | |
43 | * @example LocationTypeCreate.php Standard Create Example | |
44 | * | |
c490a46a | 45 | * @param array $params |
77b97be7 | 46 | * |
a6c01b45 | 47 | * @return array |
72b3a70c | 48 | * API result array |
6a488035 | 49 | * {@getfields email_create} |
6a488035 | 50 | */ |
6a488035 TO |
51 | function civicrm_api3_location_type_create($params) { |
52 | //set display_name equal to name if it's not defined | |
53 | if (!array_key_exists('display_name', $params) && array_key_exists('name', $params)) { | |
54 | $params['display_name'] = $params['name']; | |
55 | } | |
56 | ||
57 | return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
58 | } | |
59 | ||
11e09c59 | 60 | /** |
6a488035 TO |
61 | * Adjust Metadata for Create action |
62 | * | |
63 | * The metadata is used for setting defaults, documentation & validation | |
cf470720 TO |
64 | * @param array $params |
65 | * Array or parameters determined by getfields. | |
6a488035 | 66 | */ |
6a488035 TO |
67 | function _civicrm_api3_location_type_create_spec(&$params) { |
68 | $params['is_active']['api.default'] = 1; | |
69 | $params['name']['api.required'] = 1; | |
70 | } | |
71 | ||
72 | /** | |
73 | * Deletes an existing Location Type | |
74 | * | |
cf470720 | 75 | * @param array $params |
6a488035 TO |
76 | * |
77 | * @example LocationTypeDelete.php Standard Delete Example | |
78 | * | |
a6c01b45 | 79 | * @return array |
72b3a70c | 80 | * API result array |
6a488035 | 81 | * {@getfields LocationType_delete} |
6a488035 | 82 | */ |
6a488035 TO |
83 | function civicrm_api3_location_type_delete($params) { |
84 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
85 | } | |
86 | ||
87 | /** | |
88 | * Retrieve one or more Location Types | |
89 | * | |
cf470720 | 90 | * @param array input parameters |
6a488035 TO |
91 | * |
92 | * | |
93 | * @example LocationTypeGet.php Standard Get Example | |
94 | * | |
cf470720 TO |
95 | * @param array $params |
96 | * An associative array of name/value pairs. | |
6a488035 | 97 | * |
a6c01b45 | 98 | * @return array |
72b3a70c | 99 | * api result |
6a488035 | 100 | * {@getfields LocationType_get} |
6a488035 | 101 | */ |
6a488035 | 102 | function civicrm_api3_location_type_get($params) { |
6a488035 TO |
103 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); |
104 | } |