api/v3/Country.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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 country.
  30  *
  31  * @package CiviCRM_APIv3
  32  * @subpackage API_Country
  33  *
  34  */
  35
  36 /**
  37  * Add an Country for a contact.
  38  *
  39  * @param array $params
  40  *   Array per getfields metadata.
  41  *
  42  * @return array
  43  *   API result array
  44  * @throws \API_Exception
  45  */
  46 function civicrm_api3_country_create($params) {
  47   return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params);
  48 }
  49
  50 /**
  51  * Adjust Metadata for Create action.
  52  *
  53  * The metadata is used for setting defaults, documentation & validation.
  54  *
  55  * @param array $params
  56  *   Array or parameters determined by getfields.
  57  */
  58 function _civicrm_api3_country_create_spec(&$params) {
  59   $params['name']['api.required'] = 1;
  60 }
  61
  62 /**
  63  * Deletes an existing Country.
  64  *
  65  * @param array $params
  66  *
  67  * @return array
  68  */
  69 function civicrm_api3_country_delete($params) {
  70   return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
  71 }
  72
  73 /**
  74  * Retrieve one or more countryies.
  75  *
  76  * @param array $params
  77  *   Array per getfields metadata.
  78  *
  79  * @return array
  80  *   api result array
  81  */
  82 function civicrm_api3_country_get($params) {
  83
  84   return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params);
  85 }