projects
/
civicrm-core.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
some more comment fixes
[civicrm-core.git]
/
api
/
v3
/
OptionGroup.php
diff --git
a/api/v3/OptionGroup.php
b/api/v3/OptionGroup.php
index e14f99b2581e1dfb8df4892719e596477a41c4fb..cfe6ed7a35f625e7472a5e18c746536902410efd 100644
(file)
--- a/
api/v3/OptionGroup.php
+++ b/
api/v3/OptionGroup.php
@@
-1,6
+1,8
@@
<?php
/**
<?php
/**
+ * Get option groups.
+ *
* @param array $params
*
* @return array
* @param array $params
*
* @return array
@@
-16,40
+18,43
@@
function civicrm_api3_option_group_get($params) {
* In case of updating existing survey, id of that particular survey must
* be in $params array.
*
* In case of updating existing survey, id of that particular survey must
* be in $params array.
*
- * @param array $params (reference) Associative array of property
+ * @param array $params
+ * (reference) Associative array of property.
* name/value pairs to insert in new 'survey'
*
* name/value pairs to insert in new 'survey'
*
- * @return array survey array
+ * @return array
+ * survey array
*
*
- * @access public
*/
function civicrm_api3_option_group_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}
/**
*/
function civicrm_api3_option_group_create($params) {
return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $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
+ *
@param array $params
+ *
Array or parameters determined by getfields.
*/
function _civicrm_api3_option_group_create_spec(&$params) {
$params['name']['api.unique'] = 1;
}
/**
*/
function _civicrm_api3_option_group_create_spec(&$params) {
$params['name']['api.unique'] = 1;
}
/**
- *
delete an existing Option Group
+ *
Delete an existing Option Group.
*
* This method is used to delete any existing Option Group. id of the group
* to be deleted is required field in $params array
*
*
* This method is used to delete any existing Option Group. id of the group
* to be deleted is required field in $params array
*
- * @param array $params array containing id of the group
+ * @param array $params
+ * Array containing id of the group.
* to be deleted
*
* to be deleted
*
- * @return array API Result Array
- * message otherwise
- * {@getfields OptionGroup_delete}
- * @access public
+ * @return array
+ * API Result Array
+ * {@getfields OptionGroup_delete}
*/
function civicrm_api3_option_group_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
*/
function civicrm_api3_option_group_delete($params) {
return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);