Merge remote-tracking branch 'upstream/4.5' into 4.5-master-2014-11-24-15-59-25

[civicrm-core.git] / api / v3 / examples / Contribution / ContributionCreateWithNote.php

diff --git a/api/v3/examples/Contribution/ContributionCreateWithNote.php b/api/v3/examples/Contribution/ContributionCreateWithNote.php
index 95cf55adc77c33a08288f2593ddedcf9eed28fb9..6cd86fea80d9ddb6f563d19d6c13aa390e43e4c2 100644 (file)
--- a/api/v3/examples/Contribution/ContributionCreateWithNote.php
+++ b/api/v3/examples/Contribution/ContributionCreateWithNote.php
@@ -1,7 +1,7 @@
 <?php
-
-/*
- Demonstrates creating contribution with Note Entity
+/**
+ * Test Generated example of using contribution create API
+ * Demonstrates creating contribution with Note Entity *
  */
 function contribution_create_example(){
 $params = array(
@@ -17,16 +17,24 @@ $params = array(
   'invoice_id' => 67890,
   'source' => 'SSF',
   'contribution_status_id' => 1,
-  'version' => 3,
   'note' => 'my contribution note',
 );
 
-  $result = civicrm_api( 'contribution','create',$params );
+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('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
+}
 
-  return $result;
+return $result;
 }
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
 function contribution_create_expectedresult(){
@@ -58,20 +66,20 @@ function contribution_create_expectedresult(){
           'source' => 'SSF',
           'amount_level' => '',
           'contribution_recur_id' => '',
-          'honor_contact_id' => '',
           'is_test' => '',
           'is_pay_later' => '',
           'contribution_status_id' => '1',
-          'honor_type_id' => '',
           'address_id' => '',
-          'check_number' => 'null',
+          'check_number' => '',
           'campaign_id' => '',
+          'creditnote_id' => '',
+          'tax_amount' => '',
           'contribution_type_id' => '1',
         ),
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -79,20 +87,20 @@ function contribution_create_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testCreateContributionWithNote and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContributionTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionTest.php
 *
 * You can see the outcome of the API tests at
-* http://tests.dev.civicrm.org/trunk/results-api_v3
+* https://test.civicrm.org/job/CiviCRM-master-git/
 *
 * To Learn about the API read
-* http://book.civicrm.org/developer/current/techniques/api/
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
-* and review the wiki at
-* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api/explorer
 *
 * 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
-*/
\ No newline at end of file
+*/