api/v3/examples/Im/Create.php

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