api/v3/ContributionSoft.php

   1 <?php
   2 // $Id$
   3
   4 /*
   5  +--------------------------------------------------------------------+
   6  | CiviCRM version 4.6                                                |
   7  +--------------------------------------------------------------------+
   8  | Copyright CiviCRM LLC (c) 2004-2014                                |
   9  +--------------------------------------------------------------------+
  10  | This file is a part of CiviCRM.                                    |
  11  |                                                                    |
  12  | CiviCRM is free software; you can copy, modify, and distribute it  |
  13  | under the terms of the GNU Affero General Public License           |
  14  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  15  |                                                                    |
  16  | CiviCRM is distributed in the hope that it will be useful, but     |
  17  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  18  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  19  | See the GNU Affero General Public License for more details.        |
  20  |                                                                    |
  21  | You should have received a copy of the GNU Affero General Public   |
  22  | License and the CiviCRM Licensing Exception along                  |
  23  | with this program; if not, contact CiviCRM LLC                     |
  24  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  25  | GNU Affero General Public License or the licensing of CiviCRM,     |
  26  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  27  +--------------------------------------------------------------------+
  28  */
  29
  30 /**
  31  * File for the CiviCRM APIv3 soft credit functions.
  32  *
  33  * @package CiviCRM_APIv3
  34  * @subpackage API_ContributionSoft
  35  *
  36  * @copyright CiviCRM LLC (c) 2004-2014
  37  * @version $Id: ContributionSoft.php 2013-05-01 Jon Goldberg $
  38  */
  39
  40 /**
  41  * Create or Update a Soft Credit.
  42  *
  43  * @param array $params
  44  *   Array per getfields metadata.
  45  *
  46  * @return array
  47  *   API result array
  48  */
  49 function civicrm_api3_contribution_soft_create($params) {
  50   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  51 }
  52
  53 /**
  54  * Adjust Metadata for Create action.
  55  *
  56  * The metadata is used for setting defaults, documentation & validation.
  57  *
  58  * @param array $params
  59  *   Array or parameters determined by getfields.
  60  */
  61 function _civicrm_api3_contribution_soft_create_spec(&$params) {
  62   $params['contribution_id']['api.required'] = 1;
  63   $params['contact_id']['api.required'] = 1;
  64   $params['amount']['api.required'] = 1;
  65 }
  66
  67 /**
  68  * Deletes an existing Soft Credit.
  69  *
  70  * @param array $params
  71  */
  72 function civicrm_api3_contribution_soft_delete($params) {
  73   // Non standard BAO - we have to write custom code to cope.
  74   CRM_Contribute_BAO_ContributionSoft::del(array('id' => $params['id']));
  75
  76 }
  77
  78 /**
  79  * Retrieve one or more Soft Credits.
  80  *
  81  * @param array $params
  82  *   Array per getfields metadata.
  83  *
  84  * @return array
  85  *  API result
  86  */
  87 function civicrm_api3_contribution_soft_get($params) {
  88   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  89 }