Commit | Line | Data |
---|---|---|
6a488035 | 1 | <?php |
fb32de45 | 2 | /** |
3 | * Test Generated example of using group get API | |
4 | * * | |
6a488035 TO |
5 | */ |
6 | function group_get_example(){ | |
53ca8fd7 | 7 | $params = array( |
fb32de45 | 8 | 'name' => 'Test Group 1_4', |
6a488035 TO |
9 | ); |
10 | ||
fb32de45 | 11 | try{ |
12 | $result = civicrm_api3('group', 'get', $params); | |
13 | } | |
14 | catch (CiviCRM_API3_Exception $e) { | |
15 | // handle error here | |
16 | $errorMessage = $e->getMessage(); | |
17 | $errorCode = $e->getErrorCode(); | |
18 | $errorData = $e->getExtraParams(); | |
19 | return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData); | |
20 | } | |
6a488035 | 21 | |
fb32de45 | 22 | return $result; |
6a488035 TO |
23 | } |
24 | ||
fb32de45 | 25 | /** |
6a488035 TO |
26 | * Function returns array of result expected from previous function |
27 | */ | |
28 | function group_get_expectedresult(){ | |
29 | ||
53ca8fd7 | 30 | $expectedResult = array( |
6a488035 TO |
31 | 'is_error' => 0, |
32 | 'version' => 3, | |
33 | 'count' => 1, | |
fb32de45 | 34 | 'id' => 4, |
53ca8fd7 | 35 | 'values' => array( |
fb32de45 | 36 | '4' => array( |
37 | 'id' => '4', | |
38 | 'name' => 'Test Group 1_4', | |
6a488035 TO |
39 | 'title' => 'New Test Group Created', |
40 | 'description' => 'New Test Group Created', | |
41 | 'source' => '', | |
42 | 'saved_search_id' => '', | |
43 | 'is_active' => '1', | |
44 | 'visibility' => 'Public Pages', | |
fb32de45 | 45 | 'where_clause' => ' ( `civicrm_group_contact-4`.group_id IN ( 4 ) AND `civicrm_group_contact-4`.status IN ("Added") ) ', |
9f1b81e0 | 46 | 'select_tables' => 'a:8:{s:15:"civicrm_contact";i:1;s:15:"civicrm_address";i:1;s:15:"civicrm_country";i:1;s:13:"civicrm_email";i:1;s:13:"civicrm_phone";i:1;s:10:"civicrm_im";i:1;s:19:"civicrm_worldregion";i:1;s:25:"`civicrm_group_contact-4`";s:114:" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON contact_a.id = `civicrm_group_contact-4`.contact_id ";}', |
fb32de45 | 47 | 'where_tables' => 'a:2:{s:15:"civicrm_contact";i:1;s:25:"`civicrm_group_contact-4`";s:114:" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON contact_a.id = `civicrm_group_contact-4`.contact_id ";}', |
53ca8fd7 | 48 | 'group_type' => array( |
6a488035 TO |
49 | '0' => '1', |
50 | '1' => '2', | |
51 | ), | |
52 | 'cache_date' => '', | |
53 | 'refresh_date' => '', | |
54 | 'parents' => '', | |
55 | 'children' => '', | |
56 | 'is_hidden' => 0, | |
57 | 'is_reserved' => 0, | |
58 | 'created_id' => '', | |
59 | ), | |
60 | ), | |
61 | ); | |
62 | ||
fb32de45 | 63 | return $expectedResult; |
6a488035 TO |
64 | } |
65 | ||
66 | ||
67 | /* | |
68 | * This example has been generated from the API test suite. The test that created it is called | |
69 | * | |
70 | * testGetGroupParamsWithGroupName and can be found in | |
71 | * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/GroupTest.php | |
72 | * | |
73 | * You can see the outcome of the API tests at | |
74 | * http://tests.dev.civicrm.org/trunk/results-api_v3 | |
75 | * | |
76 | * To Learn about the API read | |
77 | * http://book.civicrm.org/developer/current/techniques/api/ | |
78 | * | |
79 | * and review the wiki at | |
80 | * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs | |
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 | */ |