3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
29 * File for the CiviCRM APIv3 location type functions
31 * @package CiviCRM_APIv3
32 * @subpackage API_LocationType
34 * @copyright CiviCRM LLC (c) 2004-2014
35 * @version $Id: LocationType.php 2012-11-02 Jon Goldberg $
41 * Allowed @params array keys are:
43 * @example LocationTypeCreate.php Standard Create Example
45 * @param array $params
49 * {@getfields email_create}
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'];
57 return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
61 * Adjust Metadata for Create action
63 * The metadata is used for setting defaults, documentation & validation
64 * @param array $params
65 * Array or parameters determined by getfields.
67 function _civicrm_api3_location_type_create_spec(&$params) {
68 $params['is_active']['api.default'] = 1;
69 $params['name']['api.required'] = 1;
73 * Deletes an existing Location Type
75 * @param array $params
77 * @example LocationTypeDelete.php Standard Delete Example
81 * {@getfields LocationType_delete}
83 function civicrm_api3_location_type_delete($params) {
84 return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__
), $params);
88 * Retrieve one or more Location Types
90 * @param array input parameters
93 * @example LocationTypeGet.php Standard Get Example
95 * @param array $params
96 * An associative array of name/value pairs.
100 * {@getfields LocationType_get}
102 function civicrm_api3_location_type_get($params) {
103 return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__
), $params);