projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
CRM-15856 - Mailing BAO - Only validate tokens when calling through API
[civicrm-core.git]
/
api
/
v3
/
ContributionPage.php
diff --git
a/api/v3/ContributionPage.php
b/api/v3/ContributionPage.php
index 4f510d9f3b4c5103403af77b054352cbef625e09..ddf9b344fb0395ae361fd04233fafbcbd648c396 100644
(file)
--- a/
api/v3/ContributionPage.php
+++ b/
api/v3/ContributionPage.php
@@
-27,24
+27,19
@@
/**
/**
- *
File for the CiviCRM APIv3 group functions
+ *
This api exposes CiviCRM contribution pages.
*
* @package CiviCRM_APIv3
*
* @package CiviCRM_APIv3
- * @subpackage API_ContributionPage
- * @copyright CiviCRM LLC (c) 20042012
*/
/**
*/
/**
- * Create or update a contribution_page
+ * Create or update a contribution_page
.
*
* @param array $params
*
* @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
*
* @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);
*/
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
* @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;
*/
function _civicrm_api3_contribution_page_create_spec(&$params) {
$params['financial_type_id']['api.required'] = 1;
@@
-67,50
+63,42
@@
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 contribution_pages
matching a set of one or more group properties.
*
* @param array $params
*
* @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
*
* @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);
}
/**
*/
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 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
*
* @param array $params
*
* This method is used to delete any existing contribution_page. id of the group
* to be deleted is required field in $params array
*
* @param array $params
- * Array containing id of the group.
- * to be deleted
+ * Array per getfields metadata.
*
* @return array
* API result Array
*
* @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);
}
/**
*/
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 contribution_page.
*
* @param array $params
*
* @param array $params
- * (reference) array containing id of the group.
- * to be deleted
+ * Array per getfields metadata.
*
* @return array
* API result array
*
* @return array
* API result array
- * {@getfields contribution_page_delete}
*/
function civicrm_api3_contribution_page_submit($params) {
$result = CRM_Contribute_Form_Contribution_Confirm::submit($params);
*/
function civicrm_api3_contribution_page_submit($params) {
$result = CRM_Contribute_Form_Contribution_Confirm::submit($params);