89bf81b4 |
1 | <?php |
2 | /** |
50fb255d |
3 | * @file |
4 | * Test Generated API Example. |
5 | * See bottom of this file for more detail. |
89bf81b4 |
6 | */ |
89bf81b4 |
7 | |
50fb255d |
8 | /** |
9 | * Test Generated example of using activity_contact create API. |
10 | * |
11 | * |
12 | * @return array |
13 | * API result array |
14 | */ |
15 | function activity_contact_create_example() { |
16 | $params = array( |
17 | 'contact_id' => 3, |
18 | 'activity_id' => 1, |
19 | 'record_type_id' => 2, |
20 | ); |
89bf81b4 |
21 | |
50fb255d |
22 | try{ |
23 | $result = civicrm_api3('activity_contact', 'create', $params); |
24 | } |
25 | catch (CiviCRM_API3_Exception $e) { |
26 | // Handle error here. |
27 | $errorMessage = $e->getMessage(); |
28 | $errorCode = $e->getErrorCode(); |
29 | $errorData = $e->getExtraParams(); |
30 | return array( |
31 | 'error' => $errorMessage, |
32 | 'error_code' => $errorCode, |
33 | 'error_data' => $errorData, |
34 | ); |
35 | } |
36 | |
37 | return $result; |
89bf81b4 |
38 | } |
39 | |
40 | /** |
50fb255d |
41 | * Function returns array of result expected from previous function. |
42 | * |
43 | * @return array |
44 | * API result array |
89bf81b4 |
45 | */ |
50fb255d |
46 | function activity_contact_create_expectedresult() { |
89bf81b4 |
47 | |
48 | $expectedResult = array( |
50fb255d |
49 | 'is_error' => 0, |
50 | 'version' => 3, |
51 | 'count' => 1, |
52 | 'id' => 4, |
53 | 'values' => array( |
54 | '4' => array( |
55 | 'id' => '4', |
56 | 'activity_id' => '1', |
57 | 'contact_id' => '3', |
58 | 'record_type_id' => '2', |
59 | ), |
89bf81b4 |
60 | ), |
50fb255d |
61 | ); |
89bf81b4 |
62 | |
63 | return $expectedResult; |
64 | } |
65 | |
50fb255d |
66 | /** |
67 | * This example has been generated from the API test suite. |
68 | * The test that created it is called |
69 | * testCreateActivityContact |
70 | * and can be found in |
89bf81b4 |
71 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ActivityContactTest.php |
72 | * |
73 | * You can see the outcome of the API tests at |
74 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
75 | * |
76 | * To Learn about the API read |
77 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
78 | * |
79 | * Browse the api on your own site with the api explorer |
80 | * http://MYSITE.ORG/path/to/civicrm/api/explorer |
81 | * |
82 | * Read more about testing here |
83 | * http://wiki.civicrm.org/confluence/display/CRM/Testing |
84 | * |
85 | * API Standards documentation: |
86 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards |
87 | */ |