crm.fsf.org/20131203/files/sites/all/modules-new/civicrm/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 = array(
  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 array(
  27       'error' => $errorMessage,
  28       'error_code' => $errorCode,
  29       'error_data' => $errorData,
  30     );
  31   }
  32
  33   return $result;
  34 }
  35
  36 /**
  37  * Function returns array of result expected from previous function.
  38  *
  39  * @return array
  40  *   API result array
  41  */
  42 function note_create_expectedresult() {
  43
  44   $expectedResult = array(
  45     'is_error' => 0,
  46     'version' => 3,
  47     'count' => 1,
  48     'id' => 8,
  49     'values' => array(
  50       '8' => array(
  51         'id' => '8',
  52         'entity_table' => 'civicrm_contact',
  53         'entity_id' => '9',
  54         'note' => 'Hello!!! m testing Note',
  55         'contact_id' => '9',
  56         'modified_date' => '2012-11-14 16:02:35',
  57         'subject' => 'Test Note',
  58         'privacy' => 0,
  59       ),
  60     ),
  61   );
  62
  63   return $expectedResult;
  64 }
  65
  66 /*
  67 * This example has been generated from the API test suite.
  68 * The test that created it is called "testCreate"
  69 * and can be found at:
  70 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/NoteTest.php
  71 *
  72 * You can see the outcome of the API tests at
  73 * https://test.civicrm.org/job/CiviCRM-master-git/
  74 *
  75 * To Learn about the API read
  76 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
  77 *
  78 * Browse the api on your own site with the api explorer
  79 * http://MYSITE.ORG/path/to/civicrm/api
  80 *
  81 * Read more about testing here
  82 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  83 *
  84 * API Standards documentation:
  85 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  86 */