Merge pull request #4087 from robinmitra/master
[civicrm-core.git] / api / v3 / examples / Pledge / GetFilterHighDate.php
index df3d7f8b4a1b49ee812815aa4e1e41fdd71e497d..2539d81ab6f8b9d5b6b84d3e5dcc4db78267d430 100644 (file)
@@ -1,20 +1,28 @@
 <?php
-
-/*
- demonstrates high date filter
+/**
+ * Test Generated example of using pledge get API
+ * demonstrates high date filter *
  */
 function pledge_get_example(){
 $params = array(
-  'version' => 3,
-  'pledge_start_date_high' => '20130620090530',
+  'pledge_start_date_high' => '20140926232809',
 );
 
-  $result = civicrm_api( 'pledge','get',$params );
+try{
+  $result = civicrm_api3('pledge', 'get', $params);
+}
+catch (CiviCRM_API3_Exception $e) {
+  // handle error here
+  $errorMessage = $e->getMessage();
+  $errorCode = $e->getErrorCode();
+  $errorData = $e->getExtraParams();
+  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
+}
 
-  return $result;
+return $result;
 }
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
 function pledge_get_expectedresult(){
@@ -33,10 +41,10 @@ function pledge_get_expectedresult(){
           'display_name' => 'Mr. Anthony Anderson II',
           'pledge_id' => '2',
           'pledge_amount' => '100.00',
-          'pledge_create_date' => '2013-06-22 00:00:00',
+          'pledge_create_date' => '2014-09-28 00:00:00',
           'pledge_status' => 'Overdue',
           'pledge_total_paid' => '',
-          'pledge_next_pay_date' => '2012-03-02 00:00:00',
+          'pledge_next_pay_date' => '2013-03-01 00:00:00',
           'pledge_next_pay_amount' => '20.00',
           'pledge_outstanding_amount' => '20.00',
           'pledge_financial_type' => 'Donation',
@@ -51,7 +59,7 @@ function pledge_get_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -59,20 +67,20 @@ function pledge_get_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testPledgeGetReturnFilters and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/PledgeTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/PledgeTest.php
 *
 * You can see the outcome of the API tests at
-* http://tests.dev.civicrm.org/trunk/results-api_v3
+* https://test.civicrm.org/job/CiviCRM-master-git/
 *
 * To Learn about the API read
-* http://book.civicrm.org/developer/current/techniques/api/
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
-* and review the wiki at
-* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+* Browse the api on your own site with the api explorer
+* http://MYSITE.ORG/path/to/civicrm/api/explorer
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing
 *
 * API Standards documentation:
 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
-*/
\ No newline at end of file
+*/