projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 4d4819b0 J |
1 | <?php |
| 2 | /* | |
| 3 | +--------------------------------------------------------------------+ | |
| fee14197 | 4 | | CiviCRM version 5 | |
| 4d4819b0 | 5 | +--------------------------------------------------------------------+ |
| 6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
| 4d4819b0 J |
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 | * This api exposes CiviCRM states/provinces | |
| 30 | * | |
| 31 | * @package CiviCRM_APIv3 | |
| 32 | */ | |
| 33 | ||
| 34 | /** | |
| 35 | * Add a state/province. | |
| 36 | * | |
| 37 | * @param array $params | |
| 38 | * Array per getfields metadata. | |
| 39 | * | |
| 40 | * @return array | |
| 41 | * API result array | |
| 42 | * @throws \API_Exception | |
| 43 | */ | |
| 44 | function civicrm_api3_state_province_create($params) { | |
| a25b46e9 | 45 | return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params, 'StateProvince'); |
| 4d4819b0 J |
46 | } |
| 47 | ||
| 48 | /** | |
| 49 | * Adjust Metadata for Create action. | |
| 50 | * | |
| 51 | * The metadata is used for setting defaults, documentation & validation. | |
| 52 | * | |
| 53 | * @param array $params | |
| 54 | * Array of parameters determined by getfields. | |
| 55 | */ | |
| 56 | function _civicrm_api3_state_province_create_spec(&$params) { | |
| 57 | $params['name']['api.required'] = 1; | |
| 58 | $params['country_id']['api.required'] = 1; | |
| 59 | $params['abbreviation']['api.required'] = 1; | |
| 60 | } | |
| 61 | ||
| 62 | /** | |
| 63 | * Deletes an existing state/province. | |
| 64 | * | |
| 65 | * @param array $params | |
| 66 | * | |
| 67 | * @return array | |
| 68 | */ | |
| 69 | function civicrm_api3_state_province_delete($params) { | |
| 70 | return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
| 71 | } | |
| 72 | ||
| 73 | /** | |
| 74 | * Retrieve one or more states/provinces. | |
| 75 | * | |
| 76 | * @param array $params | |
| 77 | * Array per getfields metadata. | |
| 78 | * | |
| 79 | * @return array | |
| 80 | * api result array | |
| 81 | */ | |
| 82 | function civicrm_api3_state_province_get($params) { | |
| 83 | return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params); | |
| 84 | } |