Merge pull request #5086 from deepak-srivastava/CRM-15490

[civicrm-core.git] / api / v3 / OptionGroup.php

<?php

/**
 * Get option groups.
 *
 * @param array $params
 *
 * @return array
 */
function civicrm_api3_option_group_get($params) {
  return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * Create/update option group.
 *
 * @param array $params
 *   Array per getfields metadata.
 *
 * @return array
 */
function civicrm_api3_option_group_create($params) {
  return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}

/**
 * Adjust Metadata for Create action.
 *
 * 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.
 *
 * 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.
 *                       to be deleted
 *
 * @return array
 *   API Result Array
 */
function civicrm_api3_option_group_delete($params) {
  return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
}