X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMembershipBlock.php;h=c2d0ca450f3874c1b6edb1c1f81885f980160631;hb=af3775b322b9e4f11d097067367f0ea7763f5f10;hp=ed21a65ff6fe6ee929191633c56db2fd12101414;hpb=6ce4af3b24412a26d866718fc4030ed74e66d1ac;p=civicrm-core.git diff --git a/api/v3/MembershipBlock.php b/api/v3/MembershipBlock.php index ed21a65ff6..c2d0ca450f 100644 --- a/api/v3/MembershipBlock.php +++ b/api/v3/MembershipBlock.php @@ -26,24 +26,19 @@ */ /** - * File for the CiviCRM APIv3 membership type functions + * This api exposes CiviCRM MembershipBlock records. * * @package CiviCRM_APIv3 - * @subpackage API_Membership - * - * @copyright CiviCRM LLC (c) 2004-2014 - * @version $Id: MembershipBlock.php 30171 2010-10-14 09:11:27Z mover $ - * */ /** - * API to Create or update a Membership Type + * API to Create or update a MembershipBlock. * * @param array $params - * An associative array of name/value property values of civicrm_membership_block. + * An associative array of name/value property values of MembershipBlock. * * @return array - * newly created or updated membership type property values. + * newly created or updated membership block property values. */ function civicrm_api3_membership_block_create($params) { return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params); @@ -55,7 +50,7 @@ function civicrm_api3_membership_block_create($params) { * The metadata is used for setting defaults, documentation & validation. * * @param array $params - * Array or parameters determined by getfields. + * Array of parameters determined by getfields. */ function _civicrm_api3_membership_block_create_spec(&$params) { $params['is_active']['api.default'] = TRUE; @@ -64,9 +59,9 @@ function _civicrm_api3_membership_block_create_spec(&$params) { } /** - * Get a Membership Type. + * Get a Membership Block. * - * This api is used for finding an existing membership type. + * This api is used for finding an existing membership block. * * @param array $params * An associative array of name/value property values of civicrm_membership_block. @@ -80,10 +75,10 @@ function civicrm_api3_membership_block_get($params) { } /** - * Deletes an existing membership type + * Deletes an existing membership block. * - * This API is used for deleting a membership type - * Required parameters : id of a membership type + * This API is used for deleting a membership block + * Required parameters : id of a membership block * * @param array $params *