Merge pull request #3342 from systopia/CRM-14741

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

diff --git a/api/v3/examples/Setting/CreateAllDomains.php b/api/v3/examples/Setting/CreateAllDomains.php
index 62de561da07a2ff692243695c8566fa13af8f244..e1e3df2134e0324ec0b8eeddd333b58e761bfb85 100644 (file)
--- a/api/v3/examples/Setting/CreateAllDomains.php
+++ b/api/v3/examples/Setting/CreateAllDomains.php
@@ -1,43 +1,51 @@
 <?php
-
-/*
- shows setting a variable for all domains
+/**
+ * Test Generated example of using setting create API
+ * shows setting a variable for all domains *
  */
 function setting_create_example(){
-$params = array( 
-  'version' => 3,
+$params = array(
   'domain_id' => 'all',
   'uniq_email_per_site' => 1,
 );
 
-  $result = civicrm_api( 'setting','create',$params );
+try{
+  $result = civicrm_api3('setting', 'create', $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_create_expectedresult(){
 
-  $expectedResult = array( 
+  $expectedResult = array(
   'is_error' => 0,
   'version' => 3,
   'count' => 3,
-  'values' => array( 
-      '1' => array( 
+  'values' => array(
+      '1' => array(
           'uniq_email_per_site' => '1',
         ),
-      '2' => array( 
+      '2' => array(
           'uniq_email_per_site' => '1',
         ),
-      '3' => array( 
+      '3' => array(
           'uniq_email_per_site' => '1',
         ),
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -45,20 +53,20 @@ function setting_create_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
+*/