Merge pull request #2444 from eileenmcnaughton/CRM-14151
[civicrm-core.git] / tests / templates / documentFunction.tpl
index 9343e575d6e85519f8f16a787e66aa94cb1c120a..a13d722fa9a23d4708315f293654232fdce23d35 100644 (file)
@@ -1,24 +1,34 @@
 {literal}<?php{/literal}
-
-/*
- *{$description}
+/**
+ * Test Generated example of using {$fnPrefix} {$action} API
+ *{if $description} {$description}{/if}
+ *
  */
 function {$function}_example(){literal}{{/literal}
 $params = {$params|@print_array};
-
-  $result = civicrm_api( '{$fnPrefix}','{$action}',$params );
-
-  return $result;
+{literal}
+try{{/literal}
+  $result = civicrm_api3('{$fnPrefix}', '{$action}', $params);
+{literal}}
+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);
+}{/literal}
+
+return $result;
 {literal}}{/literal}
 
-/*
+/**
  * Function returns array of result expected from previous function
  */
 function {$function}_expectedresult(){literal}{{/literal}
 
   $expectedResult = {$result|@print_array};
 
-  return $expectedResult  ;
+  return $expectedResult;
 {literal}}{/literal}
 
 
@@ -42,4 +52,4 @@ function {$function}_expectedresult(){literal}{{/literal}
 *
 * API Standards documentation:
 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
-*/
\ No newline at end of file
+*/