[civicrm-core.git] / api / v3 / examples / Contact / FormatIsSuccess_True.php

<?php
/**
 * Test Generated example demonstrating the Contact.get API.
 *
 * This demonstrates use of the 'format.is_success' param.
 * This param causes only the success or otherwise of the function to be returned as BOOLEAN
 *
 * @return array
 *   API result array
 */
function contact_get_example() {
  $params = [
    'id' => 17,
    'format.is_success' => 1,
  ];

  try{
    $result = civicrm_api3('Contact', 'get', $params);
  }
  catch (CiviCRM_API3_Exception $e) {
    // Handle error here.
    $errorMessage = $e->getMessage();
    $errorCode = $e->getErrorCode();
    $errorData = $e->getExtraParams();
    return [
      'is_error' => 1,
      'error_message' => $errorMessage,
      'error_code' => $errorCode,
      'error_data' => $errorData,
    ];
  }

  return $result;
}

/**
 * Function returns array of result expected from previous function.
 *
 * @return array
 *   API result array
 */
function contact_get_expectedresult() {

  $expectedResult = 1;

  return $expectedResult;
}

/*
* This example has been generated from the API test suite.
* The test that created it is called "testContactGetFormatIsSuccessTrue"
* and can be found at:
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.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
*
* 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 demonstrating the Contact.get API.
	4	*
	5	* This demonstrates use of the 'format.is_success' param.
	6	* This param causes only the success or otherwise of the function to be returned as BOOLEAN
	7	*
	8	* @return array
	9	* API result array
	10	*/
	11	function contact_get_example() {
	12	$params = [
	13	'id' => 17,
	14	'format.is_success' => 1,
	15	];
	16
	17	try{
	18	$result = civicrm_api3('Contact', 'get', $params);
	19	}
	20	catch (CiviCRM_API3_Exception $e) {
	21	// Handle error here.
	22	$errorMessage = $e->getMessage();
	23	$errorCode = $e->getErrorCode();
	24	$errorData = $e->getExtraParams();
	25	return [
	26	'is_error' => 1,
	27	'error_message' => $errorMessage,
	28	'error_code' => $errorCode,
	29	'error_data' => $errorData,
	30	];
	31	}
	32
	33	return $result;
	34	}
	35
	36	/**
	37	* Function returns array of result expected from previous function.
	38	*
	39	* @return array
	40	* API result array
	41	*/
	42	function contact_get_expectedresult() {
	43
	44	$expectedResult = 1;
	45
	46	return $expectedResult;
	47	}
	48
	49	/*
	50	* This example has been generated from the API test suite.
	51	* The test that created it is called "testContactGetFormatIsSuccessTrue"
	52	* and can be found at:
	53	* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ContactTest.php
	54	*
	55	* You can see the outcome of the API tests at
	56	* https://test.civicrm.org/job/CiviCRM-master-git/
	57	*
	58	* To Learn about the API read
	59	* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
	60	*
	61	* Browse the api on your own site with the api explorer
	62	* http://MYSITE.ORG/path/to/civicrm/api
	63	*
	64	* Read more about testing here
	65	* http://wiki.civicrm.org/confluence/display/CRM/Testing
	66	*
	67	* API Standards documentation:
	68	* http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
	69	*/