*/
/**
- * File for the CiviCRM APIv3 Pledge functions
+ * This api exposes CiviCRM Pledge.
*
* @package CiviCRM_APIv3
- * @subpackage API_Pledge
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Pledge.php
*/
/**
* Create or updates an Pledge.
*
+ * @param $params
+ *
* @return array
* Array containing 'is_error' to denote success or failure and details of the created pledge
+ * @throws \API_Exception
*/
function civicrm_api3_pledge_create($params) {
_civicrm_api3_pledge_format_params($params, TRUE);
if (CRM_Pledge_BAO_Pledge::deletePledge($params['id'])) {
return civicrm_api3_create_success(array(
'id' => $params['id'],
- ), $params, 'pledge', 'delete');
+ ), $params, 'Pledge', 'delete');
}
else {
return civicrm_api3_create_error('Could not delete pledge');
*
* @return array
* array of pledges, if error an array with an error id and error message
- * {@getfields pledge_get}
- * @example PledgeGet.php
*/
function civicrm_api3_pledge_get($params) {
$mode = CRM_Contact_BAO_Query::MODE_PLEDGE;
- $entity = 'pledge';
- list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, $entity);
+ list($dao, $query) = _civicrm_api3_get_query_object($params, $mode, 'Pledge');
$pledge = array();
while ($dao->fetch()) {
$pledge[$dao->pledge_id] = $query->store($dao);
}
- return civicrm_api3_create_success($pledge, $params, 'pledge', 'get', $dao);
+ return civicrm_api3_create_success($pledge, $params, 'Pledge', 'get', $dao);
}
/**
*
* @param array $values
* The reformatted properties that we can use internally.
- *
*/
function _civicrm_api3_pledge_format_params(&$values) {