api/v3/examples/DomainCreate.php

   1 <?php
   2 /**
   3  * Test Generated example of using domain create API
   4  * *
   5  */
   6 function domain_create_example(){
   7 $params = array(
   8   'name' => 'A-team domain',
   9   'description' => 'domain of chaos',
  10   'domain_version' => '4.2',
  11   'contact_id' => 6,
  12 );
  13
  14 try{
  15   $result = civicrm_api3('domain', '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 array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
  23 }
  24
  25 return $result;
  26 }
  27
  28 /**
  29  * Function returns array of result expected from previous function
  30  */
  31 function domain_create_expectedresult(){
  32
  33   $expectedResult = array(
  34   'is_error' => 0,
  35   'version' => 3,
  36   'count' => 1,
  37   'id' => 3,
  38   'values' => array(
  39       '3' => array(
  40           'id' => '3',
  41           'name' => 'A-team domain',
  42           'description' => 'domain of chaos',
  43           'config_backend' => '',
  44           'version' => '4.2',
  45           'contact_id' => '6',
  46           'locales' => '',
  47           'locale_custom_strings' => '',
  48         ),
  49     ),
  50 );
  51
  52   return $expectedResult;
  53 }
  54
  55
  56 /*
  57 * This example has been generated from the API test suite. The test that created it is called
  58 *
  59 * testCreate and can be found in
  60 * http://svn.civicrm.org/civicrm/trunk/tests/phpunit/CiviTest/api/v3/DomainTest.php
  61 *
  62 * You can see the outcome of the API tests at
  63 * http://tests.dev.civicrm.org/trunk/results-api_v3
  64 *
  65 * To Learn about the API read
  66 * http://book.civicrm.org/developer/current/techniques/api/
  67 *
  68 * and review the wiki at
  69 * http://wiki.civicrm.org/confluence/display/CRMDOC/CiviCRM+Public+APIs
  70 *
  71 * Read more about testing here
  72 * http://wiki.civicrm.org/confluence/display/CRM/Testing
  73 *
  74 * API Standards documentation:
  75 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
  76 */