api/v3/examples/CustomValue/Create.php

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