CRM-15988 - Update generated examples

[civicrm-core.git] / api / v3 / examples / Website / GetWithMetadata.php

diff --git a/api/v3/examples/Website/GetWithMetadata.php b/api/v3/examples/Website/GetWithMetadata.php
index 262924e1bd064742a8ad3409d941ecb63ebb2005..db2e42874cdfcf55e3aab181c335c2111bedfa18 100644 (file)
--- a/api/v3/examples/Website/GetWithMetadata.php
+++ b/api/v3/examples/Website/GetWithMetadata.php
@@ -1,90 +1,107 @@
 <?php
 /**
- * Test Generated example of using website get API
- * Demonostrates returning field metadata *
+ * Test Generated example demonstrating the Website.get API.
+ *
+ * Demonostrates returning field metadata
+ *
+ * @return array
+ *   API result array
  */
-function website_get_example(){
-$params = array(
-  'options' => array(
+function website_get_example() {
+  $params = array(
+    'options' => array(
       'metadata' => array(
-          '0' => 'fields',
-        ),
+        '0' => 'fields',
+      ),
     ),
-);
+  );
 
-try{
-  $result = civicrm_api3('website', 'get', $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('Website', 'get', $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,
+    );
+  }
 
-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 website_get_expectedresult(){
+function website_get_expectedresult() {
 
   $expectedResult = array(
-  'is_error' => 0,
-  'version' => 3,
-  'count' => 0,
-  'values' => array(),
-  'metadata' => array(
+    'is_error' => 0,
+    'version' => 3,
+    'count' => 0,
+    'values' => array(),
+    'metadata' => array(
       'fields' => array(
-          'id' => array(
-              'name' => 'id',
-              'type' => '1',
-              'title' => 'Website ID',
-              'required' => '1',
-              'api.aliases' => array(
-                  '0' => 'website_id',
-                ),
-            ),
-          'contact_id' => array(
-              'name' => 'contact_id',
-              'type' => '1',
-              'title' => 'Contact',
-              'FKClassName' => 'CRM_Contact_DAO_Contact',
-            ),
-          'url' => array(
-              'name' => 'url',
-              'type' => '2',
-              'title' => 'Website',
-              'maxlength' => '128',
-              'size' => '30',
-              'import' => '1',
-              'where' => 'civicrm_website.url',
-              'headerPattern' => '/Website/i',
-              'dataPattern' => '/^[A-Za-z][0-9A-Za-z]{20,}$/',
-              'export' => '1',
-            ),
-          'website_type_id' => array(
-              'name' => 'website_type_id',
-              'type' => '1',
-              'title' => 'Website Type',
-              'pseudoconstant' => array(
-                  'optionGroupName' => 'website_type',
-                ),
-            ),
+        'id' => array(
+          'name' => 'id',
+          'type' => '1',
+          'title' => 'Website ID',
+          'required' => '1',
+          'api.aliases' => array(
+            '0' => 'website_id',
+          ),
+        ),
+        'contact_id' => array(
+          'name' => 'contact_id',
+          'type' => '1',
+          'title' => 'Contact',
+          'FKClassName' => 'CRM_Contact_DAO_Contact',
+          'FKApiName' => 'Contact',
         ),
+        'url' => array(
+          'name' => 'url',
+          'type' => '2',
+          'title' => 'Website',
+          'maxlength' => '128',
+          'size' => '30',
+          'import' => '1',
+          'where' => 'civicrm_website.url',
+          'headerPattern' => '/Website/i',
+          'dataPattern' => '/^[A-Za-z][0-9A-Za-z]{20,}$/',
+          'export' => '1',
+          'html' => array(
+            'type' => 'Text',
+          ),
+        ),
+        'website_type_id' => array(
+          'name' => 'website_type_id',
+          'type' => '1',
+          'title' => 'Website Type',
+          'html' => array(
+            'type' => 'Select',
+          ),
+          'pseudoconstant' => array(
+            'optionGroupName' => 'website_type',
+          ),
+        ),
+      ),
     ),
-);
+  );
 
   return $expectedResult;
 }
 
-
 /*
-* This example has been generated from the API test suite. The test that created it is called
-*
-* testGetMetadata and can be found in
+* This example has been generated from the API test suite.
+* The test that created it is called "testGetMetadata"
+* and can be found at:
 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/WebsiteTest.php
 *
 * You can see the outcome of the API tests at
@@ -94,7 +111,7 @@ function website_get_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