3 * Test Generated example of using group get API.
9 function group_get_example() {
11 'name' => 'Test Group 1',
15 $result = civicrm_api3('group', 'get', $params);
17 catch (CiviCRM_API3_Exception
$e) {
19 $errorMessage = $e->getMessage();
20 $errorCode = $e->getErrorCode();
21 $errorData = $e->getExtraParams();
23 'error' => $errorMessage,
24 'error_code' => $errorCode,
25 'error_data' => $errorData,
33 * Function returns array of result expected from previous function.
38 function group_get_expectedresult() {
40 $expectedResult = array(
48 'name' => 'Test Group 1',
49 'title' => 'New Test Group Created',
50 'description' => 'New Test Group Created',
52 'visibility' => 'Public Pages',
53 'where_clause' => ' ( `civicrm_group_contact-4`.group_id IN ( 4 ) AND `civicrm_group_contact-4`.status IN (\"Added\") ) ',
54 '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 ) )\";}',
55 '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 ) )\";}',
56 'group_type' => array(
66 return $expectedResult;
70 * This example has been generated from the API test suite.
71 * The test that created it is called
72 * testGetGroupParamsWithGroupName
74 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupTest.php
76 * You can see the outcome of the API tests at
77 * https://test.civicrm.org/job/CiviCRM-master-git/
79 * To Learn about the API read
80 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
82 * Browse the api on your own site with the api explorer
83 * http://MYSITE.ORG/path/to/civicrm/api
85 * Read more about testing here
86 * http://wiki.civicrm.org/confluence/display/CRM/Testing
88 * API Standards documentation:
89 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards