api/v3/examples/Domain/Create.ex.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Domain.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function domain_create_example() {
   9   $params = [
  10     'name' => 'A-team domain',
  11     'description' => 'domain of chaos',
  12     'domain_version' => '4.2',
  13     'contact_id' => 7,
  14   ];
  15
  16   try{
  17     $result = civicrm_api3('Domain', 'create', $params);
  18   }
  19   catch (CiviCRM_API3_Exception $e) {
  20     // Handle error here.
  21     $errorMessage = $e->getMessage();
  22     $errorCode = $e->getErrorCode();
  23     $errorData = $e->getExtraParams();
  24     return [
  25       'is_error' => 1,
  26       'error_message' => $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 domain_create_expectedresult() {
  42
  43   $expectedResult = [
  44     'is_error' => 0,
  45     'version' => 3,
  46     'count' => 1,
  47     'id' => 3,
  48     'values' => [
  49       '3' => [
  50         'id' => '3',
  51         'name' => 'A-team domain',
  52         'description' => 'domain of chaos',
  53         'contact_id' => '7',
  54         'locales' => '',
  55         'locale_custom_strings' => '',
  56         'domain_version' => '4.2',
  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 "testCreate"
  67 * and can be found at:
  68 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/DomainTest.php
  69 *
  70 * You can see the outcome of the API tests at
  71 * https://test.civicrm.org/job/CiviCRM-Core-Matrix/
  72 *
  73 * To Learn about the API read
  74 * https://docs.civicrm.org/dev/en/latest/api/
  75 *
  76 * Browse the API on your own site with the API Explorer. It is in the main
  77 * CiviCRM menu, under: Support > Development > API Explorer.
  78 *
  79 * Read more about testing here
  80 * https://docs.civicrm.org/dev/en/latest/testing/
  81 *
  82 * API Standards documentation:
  83 * https://docs.civicrm.org/dev/en/latest/framework/api-architecture/
  84 */