api/v3/examples/Country/Create.php

   1 <?php
   2 /**
   3  * Test Generated example demonstrating the Country.create API.
   4  *
   5  * @return array
   6  *   API result array
   7  */
   8 function country_create_example() {
   9   $params = array(
  10     'name' => 'Made Up Land',
  11     'iso_code' => 'ZZ',
  12     'region_id' => 1,
  13   );
  14
  15   try{
  16     $result = civicrm_api3('Country', 'create', $params);
  17   }
  18   catch (CiviCRM_API3_Exception $e) {
  19     // Handle error here.
  20     $errorMessage = $e->getMessage();
  21     $errorCode = $e->getErrorCode();
  22     $errorData = $e->getExtraParams();
  23     return array(
  24       'is_error' => 1,
  25       'error_message' => $errorMessage,
  26       'error_code' => $errorCode,
  27       'error_data' => $errorData,
  28     );
  29   }
  30
  31   return $result;
  32 }
  33
  34 /**
  35  * Function returns array of result expected from previous function.
  36  *
  37  * @return array
  38  *   API result array
  39  */
  40 function country_create_expectedresult() {
  41
  42   $expectedResult = array(
  43     'is_error' => 0,
  44     'version' => 3,
  45     'count' => 1,
  46     'id' => 1252,
  47     'values' => array(
  48       '1252' => array(
  49         'id' => '1252',
  50         'name' => 'Made Up Land',
  51         'iso_code' => 'ZZ',
  52         'country_code' => '',
  53         'address_format_id' => '',
  54         'idd_prefix' => '',
  55         'ndd_prefix' => '',
  56         'region_id' => '1',
  57         'is_province_abbreviated' => '',
  58       ),
  59     ),
  60   );
  61
  62   return $expectedResult;
  63 }
  64
  65 /*
  66 * This example has been generated from the API test suite.
  67 * The test that created it is called "testCreateCountry"
  68 * and can be found at:
  69 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CountryTest.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 */