125 lines
3.4 KiB
PHP
125 lines
3.4 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* Test Generated example demonstrating the Domain.get API.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
* API result array
|
||
|
|
*/
|
||
|
|
function domain_get_example() {
|
||
|
|
$params = array(
|
||
|
|
'sequential' => 1,
|
||
|
|
);
|
||
|
|
|
||
|
|
try{
|
||
|
|
$result = civicrm_api3('Domain', 'get', $params);
|
||
|
|
}
|
||
|
|
catch (CiviCRM_API3_Exception $e) {
|
||
|
|
// Handle error here.
|
||
|
|
$errorMessage = $e->getMessage();
|
||
|
|
$errorCode = $e->getErrorCode();
|
||
|
|
$errorData = $e->getExtraParams();
|
||
|
|
return array(
|
||
|
|
'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 domain_get_expectedresult() {
|
||
|
|
|
||
|
|
$expectedResult = array(
|
||
|
|
'is_error' => 0,
|
||
|
|
'version' => 3,
|
||
|
|
'count' => 2,
|
||
|
|
'values' => array(
|
||
|
|
'0' => array(
|
||
|
|
'id' => '1',
|
||
|
|
'name' => 'Default Domain Name',
|
||
|
|
'version' => '4.6.alpha1',
|
||
|
|
'contact_id' => '3',
|
||
|
|
'locale_custom_strings' => 'a:1:{s:5:\"en_US\";a:0:{}}',
|
||
|
|
'domain_email' => 'my@email.com',
|
||
|
|
'domain_phone' => array(
|
||
|
|
'phone_type' => 'Phone',
|
||
|
|
'phone' => '456-456',
|
||
|
|
),
|
||
|
|
'domain_address' => array(
|
||
|
|
'street_address' => '45 Penny Lane',
|
||
|
|
'supplemental_address_1' => '',
|
||
|
|
'supplemental_address_2' => '',
|
||
|
|
'supplemental_address_3' => '',
|
||
|
|
'city' => '',
|
||
|
|
'state_province_id' => '',
|
||
|
|
'postal_code' => '',
|
||
|
|
'country_id' => '',
|
||
|
|
'geo_code_1' => '',
|
||
|
|
'geo_code_2' => '',
|
||
|
|
),
|
||
|
|
'from_email' => 'info@EXAMPLE.ORG',
|
||
|
|
'from_name' => 'FIXME',
|
||
|
|
'domain_version' => '4.6.alpha1',
|
||
|
|
),
|
||
|
|
'1' => array(
|
||
|
|
'id' => '2',
|
||
|
|
'name' => 'Second Domain',
|
||
|
|
'version' => '4.6.alpha1',
|
||
|
|
'contact_id' => '2',
|
||
|
|
'domain_email' => '\"Domain Email\" <domainemail2@example.org>',
|
||
|
|
'domain_phone' => array(
|
||
|
|
'phone_type' => 'Phone',
|
||
|
|
'phone' => '204 555-1001',
|
||
|
|
),
|
||
|
|
'domain_address' => array(
|
||
|
|
'street_address' => '15 Main St',
|
||
|
|
'supplemental_address_1' => '',
|
||
|
|
'supplemental_address_2' => '',
|
||
|
|
'supplemental_address_3' => '',
|
||
|
|
'city' => 'Collinsville',
|
||
|
|
'state_province_id' => '1006',
|
||
|
|
'postal_code' => '6022',
|
||
|
|
'country_id' => '1228',
|
||
|
|
'geo_code_1' => '41.8328',
|
||
|
|
'geo_code_2' => '-72.9253',
|
||
|
|
),
|
||
|
|
'from_email' => 'info@EXAMPLE.ORG',
|
||
|
|
'from_name' => 'FIXME',
|
||
|
|
'domain_version' => '4.6.alpha1',
|
||
|
|
),
|
||
|
|
),
|
||
|
|
);
|
||
|
|
|
||
|
|
return $expectedResult;
|
||
|
|
}
|
||
|
|
|
||
|
|
/*
|
||
|
|
* This example has been generated from the API test suite.
|
||
|
|
* The test that created it is called "testGet"
|
||
|
|
* and can be found at:
|
||
|
|
* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/DomainTest.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
|
||
|
|
*/
|