Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
50fb255d | 2 | /** |
a828d7b8 | 3 | * Test Generated example demonstrating the Relationship.get API. |
50fb255d | 4 | * |
5c49fee0 | 5 | * Demonstrates use of NOT IN filter. |
50fb255d | 6 | * |
7 | * @return array | |
8 | * API result array | |
9 | */ | |
10 | function relationship_get_example() { | |
cf8f0fff CW |
11 | $params = [ |
12 | 'relationship_type_id' => [ | |
13 | 'NOT IN' => [ | |
1d8ee3d6 | 14 | '0' => 36, |
15 | '1' => 37, | |
cf8f0fff CW |
16 | ], |
17 | ], | |
18 | ]; | |
6a488035 | 19 | |
50fb255d | 20 | try{ |
a828d7b8 | 21 | $result = civicrm_api3('Relationship', 'get', $params); |
50fb255d | 22 | } |
23 | catch (CiviCRM_API3_Exception $e) { | |
24 | // Handle error here. | |
25 | $errorMessage = $e->getMessage(); | |
26 | $errorCode = $e->getErrorCode(); | |
27 | $errorData = $e->getExtraParams(); | |
cf8f0fff | 28 | return [ |
1d8ee3d6 | 29 | 'is_error' => 1, |
30 | 'error_message' => $errorMessage, | |
50fb255d | 31 | 'error_code' => $errorCode, |
32 | 'error_data' => $errorData, | |
cf8f0fff | 33 | ]; |
50fb255d | 34 | } |
6a488035 | 35 | |
50fb255d | 36 | return $result; |
6a488035 TO |
37 | } |
38 | ||
fb32de45 | 39 | /** |
50fb255d | 40 | * Function returns array of result expected from previous function. |
41 | * | |
42 | * @return array | |
43 | * API result array | |
6a488035 | 44 | */ |
50fb255d | 45 | function relationship_get_expectedresult() { |
6a488035 | 46 | |
cf8f0fff | 47 | $expectedResult = [ |
50fb255d | 48 | 'is_error' => 0, |
49 | 'version' => 3, | |
50 | 'count' => 2, | |
cf8f0fff CW |
51 | 'values' => [ |
52 | '1' => [ | |
50fb255d | 53 | 'id' => '1', |
1d8ee3d6 | 54 | 'contact_id_a' => '99', |
55 | 'contact_id_b' => '101', | |
56 | 'relationship_type_id' => '35', | |
50fb255d | 57 | 'start_date' => '2013-07-29 00:00:00', |
58 | 'is_active' => '1', | |
50fb255d | 59 | 'is_permission_a_b' => 0, |
60 | 'is_permission_b_a' => 0, | |
cf8f0fff CW |
61 | ], |
62 | '4' => [ | |
50fb255d | 63 | 'id' => '4', |
1d8ee3d6 | 64 | 'contact_id_a' => '99', |
65 | 'contact_id_b' => '101', | |
66 | 'relationship_type_id' => '38', | |
50fb255d | 67 | 'start_date' => '2013-07-29 00:00:00', |
68 | 'is_active' => '1', | |
50fb255d | 69 | 'is_permission_a_b' => 0, |
70 | 'is_permission_b_a' => 0, | |
cf8f0fff CW |
71 | ], |
72 | ], | |
73 | ]; | |
6a488035 | 74 | |
fb32de45 | 75 | return $expectedResult; |
6a488035 TO |
76 | } |
77 | ||
a828d7b8 | 78 | /* |
50fb255d | 79 | * This example has been generated from the API test suite. |
a828d7b8 CW |
80 | * The test that created it is called "testGetTypeOperators" |
81 | * and can be found at: | |
69d79249 | 82 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/RelationshipTest.php |
6a488035 TO |
83 | * |
84 | * You can see the outcome of the API tests at | |
69d79249 | 85 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
86 | * |
87 | * To Learn about the API read | |
69d79249 | 88 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 89 | * |
69d79249 | 90 | * Browse the api on your own site with the api explorer |
41d4d31f | 91 | * http://MYSITE.ORG/path/to/civicrm/api |
6a488035 TO |
92 | * |
93 | * Read more about testing here | |
94 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
95 | * | |
96 | * API Standards documentation: | |
97 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
49f8272d | 98 | */ |