CRM-16173 - WhitelistSubscriber - Filtering for API requests (entity/action/params)

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

diff --git a/api/v3/ContributionPage.php b/api/v3/ContributionPage.php
index bc2b5e6c416aa85fa4f0a3c59e858da0c987f1ef..8c9af557f6f771c849eb4b9de4a9c8918e43eb83 100644 (file)
--- a/api/v3/ContributionPage.php
+++ b/api/v3/ContributionPage.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,28 +23,23 @@
  | 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 group functions
+ * This api exposes CiviCRM contribution pages.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_ContributionPage
- * @copyright CiviCRM LLC (c) 20042012
  */
 
 /**
- * Create or update a contribution_page
+ * Create or update a ContributionPage.
  *
  * @param array $params
- *   Associative array of property.
- *                       name/value pairs to insert in new 'contribution_page'
- * @example ContributionPageCreate.php Std Create example
+ *   Array per getfields metadata.
  *
  * @return array
  *   api result array
- *   {@getfields contribution_page_create}
  */
 function civicrm_api3_contribution_page_create($params) {
   $result = _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -54,11 +49,12 @@ function civicrm_api3_contribution_page_create($params) {
 }
 
 /**
- * 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 per getfields metadata.
  */
 function _civicrm_api3_contribution_page_create_spec(&$params) {
   $params['financial_type_id']['api.required'] = 1;
@@ -67,52 +63,43 @@ function _civicrm_api3_contribution_page_create_spec(&$params) {
 }
 
 /**
- * Returns array of contribution_pages  matching a set of one or more group properties
+ * Returns array of ContributionPage(s) matching a set of one or more group properties.
  *
  * @param array $params
- *   Array of one or more valid property_name=>value pairs.
+ *   Array per getfields metadata.
  *
  * @return array
  *   API Result array Array of matching contribution_pages
- *   {@getfields contribution_page_get}
  */
 function civicrm_api3_contribution_page_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * delete an existing contribution_page
+ * Delete an existing ContributionPage.
  *
- * This method is used to delete any existing contribution_page. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing ContributionPage given its id.
  *
  * @param array $params
- *   Array containing id of the group.
- *                       to be deleted
+ *   Array per getfields metadata.
  *
  * @return array
  *   API result Array
- *   {@getfields contribution_page_delete}
  */
 function civicrm_api3_contribution_page_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * delete an existing contribution_page
- *
- * This method is used to delete any existing contribution_page. id of the group
- * to be deleted is required field in $params array
+ * Submit a ContributionPage.
  *
  * @param array $params
- *   (reference) array containing id of the group.
- *                       to be deleted
+ *   Array per getfields metadata.
  *
  * @return array
  *   API result array
- *   {@getfields contribution_page_delete}
  */
 function civicrm_api3_contribution_page_submit($params) {
   $result = CRM_Contribute_Form_Contribution_Confirm::submit($params);
-  return civicrm_api3_create_success($result, $params, 'contribution_page', 'submit');
+  return civicrm_api3_create_success($result, $params, 'ContributionPage', 'submit');
 }