Merge remote-tracking branch 'upstream/4.3' into 4.3-master-2013-08-28-20-20-34
[civicrm-core.git] / api / v3 / examples / Setting / GetDefaults.php
index 4b5efa7526f105c08e6676e5d0f15c48638b85bf..5084c159cee6aacd1edf3a98d75819fdc3ffa40a 100644 (file)
@@ -1,20 +1,28 @@
 <?php
-
-/*
- gets defaults setting a variable for a given domain - if no domain is set current is assumed
+/**
+ * Test Generated example of using setting getdefaults API
+ * gets defaults setting a variable for a given domain - if no domain is set current is assumed *
  */
 function setting_getdefaults_example(){
 $params = array(
-  'version' => 3,
   'name' => 'address_format',
 );
 
-  $result = civicrm_api( 'setting','getdefaults',$params );
+try{
+  $result = civicrm_api3('setting', 'getdefaults', $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_getdefaults_expectedresult(){
@@ -36,7 +44,7 @@ function setting_getdefaults_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }