X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;ds=sidebyside;f=api%2Fv3%2FPremium.php;h=52827ccc1e38c555119cbbcc482c7ab3e9a505f1;hb=b081365f52508bfd1fb0d3d15f3a0d48f5e9df12;hp=ca1bdda2d04425ded38ad70cf399bbf4559f3d9d;hpb=fa84149cbbbbba2df1bd65c29522a28507dd83a2;p=civicrm-core.git diff --git a/api/v3/Premium.php b/api/v3/Premium.php index ca1bdda2d0..52827ccc1e 100644 --- a/api/v3/Premium.php +++ b/api/v3/Premium.php @@ -23,71 +23,55 @@ | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ -*/ + */ /** - * File for the CiviCRM APIv3 premium functions + * This api exposes CiviCRM premium. * * @package CiviCRM_APIv3 - * @subpackage API_premium - * */ /** - * Save a premium - * - * Allowed @params array keys are: - * {@getfields premium_create} - * @example premiumCreate.php + * Save a premium. * * @param array $params * * @throws API_Exception * @return array * Array of newly created premium property values. - * @access public */ function civicrm_api3_premium_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * Get a premium - * - * Allowed @params array keys are: - * {@getfields premium_get} - * @example premiumCreate.php + * Get a premium. * * @param array $params * * @return array * Array of retrieved premium property values. - * @access public */ function civicrm_api3_premium_get($params) { return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * Delete a premium - * - * Allowed @params array keys are: - * {@getfields premium_delete} - * @example premiumCreate.php + * Delete a premium. * * @param array $params * * @throws API_Exception * @return array * Array of deleted values. - * @access public */ function civicrm_api3_premium_delete($params) { return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params); } /** - * return field specification specific to get requests + * Return field specification specific to get requests. + * * @param array $params */ function _civicrm_api3_premium_get_spec(&$params) { @@ -95,7 +79,8 @@ function _civicrm_api3_premium_get_spec(&$params) { } /** - * return field specification specific to create requests + * Return field specification specific to create requests. + * * @param array $params */ function _civicrm_api3_premium_create_spec(&$params) {