Merge remote-tracking branch 'origin/4.5' into 4.5-master-2015-02-24-17-24-05

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

diff --git a/api/v3/Website.php b/api/v3/Website.php
index f22af6603b3cf1997c157e98053b9dae3500595d..703a55b8ef3334fe1bff22010c41df06fb337866 100644 (file)
--- a/api/v3/Website.php
+++ b/api/v3/Website.php
@@ -1,5 +1,4 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
@@ -24,31 +23,21 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
- * File for the CiviCRM APIv3 website functions
+ * This api exposes CiviCRM website records.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Website
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: Website.php 2011-03-16 ErikHommel $
  */
 
 /**
- *  Add an Website for a contact
- *
- * Allowed @params array keys are:
- * {@getfields website_create}
- * @example WebsiteCreate.php
- * {@example WebsiteCreate.php}
+ * Add an Website for a contact.
  *
  * @param array $params
  *
  * @return array
- *   Array of newly created website property values.
- * @access public
+ *   API result array.
  * @todo convert to using basic create - BAO function non-std
  */
 function civicrm_api3_website_create($params) {
@@ -57,32 +46,31 @@ function civicrm_api3_website_create($params) {
   $websiteBAO = CRM_Core_BAO_Website::add($params);
   $values = array();
   _civicrm_api3_object_to_array($websiteBAO, $values[$websiteBAO->id]);
-  return civicrm_api3_create_success($values, $params, 'website', 'get');
+  return civicrm_api3_create_success($values, $params, 'Website', 'get');
 }
 
 /**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
+ *
+ * The metadata is used for setting defaults, documentation & validation.
  *
- * The metadata is used for setting defaults, documentation & validation
  * @param array $params
- *   Array or parameters determined by getfields.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_website_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
 }
 
 /**
- * Deletes an existing Website
+ * Deletes an existing Website.
+ *
+ * @todo convert to using Basic delete - BAO function non standard
  *
  * @param array $params
- * {@getfields website_delete}
+ *
  * @return array
  *   API result
  * @throws \API_Exception
- * @example WebsiteDelete.php Std Delete Example
- *
- * @access public
- * @todo convert to using Basic delete - BAO function non standard
  */
 function civicrm_api3_website_delete($params) {
   //DO NOT USE THIS FUNCTION AS THE BASIS FOR A NEW API http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards
@@ -93,29 +81,22 @@ function civicrm_api3_website_delete($params) {
   if ($websiteDAO->find()) {
     while ($websiteDAO->fetch()) {
       $websiteDAO->delete();
-      return civicrm_api3_create_success(1, $params, 'website', 'delete');
+      return civicrm_api3_create_success(1, $params, 'Website', 'delete');
     }
   }
   else {
-    throw new API_Exception('Could not delete website with id ' . $websiteID);
+    throw new API_Exception('Could not delete Website with id ' . $websiteID);
   }
 }
 
 /**
- * Retrieve one or more websites
+ * Retrieve one or more websites.
  *
- * @param mixed[] (reference ) input parameters
- * {@getfields website_get}
- * {@example WebsiteGet.php 0}
- * @example WebsiteGet.php
  * @param array $params
- *   An associative array of name/value pairs.
  *
  * @return array
  *   details of found websites
- *
- * @access public
  */
 function civicrm_api3_website_get($params) {
-  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'website');
+  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, TRUE, 'Website');
 }