--CRM-16187, fixed jenkin warnings

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

diff --git a/api/v3/MembershipType.php b/api/v3/MembershipType.php
index 1fe6772f5690bf29a4c905a84588653d741ce4c0..cb3ab53674d19a5b7b14314e26c11b7700a6c738 100644 (file)
--- a/api/v3/MembershipType.php
+++ b/api/v3/MembershipType.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -26,35 +26,31 @@
  */
 
 /**
- * File for the CiviCRM APIv3 membership type functions
+ * This api exposes CiviCRM membership type.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Membership
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: MembershipType.php 30171 2010-10-14 09:11:27Z mover $
- *
  */
 
 /**
- * API to Create or update a Membership Type
+ * API to Create or update a Membership Type.
  *
  * @param array $params
- *   An associative array of name/value property values of civicrm_membership_type.
+ *   Array of name/value property values of civicrm_membership_type.
  *
  * @return array
- *   newly created or updated membership type property values.
+ *   API result array.
  */
 function civicrm_api3_membership_type_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params, 'Membership_type');
 }
 
 /**
- * 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.
+ *   Array of parameters determined by getfields.
  */
 function _civicrm_api3_membership_type_create_spec(&$params) {
   // todo could set default here probably
@@ -64,6 +60,7 @@ function _civicrm_api3_membership_type_create_spec(&$params) {
   $params['name']['api.required'] = 1;
   $params['duration_unit']['api.required'] = 1;
   $params['duration_interval']['api.required'] = 1;
+  $params['is_active']['api.default'] = 1;
 }
 
 /**
@@ -72,26 +69,22 @@ function _civicrm_api3_membership_type_create_spec(&$params) {
  * This api is used for finding an existing membership type.
  *
  * @param array $params
- *   An associative array of name/value property values of civicrm_membership_type.
- * {getfields MembershipType_get}
+ *   Array of name/value property values of civicrm_membership_type.
  *
  * @return array
- *   Array of all found membership type property values.
+ *   API result array.
  */
 function civicrm_api3_membership_type_get($params) {
   return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Deletes an existing membership type
- *
- * This API is used for deleting a membership type
- * Required parameters : id of a membership type
+ * Deletes an existing membership type.
  *
  * @param array $params
  *
- * @return bool
- *   true if success, else false
+ * @return array
+ *   API result array.
  */
 function civicrm_api3_membership_type_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);