Update Test generated examples

[civicrm-core.git] / api / v3 / examples / Profile / Apply.php

diff --git a/api/v3/examples/Profile/Apply.php b/api/v3/examples/Profile/Apply.php
index 50fa56f9dd47ee4f4dabd8d74f44a7de0ac26757..57b867c4d3334dd4f238178107e1de1512d08c1d 100644 (file)
--- a/api/v3/examples/Profile/Apply.php
+++ b/api/v3/examples/Profile/Apply.php
@@ -1,86 +1,95 @@
 <?php
 /**
- * Test Generated example of using profile apply API
- * *
+ * Test Generated example demonstrating the Profile.apply API.
+ *
+ * @return array
+ *   API result array
  */
-function profile_apply_example(){
-$params = array(
-  'profile_id' => 31,
-  'contact_id' => 2,
-  'first_name' => 'abc2',
-  'last_name' => 'xyz2',
-  'email-Primary' => 'abc2.xyz2@gmail.com',
-  'phone-1-1' => '022 321 826',
-  'country-1' => '1013',
-  'state_province-1' => '1000',
-);
+function profile_apply_example() {
+  $params = array(
+    'profile_id' => 31,
+    'contact_id' => 3,
+    'first_name' => 'abc2',
+    'last_name' => 'xyz2',
+    'email-Primary' => 'abc2.xyz2@gmail.com',
+    'phone-1-1' => '022 321 826',
+    'country-1' => '1013',
+    'state_province-1' => '1000',
+  );
 
-try{
-  $result = civicrm_api3('profile', 'apply', $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('Profile', 'apply', $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 profile_apply_expectedresult(){
+function profile_apply_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 11,
-  'values' => array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 11,
+    'values' => array(
       'contact_type' => 'Individual',
       'contact_sub_type' => '',
-      'contact_id' => 2,
+      'contact_id' => 3,
       'version' => 3,
       'debug' => 1,
       'profile_id' => 31,
       'first_name' => 'abc2',
       'last_name' => 'xyz2',
       'email' => array(
-          '1' => array(
-              'location_type_id' => '1',
-              'is_primary' => 1,
-              'email' => 'abc2.xyz2@gmail.com',
-            ),
+        '1' => array(
+          'location_type_id' => '1',
+          'is_primary' => 1,
+          'email' => 'abc2.xyz2@gmail.com',
         ),
+      ),
       'phone' => array(
-          '2' => array(
-              'location_type_id' => '1',
-              'is_primary' => 1,
-              'phone_type_id' => '1',
-              'phone' => '022 321 826',
-            ),
+        '2' => array(
+          'location_type_id' => '1',
+          'is_primary' => 1,
+          'phone_type_id' => '1',
+          'phone' => '022 321 826',
         ),
+      ),
       'address' => array(
-          '1' => array(
-              'location_type_id' => '1',
-              'is_primary' => 1,
-              'country_id' => '1013',
-              'state_province_id' => '1000',
-            ),
+        '1' => array(
+          'location_type_id' => '1',
+          'is_primary' => 1,
+          'country_id' => '1013',
+          'state_province_id' => '1000',
         ),
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
 /*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testProfileApply and can be found in
+* This example has been generated from the API test suite.
+* The test that created it is called "testProfileApply"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/ProfileTest.php
 *
 * You can see the outcome of the API tests at
@@ -90,7 +99,7 @@ function profile_apply_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