X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=api%2Fv3%2FMembership.php;h=dfc3ca78d710c79c8d2fd393daf6fa312b18899f;hb=a1a2a83db067ec5444f056ad3fa00e85fdc176ec;hp=1893186bdf72e06498e9d9055179c523a9d7300c;hpb=87d422669cee2e65706fe72821613ad846cd0adb;p=civicrm-core.git

diff --git a/api/v3/Membership.php b/api/v3/Membership.php
index 1893186bdf..dfc3ca78d7 100644
--- a/api/v3/Membership.php
+++ b/api/v3/Membership.php
@@ -1,8 +1,7 @@
 <?php
-
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                                |
+ | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -42,11 +41,12 @@
  *
  * This API is used for deleting a contact membership
  *
- * @param  $params array  array holding id - Id of the contact membership to be deleted
+ * @param array $params
+ *   Array array holding id - Id of the contact membership to be deleted.
  *
- * @return array api result
- * {@getfields membership_delete}
- * @access public
+ * @return array
+ *   api result
+ *   {@getfields membership_delete}
  */
 function civicrm_api3_membership_delete($params) {
   return _civicrm_api3_basic_delete(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -58,11 +58,12 @@ function civicrm_api3_membership_delete($params) {
  * 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
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership.
  *
- * @return array of newly created membership property values.
- * {@getfields membership_create}
- * @access public
+ * @return array
+ *   Array of newly created membership property values.
+ *   {@getfields membership_create}
  */
 function civicrm_api3_membership_create($params) {
   // check params for membership id during update
@@ -111,10 +112,10 @@ function civicrm_api3_membership_create($params) {
   // Fixme: This code belongs in the BAO
   $action = CRM_Core_Action::ADD;
   // we need user id during add mode
-    $ids = array ();
-    if (!empty($params['contact_id'])) {
-      $ids['userId'] = $params['contact_id'];
-    }
+  $ids = array();
+  if (!empty($params['contact_id'])) {
+    $ids['userId'] = $params['contact_id'];
+  }
   //for edit membership id should be present
   if (!empty($params['id'])) {
     $ids['membership'] = $params['id'];
@@ -146,7 +147,8 @@ function civicrm_api3_membership_create($params) {
  * Adjust Metadata for Create action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_membership_create_spec(&$params) {
   $params['contact_id']['api.required'] = 1;
@@ -155,7 +157,7 @@ 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. By default this is 0 if id is not set and 1 if it is set.',
   );
   $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.',
@@ -166,7 +168,8 @@ function _civicrm_api3_membership_create_spec(&$params) {
  * Adjust Metadata for Get action
  *
  * The metadata is used for setting defaults, documentation & validation
- * @param array $params array or parameters determined by getfields
+ * @param array $params
+ *   Array or parameters determined by getfields.
  */
 function _civicrm_api3_membership_get_spec(&$params) {
   $params['membership_type_id']['api.aliases'] = array('membership_type');
@@ -178,14 +181,13 @@ function _civicrm_api3_membership_get_spec(&$params) {
  * This api will return the membership records for the contacts
  * having membership based on the relationship with the direct members.
  *
- * @param  Array $params key/value pairs for contact_id and some
+ * @param array $params
+ *   Key/value pairs for contact_id and some.
  *          options affecting the desired results; has legacy support
  *          for just passing the contact_id itself as the argument
  *
- * @return  Array of all found membership property values.
- * @access public
- * @todo needs some love - basically only a get for a given contact right now
- * {@getfields membership_get}
+ * @return array
+ *   Array of all found membership property values.
  */
 function civicrm_api3_membership_get($params) {
   $activeOnly = $membershipTypeId = $membershipType = NULL;
@@ -200,14 +202,14 @@ 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);
   }
   $membershipValues = _civicrm_api3_basic_get(_civicrm_api3_get_BAO(__FUNCTION__), $params, FALSE, 'Membership');
 
   $return = $options['return'];
-  if(empty($membershipValues) ||
+  if (empty($membershipValues) ||
     (!empty($return)
       && !array_key_exists('related_contact_id', $return)
       && !array_key_exists('relationship_name', $return)
@@ -216,7 +218,7 @@ function civicrm_api3_membership_get($params) {
     return civicrm_api3_create_success($membershipValues, $params, 'membership', 'get');
   }
 
-  $members =  _civicrm_api3_membership_relationsship_get_customv2behaviour($params, $membershipValues, $contactID );
+  $members = _civicrm_api3_membership_relationsship_get_customv2behaviour($params, $membershipValues, $contactID);
   return civicrm_api3_create_success($members, $params, 'membership', 'get');
 }
 
@@ -227,11 +229,13 @@ function civicrm_api3_membership_get($params) {
  * is passed in as part of the reasonable expectation developers have that we will keep the api
  * as stable as possible
  *
- * @param array $params parameters passed into get function
+ * @param array $params
+ *   Parameters passed into get function.
  * @param int $membershipTypeId
  * @param $activeOnly
  *
- * @return array result for calling function
+ * @return array
+ *   result for calling function
  */
 function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTypeId, $activeOnly) {
   // get the membership for the given contact ID
@@ -248,11 +252,13 @@ function _civicrm_api3_membership_get_customv2behaviour(&$params, $membershipTyp
 /**
  * non-standard behaviour inherited from v2
  *
- * @param array $params parameters passed into get function
+ * @param array $params
+ *   Parameters passed into get function.
  * @param $membershipValues
  * @param int $contactID
  *
- * @return array result for calling function
+ * @return array
+ *   result for calling function
  */
 function _civicrm_api3_membership_relationsship_get_customv2behaviour(&$params, $membershipValues, $contactID) {
   $relationships = array();