api/v3/examples/Pledge/GetFilterHighDate.php

   1 <?php
   2 /**
   3  * Test Generated example of using pledge get API
   4  * demonstrates high date filter *
   5  */
   6 function pledge_get_example(){
   7 $params = array(
   8   'pledge_start_date_high' => '20130801213843',
   9 );
  10
  11 try{
  12   $result = civicrm_api3('pledge', '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 pledge_get_expectedresult(){
  29
  30   $expectedResult = array(
  31   'is_error' => 0,
  32   'version' => 3,
  33   'count' => 1,
  34   'id' => 2,
  35   'values' => array(
  36       '2' => array(
  37           'contact_id' => '8',
  38           'contact_type' => 'Individual',
  39           'contact_sub_type' => '',
  40           'sort_name' => 'Anderson, Anthony',
  41           'display_name' => 'Mr. Anthony Anderson II',
  42           'pledge_id' => '2',
  43           'pledge_amount' => '100.00',
  44           'pledge_create_date' => '2013-08-03 00:00:00',
  45           'pledge_status' => 'Overdue',
  46           'pledge_total_paid' => '',
  47           'pledge_next_pay_date' => '2012-03-02 00:00:00',
  48           'pledge_next_pay_amount' => '20.00',
  49           'pledge_outstanding_amount' => '20.00',
  50           'pledge_financial_type' => 'Donation',
  51           'pledge_contribution_page_id' => '',
  52           'pledge_frequency_interval' => '5',
  53           'pledge_frequency_unit' => 'year',
  54           'pledge_is_test' => 0,
  55           'pledge_campaign_id' => '',
  56           'pledge_currency' => 'USD',
  57           'id' => '2',
  58         ),
  59     ),
  60 );
  61
  62   return $expectedResult;
  63 }
  64
  65
  66 /*
  67 * This example has been generated from the API test suite. The test that created it is called
  68 *
  69 * testPledgeGetReturnFilters and can be found in
  70 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/PledgeTest.php
  71 *
  72 * You can see the outcome of the API tests at
  73 * http://tests.dev.civicrm.org/trunk/results-api_v3
  74 *
  75 * To Learn about the API read
  76 * http://book.civicrm.org/developer/current/techniques/api/
  77 *
  78 * and review the wiki at
  79 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  80 *
  81 * Read more about testing here
  82 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  83 *
  84 * API Standards documentation:
  85 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  86 */