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 5c68330cb520809a88ea15b6362dc39117c24c7f..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.                                    |
  |                                                                    |
@@ -27,15 +27,13 @@
 
 
 /**
- * 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
  *   Array per getfields metadata.
@@ -65,7 +63,7 @@ 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 per getfields metadata.
@@ -78,10 +76,9 @@ function civicrm_api3_contribution_page_get($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 per getfields metadata.
@@ -94,7 +91,7 @@ function civicrm_api3_contribution_page_delete($params) {
 }
 
 /**
- * Submit a contribution_page.
+ * Submit a ContributionPage.
  *
  * @param array $params
  *   Array per getfields metadata.
@@ -104,5 +101,5 @@ function civicrm_api3_contribution_page_delete($params) {
  */
 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');
 }