api/v3/examples/GroupContactDelete.php

   1 <?php
   2
   3 /*
   4
   5  */
   6 function group_contact_delete_example(){
   7 $params = array(
   8   'contact_id' => 1,
   9   'group_id' => 1,
  10   'version' => 3,
  11 );
  12
  13   $result = civicrm_api( 'group_contact','delete',$params );
  14
  15   return $result;
  16 }
  17
  18 /*
  19  * Function returns array of result expected from previous function
  20  */
  21 function group_contact_delete_expectedresult(){
  22
  23   $expectedResult = array(
  24   'is_error' => 0,
  25   'version' => 3,
  26   'count' => 1,
  27   'values' => 1,
  28   'total_count' => 1,
  29   'removed' => 1,
  30   'not_removed' => 0,
  31 );
  32
  33   return $expectedResult  ;
  34 }
  35
  36
  37 /*
  38 * This example has been generated from the API test suite. The test that created it is called
  39 *
  40 * testDelete and can be found in
  41 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/GroupContactTest.php
  42 *
  43 * You can see the outcome of the API tests at
  44 * http://tests.dev.civicrm.org/trunk/results-api_v3
  45 *
  46 * To Learn about the API read
  47 * http://book.civicrm.org/developer/current/techniques/api/
  48 *
  49 * and review the wiki at
  50 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  51 *
  52 * Read more about testing here
  53 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  54 *
  55 * API Standards documentation:
  56 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  57 */