projects / civicrm-core.git / blame
| Commit | Line | Data |
|---|---|---|
| 55e55e84 | 1 | <?php |
| 2 | /* | |
| 3 | +--------------------------------------------------------------------+ | |
| 81621fee | 4 | | CiviCRM version 4.7 | |
| 55e55e84 | 5 | +--------------------------------------------------------------------+ |
| 1f4ea726 | 6 | | Copyright CiviCRM LLC (c) 2004-2017 | |
| 55e55e84 | 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 FinancialItem. | |
| 30 | * | |
| 31 | * @package CiviCRM_APIv3 | |
| 32 | */ | |
| 33 | ||
| 34 | /** | |
| 35 | * Save a Financial Item. | |
| 36 | * | |
| 37 | * @param array $params | |
| 38 | * | |
| 39 | * @return array | |
| 40 | */ | |
| 41 | function civicrm_api3_financial_trxn_create($params) { | |
| 50f8ceb1 | 42 | if (empty($params['id']) && empty($params['contribution_id']) && empty($params['entity_id'])) { |
| 43 | throw new API_Exception("Mandatory key(s) missing from params array: both contribution_id and entity_id are missing"); | |
| e3a78cba | 44 | } |
| 50f8ceb1 | 45 | |
| ddaf2161 | 46 | return _civicrm_api3_basic_create('CRM_Core_BAO_FinancialTrxn', $params, 'FinancialTrxn'); |
| 55e55e84 | 47 | } |
| 48 | ||
| 49 | /** | |
| 50 | * Get a Financialtrxn. | |
| 51 | * | |
| 52 | * @param array $params | |
| 53 | * | |
| 54 | * @return array | |
| 55 | * Array of retrieved Financial trxn property values. | |
| 56 | */ | |
| 57 | function civicrm_api3_financial_trxn_get($params) { | |
| 58 | return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 59 | } | |
| 60 | ||
| 61 | /** | |
| 62 | * Delete a Financial trxn. | |
| 63 | * | |
| 64 | * @param array $params | |
| 65 | * | |
| 66 | * @return array | |
| 67 | * Array of deleted values. | |
| 68 | */ | |
| 69 | function civicrm_api3_financial_trxn_delete($params) { | |
| 70 | return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); | |
| 71 | } | |
| b494e85f PN |
72 | |
| 73 | /** | |
| 74 | * Adjust Metadata for Create action. | |
| 75 | * | |
| 76 | * The metadata is used for setting defaults, documentation & validation. | |
| 77 | * | |
| 78 | * @param array $params | |
| 79 | * Array of parameters determined by getfields. | |
| 80 | */ | |
| 81 | function _civicrm_api3_financial_trxn_create_spec(&$params) { | |
| 82 | $params['to_financial_account_id']['api.required'] = 1; | |
| 83 | $params['status_id']['api.required'] = 1; | |
| 84 | $params['payment_instrument_id']['api.required'] = 1; | |
| 85 | $params['total_amount']['api.required'] = 1; | |
| 429a0484 | 86 | } |