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