api/v3/examples/ContributionRecur/Get.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the ContributionRecur.get API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function contribution_recur_get_example() {
   9   $params = array(
  10     'amount' => '500',
  11   );
  12
  13   try{
  14     $result = civicrm_api3('ContributionRecur', 'get', $params);
  15   }
  16   catch (CiviCRM_API3_Exception $e) {
  17     // Handle error here.
  18     $errorMessage = $e->getMessage();
  19     $errorCode = $e->getErrorCode();
  20     $errorData = $e->getExtraParams();
  21     return array(
  22       'is_error' => 1,
  23       'error_message' => $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         'modified_date' => '2012-11-14 16:02:35',
  57         'contribution_status_id' => '1',
  58         'is_test' => 0,
  59         'cycle_day' => '1',
  60         'failure_count' => 0,
  61         'auto_renew' => 0,
  62         'is_email_receipt' => '1',
  63       ),
  64     ),
  65   );
  66
  67   return $expectedResult;
  68 }
  69
  70 /*
  71 * This example has been generated from the API test suite.
  72 * The test that created it is called "testGetContributionRecur"
  73 * and can be found at:
  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 */