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( |
b259a4ab | 8 | 'name' => 'Test Group 1', |
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', | |
b259a4ab | 38 | 'name' => 'Test Group 1', |
6a488035 TO |
39 | 'title' => 'New Test Group Created', |
40 | 'description' => 'New Test Group Created', | |
6a488035 TO |
41 | 'is_active' => '1', |
42 | 'visibility' => 'Public Pages', | |
b259a4ab EM |
43 | 'where_clause' => ' ( `civicrm_group_contact-4`.group_id IN ( 4 ) AND `civicrm_group_contact-4`.status IN (\"Added\") ) ', |
44 | '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:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON ( contact_a.id = `civicrm_group_contact-4`.contact_id AND `civicrm_group_contact-4`.group_id IN ( 4 ) )\";}', | |
45 | 'where_tables' => 'a:2:{s:15:\"civicrm_contact\";i:1;s:25:\"`civicrm_group_contact-4`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-4` ON ( contact_a.id = `civicrm_group_contact-4`.contact_id AND `civicrm_group_contact-4`.group_id IN ( 4 ) )\";}', | |
53ca8fd7 | 46 | 'group_type' => array( |
6a488035 TO |
47 | '0' => '1', |
48 | '1' => '2', | |
49 | ), | |
6a488035 TO |
50 | 'is_hidden' => 0, |
51 | 'is_reserved' => 0, | |
6a488035 TO |
52 | ), |
53 | ), | |
54 | ); | |
55 | ||
fb32de45 | 56 | return $expectedResult; |
6a488035 TO |
57 | } |
58 | ||
59 | ||
60 | /* | |
61 | * This example has been generated from the API test suite. The test that created it is called | |
62 | * | |
63 | * testGetGroupParamsWithGroupName and can be found in | |
69d79249 | 64 | * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupTest.php |
6a488035 TO |
65 | * |
66 | * You can see the outcome of the API tests at | |
69d79249 | 67 | * https://test.civicrm.org/job/CiviCRM-master-git/ |
6a488035 TO |
68 | * |
69 | * To Learn about the API read | |
69d79249 | 70 | * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API |
6a488035 | 71 | * |
69d79249 E |
72 | * Browse the api on your own site with the api explorer |
73 | * http://MYSITE.ORG/path/to/civicrm/api/explorer | |
6a488035 TO |
74 | * |
75 | * Read more about testing here | |
76 | * http://wiki.civicrm.org/confluence/display/CRM/Testing | |
77 | * | |
78 | * API Standards documentation: | |
79 | * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards | |
b259a4ab | 80 | */ |