api/v3/LocationType.php

   1 <?php
   2
   3 /*
   4  +--------------------------------------------------------------------+
   5  | CiviCRM version 4.5                                                |
   6  +--------------------------------------------------------------------+
   7  | Copyright CiviCRM LLC (c) 2004-2014                                |
   8  +--------------------------------------------------------------------+
   9  | This file is a part of CiviCRM.                                    |
  10  |                                                                    |
  11  | CiviCRM is free software; you can copy, modify, and distribute it  |
  12  | under the terms of the GNU Affero General Public License           |
  13  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  14  |                                                                    |
  15  | CiviCRM is distributed in the hope that it will be useful, but     |
  16  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  17  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  18  | See the GNU Affero General Public License for more details.        |
  19  |                                                                    |
  20  | You should have received a copy of the GNU Affero General Public   |
  21  | License and the CiviCRM Licensing Exception along                  |
  22  | with this program; if not, contact CiviCRM LLC                     |
  23  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  24  | GNU Affero General Public License or the licensing of CiviCRM,     |
  25  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  26  +--------------------------------------------------------------------+
  27 */
  28
  29 /**
  30  * File for the CiviCRM APIv3 location type functions
  31  *
  32  * @package CiviCRM_APIv3
  33  * @subpackage API_LocationType
  34  *
  35  * @copyright CiviCRM LLC (c) 2004-2014
  36  * @version $Id: LocationType.php 2012-11-02 Jon Goldberg $
  37  */
  38
  39 /**
  40  * Add a Location Type
  41  *
  42  * Allowed @params array keys are:
  43  *
  44  * @example LocationTypeCreate.php Standard Create Example
  45  *
  46  * @param $params
  47  *
  48  * @return array API result array
  49  * {@getfields email_create}
  50  * @access public
  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 function _civicrm_api3_location_type_create_spec(&$params) {
  68   $params['is_active']['api.default'] = 1;
  69   $params['name']['api.required'] = 1;
  70 }
  71
  72 /**
  73  * Deletes an existing Location Type
  74  *
  75  * @param  array  $params
  76  *
  77  * @example LocationTypeDelete.php Standard Delete Example
  78  *
  79  * @return boolean | error  true if successfull, error otherwise
  80  * {@getfields LocationType_delete}
  81  * @access public
  82  */
  83 function civicrm_api3_location_type_delete($params) {
  84   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  85 }
  86
  87 /**
  88  * Retrieve one or more Location Types
  89  *
  90  * @param  array input parameters
  91  *
  92  *
  93  * @example LocationTypeGet.php Standard Get Example
  94  *
  95  * @param  array $params  an associative array of name/value pairs.
  96  *
  97  * @return  array api result
  98  * {@getfields LocationType_get}
  99  * @access public
 100  */
 101 function civicrm_api3_location_type_get($params) {
 102   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 103 }
 104