crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/api/v3/examples/Grant/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Grant.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function grant_create_example() {
   9   $params = array(
  10     'contact_id' => 3,
  11     'application_received_date' => 'now',
  12     'decision_date' => 'next Monday',
  13     'amount_total' => '500',
  14     'status_id' => 1,
  15     'rationale' => 'Just Because',
  16     'currency' => 'USD',
  17     'grant_type_id' => 1,
  18   );
  19
  20   try{
  21     $result = civicrm_api3('Grant', 'create', $params);
  22   }
  23   catch (CiviCRM_API3_Exception $e) {
  24     // Handle error here.
  25     $errorMessage = $e->getMessage();
  26     $errorCode = $e->getErrorCode();
  27     $errorData = $e->getExtraParams();
  28     return array(
  29       'error' => $errorMessage,
  30       'error_code' => $errorCode,
  31       'error_data' => $errorData,
  32     );
  33   }
  34
  35   return $result;
  36 }
  37
  38 /**
  39  * Function returns array of result expected from previous function.
  40  *
  41  * @return array
  42  *   API result array
  43  */
  44 function grant_create_expectedresult() {
  45
  46   $expectedResult = array(
  47     'is_error' => 0,
  48     'version' => 3,
  49     'count' => 1,
  50     'id' => 1,
  51     'values' => array(
  52       '1' => array(
  53         'id' => '1',
  54         'contact_id' => '3',
  55         'application_received_date' => '20130728084957',
  56         'decision_date' => '20130805000000',
  57         'money_transfer_date' => '',
  58         'grant_due_date' => '',
  59         'grant_report_received' => '',
  60         'grant_type_id' => '1',
  61         'amount_total' => '500',
  62         'amount_requested' => '',
  63         'amount_granted' => '',
  64         'currency' => 'USD',
  65         'rationale' => 'Just Because',
  66         'status_id' => '1',
  67         'financial_type_id' => '',
  68       ),
  69     ),
  70   );
  71
  72   return $expectedResult;
  73 }
  74
  75 /*
  76 * This example has been generated from the API test suite.
  77 * The test that created it is called "testCreateGrant"
  78 * and can be found at:
  79 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/GrantTest.php
  80 *
  81 * You can see the outcome of the API tests at
  82 * https://test.civicrm.org/job/CiviCRM-master-git/
  83 *
  84 * To Learn about the API read
  85 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  86 *
  87 * Browse the api on your own site with the api explorer
  88 * http://MYSITE.ORG/path/to/civicrm/api
  89 *
  90 * Read more about testing here
  91 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  92 *
  93 * API Standards documentation:
  94 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  95 */