Merge pull request #9072 from jeromelebleu/patch-19386

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

diff --git a/api/v3/examples/ParticipantStatusType/Create.php b/api/v3/examples/ParticipantStatusType/Create.php
index 0a61f2634717bd82e500cc4616b8796f40dd76ac..9059a8b3225bcc6fb9c6298beaeb74d669ec5f8b 100644 (file)
--- a/api/v3/examples/ParticipantStatusType/Create.php
+++ b/api/v3/examples/ParticipantStatusType/Create.php
@@ -1,67 +1,76 @@
 <?php
 /**
- * Test Generated example of using participant_status_type create API
- * *
+ * Test Generated example demonstrating the ParticipantStatusType.create API.
+ *
+ * @return array
+ *   API result array
  */
-function participant_status_type_create_example(){
-$params = array(
-  'name' => 'test status',
-  'label' => 'I am a test',
-  'class' => 'Positive',
-  'is_reserved' => 0,
-  'is_active' => 1,
-  'is_counted' => 1,
-  'visibility_id' => 1,
-  'weight' => 10,
-);
+function participant_status_type_create_example() {
+  $params = array(
+    'name' => 'test status',
+    'label' => 'I am a test',
+    'class' => 'Positive',
+    'is_reserved' => 0,
+    'is_active' => 1,
+    'is_counted' => 1,
+    'visibility_id' => 1,
+    'weight' => 10,
+  );
 
-try{
-  $result = civicrm_api3('participant_status_type', '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('ParticipantStatusType', '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 participant_status_type_create_expectedresult(){
+function participant_status_type_create_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 1,
-  'id' => 16,
-  'values' => array(
-      '16' => array(
-          'id' => '16',
-          'name' => 'test status',
-          'label' => 'I am a test',
-          'class' => '14',
-          'is_reserved' => 0,
-          'is_active' => '1',
-          'is_counted' => '1',
-          'weight' => '10',
-          'visibility_id' => '1',
-        ),
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 1,
+    'id' => 18,
+    'values' => array(
+      '18' => array(
+        'id' => '18',
+        'name' => 'test status',
+        'label' => 'I am a test',
+        'class' => 'Positive',
+        'is_reserved' => 0,
+        'is_active' => '1',
+        'is_counted' => '1',
+        'weight' => '10',
+        'visibility_id' => '1',
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
 /*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testCreateParticipantStatusType and can be found in
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetParticipantStatusType"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ParticipantStatusTypeTest.php
 *
 * You can see the outcome of the API tests at
@@ -71,7 +80,7 @@ function participant_status_type_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