projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge remote-tracking branch 'origin/4.5' into 4.5-master-2015-02-24-17-24-05
[civicrm-core.git]
/
api
/
v3
/
PriceFieldValue.php
diff --git
a/api/v3/PriceFieldValue.php
b/api/v3/PriceFieldValue.php
index 9161af4870ecc6098fd81ce2b51fff65cc6f45dd..37a93741d375e1d7c30cc5d3d23a248da33bfe20 100644
(file)
--- a/
api/v3/PriceFieldValue.php
+++ b/
api/v3/PriceFieldValue.php
@@
-27,17
+27,19
@@
/**
/**
- * This api exposes CiviCRM price sets.
+ * This api exposes CiviCRM price field values.
+ *
+ * PriceFields may contain zero or more PriceFieldValues.
+ * Use chaining to create PriceFields and values in one api call.
*
* @package CiviCRM_APIv3
*
* @package CiviCRM_APIv3
- * @subpackage API_PriceFieldValue
*/
/**
*/
/**
- * Create or update a
price_field_v
alue.
+ * Create or update a
PriceFieldV
alue.
*
* @param array $params
*
* @param array $params
- * name/value pairs to insert in new '
price_field_v
alue'
+ * name/value pairs to insert in new '
PriceFieldV
alue'
*
* @return array
* API result array.
*
* @return array
* API result array.
@@
-52,7
+54,7
@@
function civicrm_api3_price_field_value_create($params) {
$values = array();
_civicrm_api3_object_to_array($bao, $values[$bao->id]);
$values = array();
_civicrm_api3_object_to_array($bao, $values[$bao->id]);
- return civicrm_api3_create_success($values, $params, '
price_field_v
alue', 'create', $bao);
+ return civicrm_api3_create_success($values, $params, '
PriceFieldV
alue', 'create', $bao);
}
}
@@
-62,7
+64,7
@@
function civicrm_api3_price_field_value_create($params) {
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
* The metadata is used for setting defaults, documentation & validation.
*
* @param array $params
- * Array o
r
parameters determined by getfields.
+ * Array o
f
parameters determined by getfields.
*/
function _civicrm_api3_price_field_value_create_spec(&$params) {
$params['price_field_id']['api.required'] = TRUE;
*/
function _civicrm_api3_price_field_value_create_spec(&$params) {
$params['price_field_id']['api.required'] = TRUE;
@@
-72,7
+74,7
@@
function _civicrm_api3_price_field_value_create_spec(&$params) {
}
/**
}
/**
- * Returns array of
price_field_v
alues matching a set of one or more group properties.
+ * Returns array of
PriceFieldV
alues matching a set of one or more group properties.
*
* @param array $params
* Array of one or more valid property_name=>value pairs. If $params is set.
*
* @param array $params
* Array of one or more valid property_name=>value pairs. If $params is set.
@@
-86,14
+88,12
@@
function civicrm_api3_price_field_value_get($params) {
}
/**
}
/**
- * Delete an existing
price_field_v
alue.
+ * Delete an existing
PriceFieldV
alue.
*
*
- * This method is used to delete any existing price_field_value. id of the group
- * to be deleted is required field in $params array
+ * This method is used to delete any existing PriceFieldValue given its id.
*
* @param array $params
*
* @param array $params
- * Array containing id of the group.
- * to be deleted
+ * Array containing id of the group to be deleted.
*
* @return array
* API result array.
*
* @return array
* API result array.