<?php
/**
- * @param $params
+ * Get option groups.
+ *
+ * @param array $params
*
* @return 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'
*
- * @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);
}
/**
- * Adjust Metadata for Create action
+ * Adjust Metadata for Create action.
*
- * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * The metadata is used for setting defaults, documentation & validation.
+ *
+ * @param array $params
+ * Array or parameters determined by getfields.
*/
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
*
- * @param array $params (reference) array containing id of the group
+ * @param array $params
+ * Array containing id of the group.
* to be deleted
*
- * @return array (reference) returns flag true if successfull, error
- * 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);