api/v3/Country.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.3                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2013                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28 */
  29
  30 /**
  31  * File for the CiviCRM APIv3 country functions
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_Country
  35  *
  36  * @copyright CiviCRM LLC (c) 2004-2013
  37  * @version $Id: Country.php 2011-02-16 ErikHommel $
  38  */
  39
  40 require_once 'CRM/Core/DAO/Country.php';
  41
  42 /**
  43  * Add an Country for a contact
  44  *
  45  * Allowed @params array keys are:
  46  *
  47  * @example CountryCreate.php Standard Create Example
  48  *
  49  * @return array API result array
  50  * {@getfields country_create}
  51  * @access public
  52  */
  53 function civicrm_api3_country_create($params) {
  54   return _civicrm_api3_basic_create(_civicrm_api3_get_DAO(__FUNCTION__), $params);
  55 }
  56
  57 /**
  58  * Adjust Metadata for Create action
  59  *
  60  * The metadata is used for setting defaults, documentation & validation
  61  * @param array $params array or parameters determined by getfields
  62  */
  63 function _civicrm_api3_country_create_spec(&$params) {
  64   // TODO a 'clever' default should be introduced
  65   $params['is_primary']['api.default'] = 0;
  66   $params['country']['api.required'] = 1;
  67   $params['contact_id']['api.required'] = 1;
  68 }
  69
  70 /**
  71  * Deletes an existing Country
  72  *
  73  * @param  array  $params
  74  *
  75  * @example CountryDelete.php Standard Delete Example
  76  *
  77  * @return boolean | error  true if successfull, error otherwise
  78  * {@getfields country_delete}
  79  * @access public
  80  */
  81 function civicrm_api3_country_delete($params) {
  82   return _civicrm_api3_basic_delete(_civicrm_api3_get_DAO(__FUNCTION__), $params);
  83 }
  84
  85 /**
  86  * Retrieve one or more countrys
  87  *
  88  * @param  array input parameters
  89  *
  90  *
  91  * @example CountryGet.php Standard Get Example
  92  *
  93  * @param  array $params  an associative array of name/value pairs.
  94  *
  95  * @return  array api result array
  96  * {@getfields country_get}
  97  * @access public
  98  */
  99 function civicrm_api3_country_get($params) {
 100
 101   return _civicrm_api3_basic_get(_civicrm_api3_get_DAO(__FUNCTION__), $params);
 102 }
 103