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