api/v3/FinancialType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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 FinancialType.
  30  *
  31  * @package CiviCRM_APIv3
  32  */
  33
  34 /**
  35  * Save a FinancialType.
  36  *
  37  * @param array $params
  38  *
  39  * @return array
  40  */
  41 function civicrm_api3_financial_type_create($params) {
  42   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'FinancialType');
  43 }
  44
  45 function _civicrm_api3_financial_type_create_spec(&$params) {
  46   $params['name']['api.required'] = 1;
  47   $params['name']['type'] = CRM_Utils_Type::T_STRING;
  48   unset($params['name']['pseudoconstant']);
  49 }
  50
  51 /**
  52  * Get a FinancialType.
  53  *
  54  * @param array $params
  55  *
  56  * @return array
  57  *   Array of retrieved FinancialType property values.
  58  */
  59 function civicrm_api3_financial_type_get($params) {
  60   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  61 }
  62
  63 /**
  64  * Delete a FinancialType.
  65  *
  66  * @param array $params
  67  *
  68  * @return array
  69  *   Array of deleted values.
  70  */
  71 function civicrm_api3_financial_type_delete($params) {
  72   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  73 }