api/v3/examples/Note/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Note.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function note_create_example() {
   9   $params = [
  10     'entity_table' => 'civicrm_contact',
  11     'entity_id' => 9,
  12     'note' => 'Hello!!! m testing Note',
  13     'contact_id' => 9,
  14     'modified_date' => '2011-01-31',
  15     'subject' => 'Test Note',
  16   ];
  17
  18   try{
  19     $result = civicrm_api3('Note', 'create', $params);
  20   }
  21   catch (CiviCRM_API3_Exception $e) {
  22     // Handle error here.
  23     $errorMessage = $e->getMessage();
  24     $errorCode = $e->getErrorCode();
  25     $errorData = $e->getExtraParams();
  26     return [
  27       'is_error' => 1,
  28       'error_message' => $errorMessage,
  29       'error_code' => $errorCode,
  30       'error_data' => $errorData,
  31     ];
  32   }
  33
  34   return $result;
  35 }
  36
  37 /**
  38  * Function returns array of result expected from previous function.
  39  *
  40  * @return array
  41  *   API result array
  42  */
  43 function note_create_expectedresult() {
  44
  45   $expectedResult = [
  46     'is_error' => 0,
  47     'version' => 3,
  48     'count' => 1,
  49     'id' => 8,
  50     'values' => [
  51       '8' => [
  52         'id' => '8',
  53         'entity_table' => 'civicrm_contact',
  54         'entity_id' => '9',
  55         'note' => 'Hello!!! m testing Note',
  56         'contact_id' => '9',
  57         'modified_date' => '2012-11-14 16:02:35',
  58         'subject' => 'Test Note',
  59         'privacy' => 0,
  60       ],
  61     ],
  62   ];
  63
  64   return $expectedResult;
  65 }
  66
  67 /*
  68 * This example has been generated from the API test suite.
  69 * The test that created it is called "testCreate"
  70 * and can be found at:
  71 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/NoteTest.php
  72 *
  73 * You can see the outcome of the API tests at
  74 * https://test.civicrm.org/job/CiviCRM-master-git/
  75 *
  76 * To Learn about the API read
  77 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  78 *
  79 * Browse the api on your own site with the api explorer
  80 * http://MYSITE.ORG/path/to/civicrm/api
  81 *
  82 * Read more about testing here
  83 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  84 *
  85 * API Standards documentation:
  86 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  87 */