api/v3/examples/PledgePayment/Create.php

   1 <?php
   2 /**
   3  * Test Generated example of using pledge_payment create API.
   4  *
   5  *
   6  * @return array
   7  *   API result array
   8  */
   9 function pledge_payment_create_example() {
  10   $params = array(
  11     'contact_id' => 1,
  12     'pledge_id' => 1,
  13     'contribution_id' => 1,
  14     'status_id' => 1,
  15     'actual_amount' => 20,
  16   );
  17
  18   try{
  19     $result = civicrm_api3('pledge_payment', 'create', $params);
  20   }
  21   catch (CiviCRM_API3_Exception $e) {
  22     // Handle error here.
  23     $errorMessage = $e->getMessage();
  24     $errorCode = $e->getErrorCode();
  25     $errorData = $e->getExtraParams();
  26     return array(
  27       'error' => $errorMessage,
  28       'error_code' => $errorCode,
  29       'error_data' => $errorData,
  30     );
  31   }
  32
  33   return $result;
  34 }
  35
  36 /**
  37  * Function returns array of result expected from previous function.
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function pledge_payment_create_expectedresult() {
  43
  44   $expectedResult = array(
  45     'is_error' => 0,
  46     'version' => 3,
  47     'count' => 1,
  48     'id' => 1,
  49     'values' => array(
  50       '1' => array(
  51         'id' => '1',
  52         'pledge_id' => '1',
  53         'contribution_id' => '1',
  54         'scheduled_amount' => '',
  55         'actual_amount' => '20',
  56         'currency' => 'USD',
  57         'scheduled_date' => '',
  58         'reminder_date' => '',
  59         'reminder_count' => '',
  60         'status_id' => '1',
  61       ),
  62     ),
  63   );
  64
  65   return $expectedResult;
  66 }
  67
  68 /**
  69 * This example has been generated from the API test suite.
  70 * The test that created it is called
  71 * testCreatePledgePayment
  72 * and can be found in
  73 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgePaymentTest.php
  74 *
  75 * You can see the outcome of the API tests at
  76 * https://test.civicrm.org/job/CiviCRM-master-git/
  77 *
  78 * To Learn about the API read
  79 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  80 *
  81 * Browse the api on your own site with the api explorer
  82 * http://MYSITE.ORG/path/to/civicrm/api
  83 *
  84 * Read more about testing here
  85 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  86 *
  87 * API Standards documentation:
  88 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  89 */