<?php
/**
- * Test Generated example of using address get API
- * Demonstrates Use of Like *
+ * Test Generated example demonstrating the Address.get API.
+ *
+ * Demonstrates Use of Like.
+ *
+ * @return array
+ * API result array
*/
-function address_get_example(){
-$params = array(
- 'street_address' => array(
+function address_get_example() {
+ $params = array(
+ 'street_address' => array(
'LIKE' => '%mb%',
),
- 'sequential' => 1,
-);
+ 'sequential' => 1,
+ );
-try{
- $result = civicrm_api3('address', '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);
-}
+ try{
+ $result = civicrm_api3('Address', '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;
+ return $result;
}
/**
- * Function returns array of result expected from previous function
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ * API result array
*/
-function address_get_expectedresult(){
+function address_get_expectedresult() {
$expectedResult = array(
- 'is_error' => 0,
- 'version' => 3,
- 'count' => 1,
- 'id' => 10,
- 'values' => array(
+ 'is_error' => 0,
+ 'version' => 3,
+ 'count' => 1,
+ 'id' => 1,
+ 'values' => array(
'0' => array(
- 'id' => '10',
- 'contact_id' => '12',
- 'location_type_id' => '15',
- 'is_primary' => '1',
- 'is_billing' => 0,
- 'street_address' => 'Ambachtstraat 23',
- 'street_number' => '23',
- 'street_name' => 'Ambachtstraat',
- 'city' => 'Brummen',
- 'postal_code' => '6971 BN',
- 'country_id' => '1152',
- 'manual_geo_code' => 0,
- ),
+ 'id' => '1',
+ 'contact_id' => '20',
+ 'location_type_id' => '18',
+ 'is_primary' => '1',
+ 'is_billing' => 0,
+ 'street_address' => 'Ambachtstraat 23',
+ 'street_number' => '23',
+ 'street_name' => 'Ambachtstraat',
+ 'city' => 'Brummen',
+ 'postal_code' => '6971 BN',
+ 'country_id' => '1152',
+ 'manual_geo_code' => 0,
+ ),
),
-);
+ );
return $expectedResult;
}
-
/*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetAddressLikeSuccess and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/AddressTest.php
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetAddressLikeSuccess"
+* and can be found at:
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/AddressTest.php
*
* You can see the outcome of the API tests at
-* http://tests.dev.civicrm.org/trunk/results-api_v3
+* https://test.civicrm.org/job/CiviCRM-master-git/
*
* To Learn about the API read
-* http://book.civicrm.org/developer/current/techniques/api/
+* http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
*
-* and review the wiki at
-* http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
+* 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