CRM-15988 - Update generated examples

[civicrm-core.git] / api / v3 / examples / Pledge / GetFilterHighDate.php

diff --git a/api/v3/examples/Pledge/GetFilterHighDate.php b/api/v3/examples/Pledge/GetFilterHighDate.php
index 8534a0a14911191dea98476666eb686ea744f751..6e52589e8e42deded9492fd88a52f2201a8d7453 100644 (file)
--- a/api/v3/examples/Pledge/GetFilterHighDate.php
+++ b/api/v3/examples/Pledge/GetFilterHighDate.php
@@ -1,86 +1,96 @@
 <?php
 /**
- * Test Generated example of using pledge get API
- * demonstrates high date filter *
+ * Test Generated example demonstrating the Pledge.get API.
+ *
+ * demonstrates high date filter
+ *
+ * @return array
+ *   API result array
  */
-function pledge_get_example(){
-$params = array(
-  'pledge_start_date_high' => '20130801213843',
-);
+function pledge_get_example() {
+  $params = array(
+    'pledge_start_date_high' => '20150220231942',
+  );
 
-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);
-}
+  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 returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
  */
-function pledge_get_expectedresult(){
+function pledge_get_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 1,
-  'id' => 2,
-  'values' => array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 2,
+    'values' => array(
       '2' => array(
-          'contact_id' => '8',
-          'contact_type' => 'Individual',
-          'contact_sub_type' => '',
-          'sort_name' => 'Anderson, Anthony',
-          'display_name' => 'Mr. Anthony Anderson II',
-          'pledge_id' => '2',
-          'pledge_amount' => '100.00',
-          'pledge_create_date' => '2013-08-03 00:00:00',
-          'pledge_status' => 'Overdue',
-          'pledge_total_paid' => '',
-          'pledge_next_pay_date' => '2012-03-02 00:00:00',
-          'pledge_next_pay_amount' => '20.00',
-          'pledge_outstanding_amount' => '20.00',
-          'pledge_financial_type' => 'Donation',
-          'pledge_contribution_page_id' => '',
-          'pledge_frequency_interval' => '5',
-          'pledge_frequency_unit' => 'year',
-          'pledge_is_test' => 0,
-          'pledge_campaign_id' => '',
-          'pledge_currency' => 'USD',
-          'id' => '2',
-        ),
+        'contact_id' => '8',
+        'contact_type' => 'Individual',
+        'contact_sub_type' => '',
+        'sort_name' => 'Anderson, Anthony',
+        'display_name' => 'Mr. Anthony Anderson II',
+        'pledge_id' => '2',
+        'pledge_amount' => '100.00',
+        'pledge_create_date' => '2015-02-22 00:00:00',
+        'pledge_status' => 'Overdue',
+        'pledge_total_paid' => '',
+        'pledge_next_pay_date' => '2014-03-07 00:00:00',
+        'pledge_next_pay_amount' => '20.00',
+        'pledge_outstanding_amount' => '20.00',
+        'pledge_financial_type' => 'Donation',
+        'pledge_contribution_page_id' => '',
+        'pledge_frequency_interval' => '5',
+        'pledge_frequency_unit' => 'year',
+        'pledge_is_test' => 0,
+        'pledge_campaign_id' => '',
+        'pledge_currency' => 'USD',
+        'id' => '2',
+      ),
     ),
-);
+  );
 
   return $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
+* This example has been generated from the API test suite.
+* The test that created it is called "testPledgeGetReturnFilters"
+* and can be found at:
+* 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
 *
 * 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
+*/