[civicrm-core.git] / api / v3 / examples / Constant / Get.php

<?php
/**
 * Test Generated example of using constant get API
 * *
 */
function constant_get_example(){
$params = array(
  'field' => 'location_type_id',
);

try{
  $result = civicrm_api3('constant', 'get', $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 constant_get_expectedresult(){

  $expectedResult = array(
  'is_error' => 0,
  'version' => 3,
  'count' => 5,
  'values' => array(
      '5' => 'Billing',
      '1' => 'Home',
      '3' => 'Main',
      '4' => 'Other',
      '2' => 'Work',
    ),
);

  return $expectedResult;
}


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