Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using relationship get API | |
4 | * demonstrates is_current filter * | |
6a488035 TO |
5 | */ |
6 | function relationship_get_example(){ | |
26dcc9eb | 7 | $params = array( |
8 | 'filters' => array( | |
6a488035 TO |
9 | 'is_current' => 1, |
10 | ), | |
11 | ); | |
12 | ||
fb32de45 | 13 | try{ |
14 | $result = civicrm_api3('relationship', 'get', $params); | |
15 | } | |
16 | catch (CiviCRM_API3_Exception $e) { | |
17 | // handle error here | |
18 | $errorMessage = $e->getMessage(); | |
19 | $errorCode = $e->getErrorCode(); | |
20 | $errorData = $e->getExtraParams(); | |
21 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
22 | } | |
6a488035 | 23 | |
fb32de45 | 24 | return $result; |
6a488035 TO |
25 | } |
26 | ||
fb32de45 | 27 | /** |
6a488035 TO |
28 | * Function returns array of result expected from previous function |
29 | */ | |
30 | function relationship_get_expectedresult(){ | |
31 | ||
26dcc9eb | 32 | $expectedResult = array( |
6a488035 TO |
33 | 'is_error' => 0, |
34 | 'version' => 3, | |
35 | 'count' => 1, | |
36 | 'id' => 2, | |
26dcc9eb | 37 | 'values' => array( |
38 | '2' => array( | |
6a488035 | 39 | 'id' => '2', |
fb32de45 | 40 | 'contact_id_a' => '60', |
41 | 'contact_id_b' => '61', | |
42 | 'relationship_type_id' => '30', | |
6a488035 TO |
43 | 'start_date' => '2008-12-20', |
44 | 'is_active' => '1', | |
45 | 'description' => '', | |
46 | 'is_permission_a_b' => 0, | |
47 | 'is_permission_b_a' => 0, | |
6a488035 TO |
48 | ), |
49 | ), | |
50 | ); | |
51 | ||
fb32de45 | 52 | return $expectedResult; |
6a488035 TO |
53 | } |
54 | ||
55 | ||
56 | /* | |
57 | * This example has been generated from the API test suite. The test that created it is called | |
58 | * | |
59 | * testGetIsCurrent and can be found in | |
60 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/RelationshipTest.php | |
61 | * | |
62 | * You can see the outcome of the API tests at | |
63 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
64 | * | |
65 | * To Learn about the API read | |
66 | * http://book.civicrm.org/developer/current/techniques/api/ | |
67 | * | |
68 | * and review the wiki at | |
69 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
70 | * | |
71 | * Read more about testing here | |
72 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
73 | * | |
74 | * API Standards documentation: | |
75 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
76 | */ |