Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
3 | * Test Generated example of using survey get API. | |
4 | * | |
5 | * demonstrates get + delete in the same call | |
6 | * | |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function survey_get_example() { | |
11 | $params = array( | |
12 | 'title' => 'survey title', | |
13 | 'api.survey.delete' => 1, | |
14 | ); | |
6a488035 | 15 | |
50fb255d | 16 | try{ |
17 | $result = civicrm_api3('survey', 'get', $params); | |
18 | } | |
19 | catch (CiviCRM_API3_Exception $e) { | |
20 | // Handle error here. | |
21 | $errorMessage = $e->getMessage(); | |
22 | $errorCode = $e->getErrorCode(); | |
23 | $errorData = $e->getExtraParams(); | |
24 | return array( | |
25 | 'error' => $errorMessage, | |
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 survey_get_expectedresult() { |
6a488035 | 41 | |
fbda92d3 | 42 | $expectedResult = array( |
50fb255d | 43 | 'is_error' => 0, |
44 | 'version' => 3, | |
45 | 'count' => 1, | |
46 | 'id' => 4, | |
47 | 'values' => array( | |
48 | '4' => array( | |
49 | 'id' => '4', | |
50 | 'title' => 'survey title', | |
51 | 'activity_type_id' => '30', | |
52 | 'instructions' => 'Call people, ask for money', | |
53 | 'max_number_of_contacts' => '12', | |
54 | 'is_active' => '1', | |
55 | 'is_default' => 0, | |
56 | 'created_date' => '2013-07-28 08:49:19', | |
57 | 'bypass_confirm' => 0, | |
58 | 'is_share' => '1', | |
59 | 'api.survey.delete' => array( | |
60 | 'is_error' => 0, | |
61 | 'version' => 3, | |
62 | 'count' => 1, | |
63 | 'values' => TRUE, | |
6a488035 | 64 | ), |
50fb255d | 65 | ), |
6a488035 | 66 | ), |
50fb255d | 67 | ); |
6a488035 | 68 | |
fb32de45 | 69 | return $expectedResult; |
6a488035 TO |
70 | } |
71 | ||
50fb255d | 72 | /** |
73 | * This example has been generated from the API test suite. | |
74 | * The test that created it is called | |
75 | * testGetSurveyChainDelete | |
76 | * and can be found in | |
69d79249 | 77 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SurveyTest.php |
6a488035 TO |
78 | * |
79 | * You can see the outcome of the API tests at | |
69d79249 | 80 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
81 | * |
82 | * To Learn about the API read | |
69d79249 | 83 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 84 | * |
69d79249 | 85 | * Browse the api on your own site with the api explorer |
41d4d31f | 86 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
87 | * |
88 | * Read more about testing here | |
89 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
90 | * | |
91 | * API Standards documentation: | |
92 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 93 | */ |