3 * Test Generated example of using group get API
6 function group_get_example(){
8 'name' => 'Test Group 1_4',
12 $result = civicrm_api3('group', 'get', $params);
14 catch (CiviCRM_API3_Exception
$e) {
16 $errorMessage = $e->getMessage();
17 $errorCode = $e->getErrorCode();
18 $errorData = $e->getExtraParams();
19 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
26 * Function returns array of result expected from previous function
28 function group_get_expectedresult(){
30 $expectedResult = array(
38 'name' => 'Test Group 1_4',
39 'title' => 'New Test Group Created',
40 'description' => 'New Test Group Created',
42 'saved_search_id' => '',
44 'visibility' => 'Public Pages',
45 'where_clause' => ' ( `civicrm_group_contact-4`.group_id IN ( 4 ) AND `civicrm_group_contact-4`.status IN ("Added") ) ',
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 ";}',
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 ";}',
48 'group_type' => array(
63 return $expectedResult;
68 * This example has been generated from the API test suite. The test that created it is called
70 * testGetGroupParamsWithGroupName and can be found in
71 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/GroupTest.php
73 * You can see the outcome of the API tests at
74 * http://tests.dev.civicrm.org/trunk/results-api_v3
76 * To Learn about the API read
77 * http://book.civicrm.org/developer/current/techniques/api/
79 * and review the wiki at
80 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
82 * Read more about testing here
83 * http://wiki.civicrm.org/confluence/display/CRM/Testing
85 * API Standards documentation:
86 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards