api/v3/examples/MembershipPayment/Create.php

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