Merge pull request #2539 from PalanteJon/CRM-14223

[civicrm-core.git] / api / v3 / examples / Setting / GetSpecifiedDomains.php

diff --git a/api/v3/examples/Setting/GetSpecifiedDomains.php b/api/v3/examples/Setting/GetSpecifiedDomains.php
index 0db018f8219a12f055171f1005a291c79876a093..b112c5bb887d8d4292d8cf78dde296c094af4d18 100644 (file)
--- a/api/v3/examples/Setting/GetSpecifiedDomains.php
+++ b/api/v3/examples/Setting/GetSpecifiedDomains.php
@@ -1,45 +1,53 @@
 <?php
-
-/*
- shows getting a variable for specified domains
+/**
+ * Test Generated example of using setting Get API
+ * shows getting a variable for specified domains *
  */
 function setting_get_example(){
-$params = array( 
-  'version' => 3,
-  'domain_id' => array( 
+$params = array(
+  'domain_id' => array(
       '0' => 1,
       '1' => 2,
     ),
-  'return' => array( 
+  'return' => array(
       '0' => 'uniq_email_per_site',
     ),
 );
 
-  $result = civicrm_api( 'setting','Get',$params );
+try{
+  $result = civicrm_api3('setting', '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 setting_get_expectedresult(){
 
-  $expectedResult = array( 
+  $expectedResult = array(
   'is_error' => 0,
   'version' => 3,
   'count' => 2,
-  'values' => array( 
-      '1' => array( 
+  'values' => array(
+      '1' => array(
           'uniq_email_per_site' => 0,
         ),
-      '2' => array( 
+      '2' => array(
           'uniq_email_per_site' => '1',
         ),
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -47,20 +55,20 @@ function setting_get_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testCreateSettingMultipleDomains and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/SettingTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/SettingTest.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/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
-*/
\ No newline at end of file
+*/