[civicrm-core.git] / api / v3 / examples / GroupContact / Delete.php

<?php
/**
 * Test Generated example of using group_contact delete API
 * *
 */
function group_contact_delete_example(){
$params = array(
  'contact_id' => 1,
  'group_id' => 1,
);

try{
  $result = civicrm_api3('group_contact', 'delete', $params);
}
catch (CiviCRM_API3_Exception $e) {
  // handle error here
  $errorMessage = $e->getMessage();
  $errorCode = $e->getErrorCode();
  $errorData = $e->getExtraParams();
  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
}

return $result;
}

/**
 * Function returns array of result expected from previous function
 */
function group_contact_delete_expectedresult(){

  $expectedResult = array(
  'is_error' => 0,
  'version' => 3,
  'count' => 1,
  'values' => 1,
  'total_count' => 1,
  'removed' => 1,
  'not_removed' => 0,
);

  return $expectedResult;
}


/*
* This example has been generated from the API test suite. The test that created it is called
*
* testDelete and can be found in
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
*
* You can see the outcome of the API tests at
* https://test.civicrm.org/job/CiviCRM-master-git/
*
* To Learn about the API read
* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
* Browse the api on your own site with the api explorer
* http://MYSITE.ORG/path/to/civicrm/api/explorer
*
* Read more about testing here
* http://wiki.civicrm.org/confluence/display/CRM/Testing
*
* API Standards documentation:
* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
*/
Commit	Line	Data
	1	<?php
	2	/**
	3	* Test Generated example of using group_contact delete API
	4	* *
	5	*/
	6	function group_contact_delete_example(){
	7	$params = array(
	8	'contact_id' => 1,
	9	'group_id' => 1,
	10	);
	11
	12	try{
	13	$result = civicrm_api3('group_contact', 'delete', $params);
	14	}
	15	catch (CiviCRM_API3_Exception $e) {
	16	// handle error here
	17	$errorMessage = $e->getMessage();
	18	$errorCode = $e->getErrorCode();
	19	$errorData = $e->getExtraParams();
	20	return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
	21	}
	22
	23	return $result;
	24	}
	25
	26	/**
	27	* Function returns array of result expected from previous function
	28	*/
	29	function group_contact_delete_expectedresult(){
	30
	31	$expectedResult = array(
	32	'is_error' => 0,
	33	'version' => 3,
	34	'count' => 1,
	35	'values' => 1,
	36	'total_count' => 1,
	37	'removed' => 1,
	38	'not_removed' => 0,
	39	);
	40
	41	return $expectedResult;
	42	}
	43
	44
	45	/*
	46	* This example has been generated from the API test suite. The test that created it is called
	47	*
	48	* testDelete and can be found in
	49	* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GroupContactTest.php
	50	*
	51	* You can see the outcome of the API tests at
	52	* https://test.civicrm.org/job/CiviCRM-master-git/
	53	*
	54	* To Learn about the API read
	55	* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
	56	*
	57	* Browse the api on your own site with the api explorer
	58	* http://MYSITE.ORG/path/to/civicrm/api/explorer
	59	*
	60	* Read more about testing here
	61	* http://wiki.civicrm.org/confluence/display/CRM/Testing
	62	*
	63	* API Standards documentation:
	64	* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
	65	*/