api/v3/examples/ContributionRecur/Get.php

   1 <?php
   2 /**
   3  * Test Generated example of using contribution_recur get API.
   4  *
   5  *
   6  * @return array
   7  *   API result array
   8  */
   9 function contribution_recur_get_example() {
  10   $params = array(
  11     'amount' => '500',
  12   );
  13
  14   try{
  15     $result = civicrm_api3('contribution_recur', 'get', $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       'error' => $errorMessage,
  24       'error_code' => $errorCode,
  25       'error_data' => $errorData,
  26     );
  27   }
  28
  29   return $result;
  30 }
  31
  32 /**
  33  * Function returns array of result expected from previous function.
  34  *
  35  * @return array
  36  *   API result array
  37  */
  38 function contribution_recur_get_expectedresult() {
  39
  40   $expectedResult = array(
  41     'is_error' => 0,
  42     'version' => 3,
  43     'count' => 1,
  44     'id' => 2,
  45     'values' => array(
  46       '2' => array(
  47         'id' => '2',
  48         'contact_id' => '4',
  49         'amount' => '500.00',
  50         'currency' => 'USD',
  51         'frequency_unit' => 'day',
  52         'frequency_interval' => '1',
  53         'installments' => '12',
  54         'start_date' => '2013-07-29 00:00:00',
  55         'create_date' => '20120130621222105',
  56         'contribution_status_id' => '1',
  57         'is_test' => 0,
  58         'cycle_day' => '1',
  59         'failure_count' => 0,
  60         'auto_renew' => 0,
  61         'is_email_receipt' => '1',
  62       ),
  63     ),
  64   );
  65
  66   return $expectedResult;
  67 }
  68
  69 /**
  70 * This example has been generated from the API test suite.
  71 * The test that created it is called
  72 * testGetContributionRecur
  73 * and can be found in
  74 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContributionRecurTest.php
  75 *
  76 * You can see the outcome of the API tests at
  77 * https://test.civicrm.org/job/CiviCRM-master-git/
  78 *
  79 * To Learn about the API read
  80 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  81 *
  82 * Browse the api on your own site with the api explorer
  83 * http://MYSITE.ORG/path/to/civicrm/api
  84 *
  85 * Read more about testing here
  86 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  87 *
  88 * API Standards documentation:
  89 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  90 */