api/v3/examples/ContributionRecurGet.php

   1 <?php
   2 /**
   3  * Test Generated example of using contribution_recur get API
   4  * *
   5  */
   6 function contribution_recur_get_example(){
   7 $params = array(
   8   'amount' => '500',
   9 );
  10
  11 try{
  12   $result = civicrm_api3('contribution_recur', 'get', $params);
  13 }
  14 catch (CiviCRM_API3_Exception $e) {
  15   // handle error here
  16   $errorMessage = $e->getMessage();
  17   $errorCode = $e->getErrorCode();
  18   $errorData = $e->getExtraParams();
  19   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  20 }
  21
  22 return $result;
  23 }
  24
  25 /**
  26  * Function returns array of result expected from previous function
  27  */
  28 function contribution_recur_get_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 1,
  34   'id' => 1,
  35   'values' => array(
  36       '1' => array(
  37           'id' => '1',
  38           'contact_id' => '4',
  39           'amount' => '500.00',
  40           'currency' => 'USD',
  41           'frequency_unit' => 'day',
  42           'frequency_interval' => '1',
  43           'installments' => '12',
  44           'start_date' => '2013-07-29 00:00:00',
  45           'create_date' => '20120130621222105',
  46           'contribution_status_id' => '1',
  47           'is_test' => 0,
  48           'cycle_day' => '1',
  49           'failure_count' => 0,
  50           'auto_renew' => 0,
  51           'is_email_receipt' => '1',
  52         ),
  53     ),
  54 );
  55
  56   return $expectedResult;
  57 }
  58
  59
  60 /*
  61 * This example has been generated from the API test suite. The test that created it is called
  62 *
  63 * testGetContributionRecur and can be found in
  64 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/ContributionRecurTest.php
  65 *
  66 * You can see the outcome of the API tests at
  67 * http://tests.dev.civicrm.org/trunk/results-api_v3
  68 *
  69 * To Learn about the API read
  70 * http://book.civicrm.org/developer/current/techniques/api/
  71 *
  72 * and review the wiki at
  73 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  74 *
  75 * Read more about testing here
  76 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  77 *
  78 * API Standards documentation:
  79 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  80 */