Merge pull request #6704 from monishdeb/46-test-fix

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

diff --git a/api/v3/Membership.php b/api/v3/Membership.php
index 9e99405acd60808d17b3b90ae3a1bce6267b9cdb..9fc7ef29d005c62f4c35c8bf806fe6c2560c9c10 100644 (file)
--- a/api/v3/Membership.php
+++ b/api/v3/Membership.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.                                    |
  |                                                                    |
@@ -27,17 +27,13 @@
 
 /**
  *
- * File for the CiviCRM APIv3 membership contact functions
+ * This api exposes CiviCRM membership contact records.
  *
  * @package CiviCRM_APIv3
- * @subpackage API_Membership
- *
- * @copyright CiviCRM LLC (c) 2004-2014
- * @version $Id: MembershipContact.php 30171 2010-10-14 09:11:27Z mover $
  */
 
 /**
- * Deletes an existing contact membership.
+ * Deletes an existing contact Membership.
  *
  * @param array $params
  *   Array array holding id - Id of the contact membership to be deleted.
@@ -135,7 +131,7 @@ function civicrm_api3_membership_create($params) {
   $membership = array();
   _civicrm_api3_object_to_array($membershipBAO, $membership[$membershipBAO->id]);
 
-  return civicrm_api3_create_success($membership, $params, 'membership', 'create', $membershipBAO);
+  return civicrm_api3_create_success($membership, $params, 'Membership', 'create', $membershipBAO);
 
 }
 
@@ -145,7 +141,7 @@ function civicrm_api3_membership_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_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -154,10 +150,13 @@ function _civicrm_api3_membership_create_spec(&$params) {
   $params['membership_type_id']['api.aliases'] = array('membership_type');
   $params['status_id']['api.aliases'] = array('membership_status');
   $params['skipStatusCal'] = array(
-    'title' => 'Skip status calculation. By default this is 0 if id is not set and 1 if it is set.',
+    'title' => 'Skip status calculation',
+    'description' => 'By default this is 0 if id is not set and 1 if it is set.',
+    'type' => CRM_Utils_Type::T_BOOLEAN,
   );
   $params['num_terms'] = array(
-    'title' => 'Number of terms to add/renew. If this parameter is passed, dates will be calculated automatically. If no id is passed (new membership) and no dates are given, num_terms will be assumed to be 1.',
+    'title' => 'Number of terms',
+    'description' => 'Terms to add/renew. If this parameter is passed, dates will be calculated automatically. If no id is passed (new membership) and no dates are given, num_terms will be assumed to be 1.',
     'type' => CRM_Utils_Type::T_INT,
   );
 }
@@ -168,18 +167,19 @@ function _civicrm_api3_membership_create_spec(&$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_get_spec(&$params) {
   $params['membership_type_id']['api.aliases'] = array('membership_type');
   $params['active_only'] = array(
-    'title' => 'Only retrieve active memberships',
+    'title' => 'Active Only',
+    'description' => 'Only retrieve active memberships',
     'type' => CRM_Utils_Type::T_BOOLEAN,
   );
 }
 
 /**
- * Get contact membership record.
+ * Get contact Membership record.
  *
  * This api will return the membership records for the contacts
  * having membership based on the relationship with the direct members.
@@ -205,7 +205,7 @@ function civicrm_api3_membership_get($params) {
     $params['status_id'] = array('IN' => CRM_Member_BAO_MembershipStatus::getMembershipStatusCurrent());
   }
 
-  $options = _civicrm_api3_get_options_from_params($params, TRUE, 'membership', 'get');
+  $options = _civicrm_api3_get_options_from_params($params, TRUE, 'Membership', 'get');
   if ($options['is_count']) {
     return _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params);
   }
@@ -218,11 +218,11 @@ function civicrm_api3_membership_get($params) {
       && !array_key_exists('relationship_name', $return)
     )
     ) {
-    return civicrm_api3_create_success($membershipValues, $params, 'membership', 'get');
+    return civicrm_api3_create_success($membershipValues, $params, 'Membership', 'get');
   }
 
   $members = _civicrm_api3_membership_relationsship_get_customv2behaviour($params, $membershipValues, $contactID);
-  return civicrm_api3_create_success($members, $params, 'membership', 'get');
+  return civicrm_api3_create_success($members, $params, 'Membership', 'get');
 }
 
 /**