tests/templates/documentFunction.tpl

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