Merge pull request #2749 from monishdeb/HR-317

[civicrm-core.git] / api / v3 / examples / Email / NestedReplaceEmail.php

diff --git a/api/v3/examples/Email/NestedReplaceEmail.php b/api/v3/examples/Email/NestedReplaceEmail.php
index 9a0a46eab3d4cfaf352409cb9bfb1ca82f5f9d2c..7c1c17eb57453840bdf2c3cef6fc0cdf6b78abfc 100644 (file)
--- a/api/v3/examples/Email/NestedReplaceEmail.php
+++ b/api/v3/examples/Email/NestedReplaceEmail.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- example demonstrates use of Replace in a nested API call
+/**
+ * Test Generated example of using email replace API
+ * example demonstrates use of Replace in a nested API call *
  */
 function email_replace_example(){
 $params = array(
-  'version' => 3,
   'id' => 10,
   'api.email.replace' => array(
       'values' => array(
@@ -38,12 +37,21 @@ $params = array(
     ),
 );
 
-  $result = civicrm_api( 'email','replace',$params );
+try{
+  $result = civicrm_api3('email', 'replace', $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 email_replace_expectedresult(){
@@ -71,11 +79,16 @@ function email_replace_expectedresult(){
           'nick_name' => '',
           'legal_name' => '',
           'image_URL' => '',
+          'preferred_communication_method' => '',
+          'preferred_language' => 'en_US',
           'preferred_mail_format' => 'Both',
           'first_name' => '',
           'middle_name' => '',
           'last_name' => '',
+          'prefix_id' => '',
+          'suffix_id' => '',
           'job_title' => '',
+          'gender_id' => '',
           'birth_date' => '',
           'is_deceased' => 0,
           'deceased_date' => '',
@@ -94,10 +107,7 @@ function email_replace_expectedresult(){
           'geo_code_1' => '',
           'geo_code_2' => '',
           'state_province_id' => '',
-          'state_province_name' => '',
-          'state_province' => '',
           'country_id' => '',
-          'country' => '',
           'phone_id' => '',
           'phone_type_id' => '',
           'phone' => '',
@@ -109,6 +119,12 @@ function email_replace_expectedresult(){
           'im' => '',
           'worldregion_id' => '',
           'world_region' => '',
+          'individual_prefix' => '',
+          'individual_suffix' => '',
+          'gender' => '',
+          'state_province_name' => '',
+          'state_province' => '',
+          'country' => '',
           'id' => '10',
           'api.email.replace' => array(
               'is_error' => 0,
@@ -191,7 +207,7 @@ function email_replace_expectedresult(){
     ),
 );
 
-  return $expectedResult  ;
+  return $expectedResult;
 }
 
 
@@ -199,20 +215,20 @@ function email_replace_expectedresult(){
 * This example has been generated from the API test suite. The test that created it is called
 *
 * testReplaceEmailsInChain and can be found in
-* http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/EmailTest.php
+* https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/EmailTest.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
+*/