drupal-civicrm/sites/all/modules/civicrm/api/v3/examples/Contribution/ContributionCreateWithSoftCredit.php

122 lines
3.1 KiB
PHP
Raw Normal View History

2018-01-14 15:10:16 +02:00
<?php
/**
* Test Generated example demonstrating the Contribution.create API.
*
* Demonstrates creating contribution with SoftCredit.
*
* @return array
* API result array
*/
function contribution_create_example() {
$params = array(
'contact_id' => 24,
'receive_date' => '20120511',
'total_amount' => '100',
'financial_type_id' => 1,
'non_deductible_amount' => '10',
'fee_amount' => '5',
'net_amount' => '95',
'source' => 'SSF',
'contribution_status_id' => 1,
'soft_credit' => array(
'1' => array(
'contact_id' => 25,
'amount' => 50,
'soft_credit_type_id' => 3,
),
),
);
try{
$result = civicrm_api3('Contribution', 'create', $params);
}
catch (CiviCRM_API3_Exception $e) {
// Handle error here.
$errorMessage = $e->getMessage();
$errorCode = $e->getErrorCode();
$errorData = $e->getExtraParams();
return array(
'is_error' => 1,
'error_message' => $errorMessage,
'error_code' => $errorCode,
'error_data' => $errorData,
);
}
return $result;
}
/**
* Function returns array of result expected from previous function.
*
* @return array
* API result array
*/
function contribution_create_expectedresult() {
$expectedResult = array(
'is_error' => 0,
'version' => 3,
'count' => 1,
'id' => 1,
'values' => array(
'1' => array(
'id' => '1',
'contact_id' => '24',
'financial_type_id' => '1',
'contribution_page_id' => '',
'payment_instrument_id' => '4',
'receive_date' => '20120511000000',
'non_deductible_amount' => '10',
'total_amount' => '100',
'fee_amount' => '5',
'net_amount' => '95',
'trxn_id' => '',
'invoice_id' => '',
'currency' => 'USD',
'cancel_date' => '',
'cancel_reason' => '',
'receipt_date' => '',
'thankyou_date' => '',
'source' => 'SSF',
'amount_level' => '',
'contribution_recur_id' => '',
'is_test' => '',
'is_pay_later' => '',
'contribution_status_id' => '1',
'address_id' => '',
'check_number' => '',
'campaign_id' => '',
'creditnote_id' => '',
'tax_amount' => '',
'revenue_recognition_date' => '',
'contribution_type_id' => '1',
),
),
);
return $expectedResult;
}
/*
* This example has been generated from the API test suite.
* The test that created it is called "testCreateContributionWithSoftCredit"
* and can be found at:
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php
*
* You can see the outcome of the API tests at
* https://test.civicrm.org/job/CiviCRM-master-git/
*
* To Learn about the API read
* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
* Browse the api on your own site with the api explorer
* http://MYSITE.ORG/path/to/civicrm/api
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing
*
* API Standards documentation:
* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/