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  *   Associative array of property.
  45  *                       name/value pairs to insert in new 'contribution_soft'
  46  *
  47  * @example ContributionSoftCreate.php Standard Create Example //FIXME
  48  *
  49  * @return array
  50  *   API result array
  51  * {@getfields contribution_soft_create}
  52  * @access public
  53  */
  54 function civicrm_api3_contribution_soft_create($params) {
  55   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
  56 }
  57
  58 /**
  59  * Adjust Metadata for Create action
  60  *
  61  * The metadata is used for setting defaults, documentation & validation
  62  * @param array $params
  63  *   Array or parameters determined by getfields.
  64  */
  65 function _civicrm_api3_contribution_soft_create_spec(&$params) {
  66   $params['contribution_id']['api.required'] = 1;
  67   $params['contact_id']['api.required'] = 1;
  68   $params['amount']['api.required'] = 1;
  69 }
  70
  71 /**
  72  * Deletes an existing Soft Credit
  73  *
  74  * @param array $params
  75  *
  76  * @example ContributionSoftDelete.php Standard Delete Example
  77  *
  78  * @return boolean
  79  *   | error  true if successfull, error otherwise
  80  * {@getfields contribution_soft_delete}
  81  * @access public
  82  */
  83 function civicrm_api3_contribution_soft_delete($params) {
  84   // non standard BAO - we have to write custom code to cope
  85   CRM_Contribute_BAO_ContributionSoft::del(array('id' => $params['id']));
  86
  87 }
  88
  89 /**
  90  * Retrieve one or more Soft Credits
  91  *
  92  * @param array input parameters
  93  *
  94  *
  95  * @example ContributionSoftGet.php Standard Get Example
  96  *
  97  * @param array $params
  98  *   An associative array of name/value pairs.
  99  *
 100  * @return array
 101  *   api result
 102  * {@getfields contribution_soft_get}
 103  * @access public
 104  */
 105 function civicrm_api3_contribution_soft_get($params) {
 106   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 107 }