tests/templates/documentFunction.tpl

   1 {literal}<?php{/literal}
   2 /**
   3  * @file
   4  * Test Generated API Example.
   5  * See bottom of this file for more detail.
   6  */
   7
   8 /**
   9  * Test Generated example of using {$fnPrefix} {$action} API.
  10  *
  11 {if $description}
  12  * {$description}
  13 {/if}
  14  *
  15  * @return array
  16  *   API result array
  17  */
  18 function {$function}_example() {literal}{{/literal}
  19   $params = {$params|@print_array};
  20 {literal}
  21   try{{/literal}
  22     $result = civicrm_api3('{$fnPrefix}', '{$action}', $params);
  23 {literal}  }
  24   catch (CiviCRM_API3_Exception $e) {
  25     // Handle error here.
  26     $errorMessage = $e->getMessage();
  27     $errorCode = $e->getErrorCode();
  28     $errorData = $e->getExtraParams();
  29     return array(
  30       'error' => $errorMessage,
  31       'error_code' => $errorCode,
  32       'error_data' => $errorData,
  33     );
  34   }{/literal}
  35
  36   return $result;
  37 {literal}}{/literal}
  38
  39 /**
  40  * Function returns array of result expected from previous function.
  41  *
  42  * @return array
  43  *   API result array
  44  */
  45 function {$function}_expectedresult() {literal}{{/literal}
  46
  47   $expectedResult = {$result|@print_array};
  48
  49   return $expectedResult;
  50 {literal}}{/literal}
  51
  52 /**
  53 * This example has been generated from the API test suite.
  54 * The test that created it is called
  55 * {$testfunction}
  56 * and can be found in
  57 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/{$filename}
  58 *
  59 * You can see the outcome of the API tests at
  60 * https://test.civicrm.org/job/CiviCRM-master-git/
  61 *
  62 * To Learn about the API read
  63 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  64 *
  65 * Browse the api on your own site with the api explorer
  66 * http://MYSITE.ORG/path/to/civicrm/api/explorer
  67 *
  68 * Read more about testing here
  69 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  70 *
  71 * API Standards documentation:
  72 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  73 */