Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Campaign.get API. |
50fb255d | 4 | * |
50fb255d | 5 | * @return array |
6 | * API result array | |
7 | */ | |
8 | function campaign_get_example() { | |
9 | $params = array( | |
10 | 'title' => 'campaign title', | |
11 | 'description' => 'Call people, ask for money', | |
12 | 'created_date' => 'first sat of July 2008', | |
13 | ); | |
6a488035 | 14 | |
50fb255d | 15 | try{ |
a828d7b8 | 16 | $result = civicrm_api3('Campaign', 'get', $params); |
50fb255d | 17 | } |
18 | catch (CiviCRM_API3_Exception $e) { | |
19 | // Handle error here. | |
20 | $errorMessage = $e->getMessage(); | |
21 | $errorCode = $e->getErrorCode(); | |
22 | $errorData = $e->getExtraParams(); | |
23 | return array( | |
5be22f39 | 24 | 'is_error' => 1, |
25 | 'error_message' => $errorMessage, | |
50fb255d | 26 | 'error_code' => $errorCode, |
27 | 'error_data' => $errorData, | |
28 | ); | |
29 | } | |
30 | ||
31 | return $result; | |
6a488035 TO |
32 | } |
33 | ||
fb32de45 | 34 | /** |
50fb255d | 35 | * Function returns array of result expected from previous function. |
36 | * | |
37 | * @return array | |
38 | * API result array | |
6a488035 | 39 | */ |
50fb255d | 40 | function campaign_get_expectedresult() { |
6a488035 | 41 | |
edb0d67a | 42 | $expectedResult = array( |
50fb255d | 43 | 'is_error' => 0, |
44 | 'version' => 3, | |
45 | 'count' => 1, | |
46 | 'id' => 2, | |
47 | 'values' => array( | |
edb0d67a | 48 | '2' => array( |
50fb255d | 49 | 'id' => '2', |
50 | 'name' => 'campaign_title', | |
51 | 'title' => 'campaign title', | |
52 | 'description' => 'Call people, ask for money', | |
53 | 'is_active' => '1', | |
54 | 'created_date' => '2013-07-28 08:49:19', | |
55 | ), | |
6a488035 | 56 | ), |
50fb255d | 57 | ); |
6a488035 | 58 | |
fb32de45 | 59 | return $expectedResult; |
6a488035 TO |
60 | } |
61 | ||
a828d7b8 | 62 | /* |
50fb255d | 63 | * This example has been generated from the API test suite. |
a828d7b8 CW |
64 | * The test that created it is called "testGetCampaign" |
65 | * and can be found at: | |
69d79249 | 66 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CampaignTest.php |
6a488035 TO |
67 | * |
68 | * You can see the outcome of the API tests at | |
69d79249 | 69 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
70 | * |
71 | * To Learn about the API read | |
69d79249 | 72 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 73 | * |
69d79249 | 74 | * Browse the api on your own site with the api explorer |
41d4d31f | 75 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
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 | |
b259a4ab | 82 | */ |