projects / weblabels.fsf.org.git / blame
| Commit | Line | Data |
|---|---|---|
| 7f254ad8 AE |
1 | <?php |
| 2 | /** | |
| 3 | * Test Generated example demonstrating the Grant.get API. | |
| 4 | * | |
| 5 | * @return array | |
| 6 | * API result array | |
| 7 | */ | |
| 8 | function grant_get_example() { | |
| 9 | $params = array( | |
| 10 | 'rationale' => 'Just Because', | |
| 11 | ); | |
| 12 | ||
| 13 | try{ | |
| 14 | $result = civicrm_api3('Grant', '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 | 'error' => $errorMessage, | |
| 23 | 'error_code' => $errorCode, | |
| 24 | 'error_data' => $errorData, | |
| 25 | ); | |
| 26 | } | |
| 27 | ||
| 28 | return $result; | |
| 29 | } | |
| 30 | ||
| 31 | /** | |
| 32 | * Function returns array of result expected from previous function. | |
| 33 | * | |
| 34 | * @return array | |
| 35 | * API result array | |
| 36 | */ | |
| 37 | function grant_get_expectedresult() { | |
| 38 | ||
| 39 | $expectedResult = array( | |
| 40 | 'is_error' => 0, | |
| 41 | 'version' => 3, | |
| 42 | 'count' => 1, | |
| 43 | 'id' => 1, | |
| 44 | 'values' => array( | |
| 45 | '1' => array( | |
| 46 | 'id' => '1', | |
| 47 | 'contact_id' => '5', | |
| 48 | 'application_received_date' => '20130728084957', | |
| 49 | 'decision_date' => '20130805000000', | |
| 50 | 'grant_type_id' => '1', | |
| 51 | 'amount_total' => '500.00', | |
| 52 | 'currency' => 'USD', | |
| 53 | 'rationale' => 'Just Because', | |
| 54 | 'status_id' => '1', | |
| 55 | ), | |
| 56 | ), | |
| 57 | ); | |
| 58 | ||
| 59 | return $expectedResult; | |
| 60 | } | |
| 61 | ||
| 62 | /* | |
| 63 | * This example has been generated from the API test suite. | |
| 64 | * The test that created it is called "testGetGrant" | |
| 65 | * and can be found at: | |
| 66 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GrantTest.php | |
| 67 | * | |
| 68 | * You can see the outcome of the API tests at | |
| 69 | * https://test.civicrm.org/job/CiviCRM-master-git/ | |
| 70 | * | |
| 71 | * To Learn about the API read | |
| 72 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API | |
| 73 | * | |
| 74 | * Browse the api on your own site with the api explorer | |
| 75 | * http://MYSITE.ORG/path/to/civicrm/api | |
| 76 | * | |
| 77 | * Read more about testing here | |
| 78 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
| 79 | * | |
| 80 | * API Standards documentation: | |
| 81 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
| 82 | */ |