tests/templates/documentFunction.tpl

   1 {literal}<?php{/literal}
   2 /**
   3  * Test Generated example of using {$fnPrefix} {$action} API
   4  *{if $description} {$description}{/if}
   5  *
   6  */
   7 function {$function}_example(){literal}{{/literal}
   8 $params = {$params|@print_array};
   9 {literal}
  10 try{{/literal}
  11   $result = civicrm_api3('{$fnPrefix}', '{$action}', $params);
  12 {literal}}
  13 catch (CiviCRM_API3_Exception $e) {
  14   // handle error here
  15   $errorMessage = $e->getMessage();
  16   $errorCode = $e->getErrorCode();
  17   $errorData = $e->getExtraParams();
  18   return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  19 }{/literal}
  20
  21 return $result;
  22 {literal}}{/literal}
  23
  24 /**
  25  * Function returns array of result expected from previous function
  26  */
  27 function {$function}_expectedresult(){literal}{{/literal}
  28
  29   $expectedResult = {$result|@print_array};
  30
  31   return $expectedResult;
  32 {literal}}{/literal}
  33
  34
  35 /*
  36 * This example has been generated from the API test suite. The test that created it is called
  37 *
  38 * {$testfunction} and can be found in
  39 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/{$filename}
  40 *
  41 * You can see the outcome of the API tests at
  42 * http://tests.dev.civicrm.org/trunk/results-api_v3
  43 *
  44 * To Learn about the API read
  45 * http://book.civicrm.org/developer/current/techniques/api/
  46 *
  47 * and review the wiki at
  48 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  49 *
  50 * Read more about testing here
  51 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  52 *
  53 * API Standards documentation:
  54 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  55 */