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