api/v3/LocationType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   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 LocationType records.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Add a LocationType.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  *   API result array.
  41  */
  42 function civicrm_api3_location_type_create($params) {
  43   //set display_name equal to name if it's not defined
  44   if (!array_key_exists('display_name', $params) && array_key_exists('name', $params)) {
  45     $params['display_name'] = $params['name'];
  46   }
  47
  48   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'LocationType');
  49 }
  50
  51 /**
  52  * Adjust Metadata for Create action.
  53  *
  54  * The metadata is used for setting defaults, documentation & validation.
  55  *
  56  * @param array $params
  57  *   Array of parameters determined by getfields.
  58  */
  59 function _civicrm_api3_location_type_create_spec(&$params) {
  60   $params['is_active']['api.default'] = 1;
  61   $params['name']['api.required'] = 1;
  62 }
  63
  64 /**
  65  * Deletes an existing LocationType.
  66  *
  67  * @param array $params
  68  *
  69  * @return array
  70  *   API result array.
  71  */
  72 function civicrm_api3_location_type_delete($params) {
  73   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  74 }
  75
  76 /**
  77  * Retrieve one or more LocationTypes.
  78  *
  79  * @param array $params
  80  *   An associative array of name/value pairs.
  81  *
  82  * @return array
  83  *   API result array.
  84  */
  85 function civicrm_api3_location_type_get($params) {
  86   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  87 }