projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge pull request #5252 from JKingsnorth/CRM-10551
[civicrm-core.git]
/
api
/
v3
/
ContributionSoft.php
diff --git
a/api/v3/ContributionSoft.php
b/api/v3/ContributionSoft.php
index ca9d1829f5a8bbbe14fbb847b2e7bb6d2aca7648..fb795384a032b1958d85f5444e258475cc551adb 100644
(file)
--- a/
api/v3/ContributionSoft.php
+++ b/
api/v3/ContributionSoft.php
@@
-1,11
+1,9
@@
<?php
<?php
-// $Id$
-
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.6 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-201
4
|
+ | Copyright CiviCRM LLC (c) 2004-201
5
|
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
@@
-28,36
+26,31
@@
*/
/**
*/
/**
- *
File for the CiviCRM APIv3 soft credit functions
+ *
This api exposes CiviCRM soft credits.
*
* @package CiviCRM_APIv3
*
* @package CiviCRM_APIv3
- * @subpackage API_ContributionSoft
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: ContributionSoft.php 2013-05-01 Jon Goldberg $
*/
/**
*/
/**
- * Create or Update a Soft Credit
+ * Create or Update a Soft Credit
.
*
* @param array $params
*
* @param array $params
- * Associative array of property.
- * name/value pairs to insert in new 'contribution_soft'
+ * Array per getfields metadata.
*
*
- * @example ContributionSoftCreate.php Standard Create Example //FIXME
- *
- * @return array API result array {@getfields contribution_soft_create}
+ * @return array
+ * API result array
*/
function civicrm_api3_contribution_soft_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
*/
function civicrm_api3_contribution_soft_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
*
*
- * The metadata is used for setting defaults, documentation & validation
* @param array $params
* @param array $params
- * Array o
r
parameters determined by getfields.
+ * Array o
f
parameters determined by getfields.
*/
function _civicrm_api3_contribution_soft_create_spec(&$params) {
$params['contribution_id']['api.required'] = 1;
*/
function _civicrm_api3_contribution_soft_create_spec(&$params) {
$params['contribution_id']['api.required'] = 1;
@@
-66,27
+59,24
@@
function _civicrm_api3_contribution_soft_create_spec(&$params) {
}
/**
}
/**
- * Deletes an existing Soft Credit
+ * Deletes an existing Soft Credit
.
*
* @param array $params
*
* @param array $params
- *
- * @example ContributionSoftDelete.php Standard Delete Example
- * {@getfields contribution_soft_delete}
*/
function civicrm_api3_contribution_soft_delete($params) {
*/
function civicrm_api3_contribution_soft_delete($params) {
- //
non standard BAO - we have to write custom code to cope
+ //
Non standard BAO - we have to write custom code to cope.
CRM_Contribute_BAO_ContributionSoft::del(array('id' => $params['id']));
}
/**
CRM_Contribute_BAO_ContributionSoft::del(array('id' => $params['id']));
}
/**
- * Retrieve one or more Soft Credits
- *
- * @example ContributionSoftGet.php Standard Get Example
+ * Retrieve one or more Soft Credits.
*
*
- * @param array $params An associative array of name/value pairs.
+ * @param array $params
+ * Array per getfields metadata.
*
*
- * @return array api result {@getfields contribution_soft_get}
+ * @return array
+ * API result
*/
function civicrm_api3_contribution_soft_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*/
function civicrm_api3_contribution_soft_get($params) {
return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);