X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMembership.php;h=9fc7ef29d005c62f4c35c8bf806fe6c2560c9c10;hb=bfe714ea5b2826b5b38c929ebf341b3d1d9aa29a;hp=dfc3ca78d710c79c8d2fd393daf6fa312b18899f;hpb=17d83a01db1059f95af45e3bd8898e353e52c02c;p=civicrm-core.git

diff --git a/api/v3/Membership.php b/api/v3/Membership.php
index dfc3ca78d7..9fc7ef29d0 100644
--- 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,49 +27,41 @@
 
 /**
  *
- * 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
- *
- * This API is used for deleting a contact membership
+ * Deletes an existing contact Membership.
  *
  * @param array $params
  *   Array array holding id - Id of the contact membership to be deleted.
  *
  * @return array
- *   api result
- *   {@getfields membership_delete}
+ *   API result array.
  */
 function civicrm_api3_membership_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
 }
 
 /**
- * Create a Contact Membership
+ * Create a Contact Membership.
  *
  * This API is used for creating a Membership for a contact.
  * Required parameters : membership_type_id and status_id.
  *
  * @param array $params
- *   An associative array of name/value property values of civicrm_membership.
+ *   Array of name/value property values of civicrm_membership.
  *
  * @return array
- *   Array of newly created membership property values.
- *   {@getfields membership_create}
+ *   API result array.
  */
 function civicrm_api3_membership_create($params) {
   // check params for membership id during update
   if (!empty($params['id']) && !isset($params['skipStatusCal'])) {
-    //don't calculate status on exisiting membership - expect API use to pass them in
-    // or leave unchanged
+    // Don't calculate status on existing membership - expect API use to pass them in
+    // or leave unchanged.
     $params['skipStatusCal'] = 1;
   }
   else {
@@ -139,16 +131,17 @@ 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);
 
 }
 
 /**
- * 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_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -157,26 +150,36 @@ 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,
   );
 }
+
 /**
- * Adjust Metadata for Get action
+ * Adjust Metadata for Get 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_get_spec(&$params) {
   $params['membership_type_id']['api.aliases'] = array('membership_type');
+  $params['active_only'] = array(
+    '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.
@@ -202,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);
   }
@@ -215,14 +218,16 @@ 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');
 }
 
 /**
+ * Perform api v2 custom behaviour.
+ *
  * When we copied apiv3 from api v2 we brought across some custom behaviours - in the case of
  * membership a complicated return array is constructed. The original
  * behaviour made contact_id a required field. We still need to keep this for v3 when contact_id
@@ -250,7 +255,7 @@ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTyp
 
 
 /**
- * non-standard behaviour inherited from v2
+ * Non-standard behaviour inherited from v2.
  *
  * @param array $params
  *   Parameters passed into get function.
@@ -284,7 +289,7 @@ function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params,
 
   $members = $membershipValues;
 
-  // populating contacts in members array based on their relationship with direct members.
+  // Populating contacts in members array based on their relationship with direct members.
   if (!empty($relationships)) {
     foreach ($relationships as $relTypeId => $membershipId) {
       // As members are not direct members, there should not be