api/v3/StateProvince.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM states/provinces
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Add a state/province.
  20  *
  21  * @param array $params
  22  *   Array per getfields metadata.
  23  *
  24  * @return array
  25  *   API result array
  26  * @throws \API_Exception
  27  */
  28 function civicrm_api3_state_province_create($params) {
  29   return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params, 'StateProvince');
  30 }
  31
  32 /**
  33  * Adjust Metadata for Create action.
  34  *
  35  * The metadata is used for setting defaults, documentation & validation.
  36  *
  37  * @param array $params
  38  *   Array of parameters determined by getfields.
  39  */
  40 function _civicrm_api3_state_province_create_spec(&$params) {
  41   $params['name']['api.required'] = 1;
  42   $params['country_id']['api.required'] = 1;
  43   $params['abbreviation']['api.required'] = 1;
  44 }
  45
  46 /**
  47  * Deletes an existing state/province.
  48  *
  49  * @param array $params
  50  *
  51  * @return array
  52  */
  53 function civicrm_api3_state_province_delete($params) {
  54   return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
  55 }
  56
  57 /**
  58  * Retrieve one or more states/provinces.
  59  *
  60  * @param array $params
  61  *   Array per getfields metadata.
  62  *
  63  * @return array
  64  *   api result array
  65  */
  66 function civicrm_api3_state_province_get($params) {
  67   return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params);
  68 }