Merge pull request #9968 from fuzionnz/remove_crm_core_form_generateid
[civicrm-core.git] / api / v3 / examples / GroupContact / GetWithGroupID.php
index 33f66e27e943054fae07be228f5c292da9a33bd6..3fa9f14035ed5458ba9cb0b4af079c463578b7c8 100644 (file)
@@ -1,8 +1,8 @@
 <?php
 /**
- * Test Generated example of using group_contact get API.
+ * Test Generated example demonstrating the GroupContact.get API.
  *
- * Get all from group and display contacts
+ * Get all from group and display contacts.
  *
  * @return array
  *   API result array
@@ -15,7 +15,7 @@ function group_contact_get_example() {
   );
 
   try{
-    $result = civicrm_api3('group_contact', 'get', $params);
+    $result = civicrm_api3('GroupContact', 'get', $params);
   }
   catch (CiviCRM_API3_Exception $e) {
     // Handle error here.
@@ -23,7 +23,8 @@ function group_contact_get_example() {
     $errorCode = $e->getErrorCode();
     $errorData = $e->getExtraParams();
     return array(
-      'error' => $errorMessage,
+      'is_error' => 1,
+      'error_message' => $errorMessage,
       'error_code' => $errorCode,
       'error_data' => $errorData,
     );
@@ -64,9 +65,9 @@ function group_contact_get_expectedresult() {
               'description' => 'New Test Group Created',
               'is_active' => '1',
               'visibility' => 'Public Pages',
-              'where_clause' => ' ( `civicrm_group_contact-3`.group_id IN ( 3 ) AND `civicrm_group_contact-3`.status IN (\"Added\") ) ',
-              '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-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON ( contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.group_id IN ( 3 ) )\";}',
-              'where_tables' => 'a:2:{s:15:\"civicrm_contact\";i:1;s:25:\"`civicrm_group_contact-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON ( contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.group_id IN ( 3 ) )\";}',
+              'where_clause' => ' ( `civicrm_group_contact-3`.group_id IN ( 3 )   ) ',
+              '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-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON (contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.status IN (\'Added\'))\";}',
+              'where_tables' => 'a:2:{s:15:\"civicrm_contact\";i:1;s:25:\"`civicrm_group_contact-3`\";s:165:\" LEFT JOIN civicrm_group_contact `civicrm_group_contact-3` ON (contact_a.id = `civicrm_group_contact-3`.contact_id AND `civicrm_group_contact-3`.status IN (\'Added\'))\";}',
               'group_type' => array(
                 '0' => '1',
                 '1' => '2',
@@ -83,11 +84,10 @@ function group_contact_get_expectedresult() {
   return $expectedResult;
 }
 
-/**
+/*
 * This example has been generated from the API test suite.
-* The test that created it is called
-* testGetGroupID
-* and can be found in
+* The test that created it is called "testGetGroupID"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
 *
 * You can see the outcome of the API tests at