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