api/v3/ContributionSoft.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This api exposes CiviCRM soft credits.
  14  *
  15  * @package CiviCRM_APIv3
  16  */
  17
  18 /**
  19  * Create or Update a Soft Credit.
  20  *
  21  * @param array $params
  22  *   Array per getfields metadata.
  23  *
  24  * @return array
  25  *   API result array
  26  */
  27 function civicrm_api3_contribution_soft_create($params) {
  28   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'ContributionSoft');
  29 }
  30
  31 /**
  32  * Adjust Metadata for Create action.
  33  *
  34  * The metadata is used for setting defaults, documentation & validation.
  35  *
  36  * @param array $params
  37  *   Array of parameters determined by getfields.
  38  */
  39 function _civicrm_api3_contribution_soft_create_spec(&$params) {
  40   $params['contribution_id']['api.required'] = 1;
  41   $params['contact_id']['api.required'] = 1;
  42   $params['amount']['api.required'] = 1;
  43 }
  44
  45 /**
  46  * Deletes an existing Soft Credit.
  47  *
  48  * @param array $params
  49  *
  50  * @return array
  51  *   Api formatted result.
  52  *
  53  * @throws API_Exception
  54  */
  55 function civicrm_api3_contribution_soft_delete($params) {
  56   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  57 }
  58
  59 /**
  60  * Retrieve one or more Soft Credits.
  61  *
  62  * @param array $params
  63  *   Array per getfields metadata.
  64  *
  65  * @return array
  66  *   API result
  67  */
  68 function civicrm_api3_contribution_soft_get($params) {
  69   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  70 }