Update Test generated examples

[civicrm-core.git] / api / v3 / examples / Country / Create.php

diff --git a/api/v3/examples/Country/Create.php b/api/v3/examples/Country/Create.php
index 7789a17ac03bc4cb784a21a20a8c716b69c7a789..988b9bcfc9158c3b8a5ec4f29d5e9242623043d8 100644 (file)
--- a/api/v3/examples/Country/Create.php
+++ b/api/v3/examples/Country/Create.php
@@ -1,62 +1,71 @@
 <?php
 /**
- * Test Generated example of using country create API
- * *
+ * Test Generated example demonstrating the Country.create API.
+ *
+ * @return array
+ *   API result array
  */
-function country_create_example(){
-$params = array(
-  'name' => 'Made Up Land',
-  'iso_code' => 'ML',
-  'region_id' => 1,
-);
+function country_create_example() {
+  $params = array(
+    'name' => 'Made Up Land',
+    'iso_code' => 'ZZ',
+    'region_id' => 1,
+  );
 
-try{
-  $result = civicrm_api3('country', 'create', $params);
-}
-catch (CiviCRM_API3_Exception $e) {
-  // handle error here
-  $errorMessage = $e->getMessage();
-  $errorCode = $e->getErrorCode();
-  $errorData = $e->getExtraParams();
-  return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
-}
+  try{
+    $result = civicrm_api3('Country', 'create', $params);
+  }
+  catch (CiviCRM_API3_Exception $e) {
+    // Handle error here.
+    $errorMessage = $e->getMessage();
+    $errorCode = $e->getErrorCode();
+    $errorData = $e->getExtraParams();
+    return array(
+      'is_error' => 1,
+      'error_message' => $errorMessage,
+      'error_code' => $errorCode,
+      'error_data' => $errorData,
+    );
+  }
 
-return $result;
+  return $result;
 }
 
 /**
- * Function returns array of result expected from previous function
+ * Function returns array of result expected from previous function.
+ *
+ * @return array
+ *   API result array
  */
-function country_create_expectedresult(){
+function country_create_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 1,
-  'id' => 1,
-  'values' => array(
-      '1' => array(
-          'id' => '1',
-          'name' => 'Made Up Land',
-          'iso_code' => 'ML',
-          'country_code' => '',
-          'address_format_id' => '',
-          'idd_prefix' => '',
-          'ndd_prefix' => '',
-          'region_id' => '1',
-          'is_province_abbreviated' => '',
-        ),
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 1254,
+    'values' => array(
+      '1254' => array(
+        'id' => '1254',
+        'name' => 'Made Up Land',
+        'iso_code' => 'ZZ',
+        'country_code' => '',
+        'address_format_id' => '',
+        'idd_prefix' => '',
+        'ndd_prefix' => '',
+        'region_id' => '1',
+        'is_province_abbreviated' => '',
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
 /*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testCreateCountry and can be found in
+* This example has been generated from the API test suite.
+* The test that created it is called "testCreateCountry"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/CountryTest.php
 *
 * You can see the outcome of the API tests at
@@ -66,7 +75,7 @@ function country_create_expectedresult(){
 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
 *
 * Browse the api on your own site with the api explorer
-* http://MYSITE.ORG/path/to/civicrm/api/explorer
+* http://MYSITE.ORG/path/to/civicrm/api
 *
 * Read more about testing here
 * http://wiki.civicrm.org/confluence/display/CRM/Testing