aaa1aaa44509f7bcc7d40c1bbb36cd190a85355d
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 location type functions
32 * @package CiviCRM_APIv3
33 * @subpackage API_LocationType
35 * @copyright CiviCRM LLC (c) 2004-2014
36 * @version $Id: LocationType.php 2012-11-02 Jon Goldberg $
42 * Allowed @params array keys are:
44 * @example LocationTypeCreate.php Standard Create Example
46 * @param array $params
48 * @return array API result array
49 * {@getfields email_create}
52 function civicrm_api3_location_type_create($params) {
53 //set display_name equal to name if it's not defined
54 if (!array_key_exists('display_name', $params) && array_key_exists('name', $params)) {
55 $params['display_name'] = $params['name'];
58 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
62 * Adjust Metadata for Create action
64 * The metadata is used for setting defaults, documentation & validation
65 * @param array $params
66 * Array or parameters determined by getfields.
68 function _civicrm_api3_location_type_create_spec(&$params) {
69 $params['is_active']['api.default'] = 1;
70 $params['name']['api.required'] = 1;
74 * Deletes an existing Location Type
76 * @param array $params
78 * @example LocationTypeDelete.php Standard Delete Example
80 * @return array API result array
81 * {@getfields LocationType_delete}
84 function civicrm_api3_location_type_delete($params) {
85 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
89 * Retrieve one or more Location Types
91 * @param array input parameters
94 * @example LocationTypeGet.php Standard Get Example
96 * @param array $params
97 * An associative array of name/value pairs.
99 * @return array api result
100 * {@getfields LocationType_get}
103 function civicrm_api3_location_type_get($params) {
104 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);