INFRA-132 - Batch 14 (g)

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

diff --git a/api/v3/MembershipStatus.php b/api/v3/MembershipStatus.php
index 23752ce5d84d85e73c360f3b3d323aa3ffcf872a..da355eef6c3e0ce9d69b5d964e7cb4f52034677d 100644 (file)
--- a/api/v3/MembershipStatus.php
+++ b/api/v3/MembershipStatus.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 creating a Membership Status
  *
- * @param   array  $params  an associative array of name/value property values of civicrm_membership_status
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership_status.
  *
- * @return array of newly created membership status property values.
+ * @return array
+ *   Array of newly created membership status property values.
  * {@getfields MembershipStatus_create}
- * @access public
  */
 function civicrm_api3_membership_status_create($params) {
   return _civicrm_api3_basic_create(_civicrm_api3_get_BAO(__FUNCTION__), $params);
@@ -57,11 +57,12 @@ function civicrm_api3_membership_status_create($params) {
  *
  * This api is used for finding an existing membership status.
  *
- * @param  array $params  an associative array of name/value property values of civicrm_membership_status
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership_status.
  *
- * @return  Array of all found membership status property values.
+ * @return array
+ *   Array of all found membership status property values.
  * {@getfields MembershipStatus_get}
- * @access public
  */
 function civicrm_api3_membership_status_get($params) {
   return _civicrm_api3_basic_get('CRM_Member_BAO_MembershipStatus', $params);
@@ -73,11 +74,12 @@ function civicrm_api3_membership_status_get($params) {
  * This api is used for updating an existing membership status.
  * Required parameters : id of a membership status
  *
- * @param  Array   $params  an associative array of name/value property values of civicrm_membership_status
+ * @param array $params
+ *   An associative array of name/value property values of civicrm_membership_status.
  * @deprecated - should just use create
  *
- * @return array of updated membership status property values
- * @access public
+ * @return array
+ *   Array of updated membership status property values
  */
 function &civicrm_api3_membership_status_update($params) {
 
@@ -114,11 +116,8 @@ function &civicrm_api3_membership_status_update($params) {
  *
  * This API is used for deleting a membership status
  *
- * @param  array  Params array containing 'id' -    Id of the membership status to be deleted
- * {@getfields MembershipStatus_delete}
- *
- * @return array i
- * @access public
+ * @param array $params
+ * @return array
  */
 function civicrm_api3_membership_status_delete($params) {
 
@@ -132,11 +131,12 @@ function civicrm_api3_membership_status_delete($params) {
  * This API is used for deriving Membership Status of a given Membership
  * record using the rules encoded in the membership_status table.
  *
- * @param $membershipParams
+ * @param array $membershipParams
  *
  * @throws API_Exception
  *
- * @return Array  Array of status id and status name
+ * @return Array
+ *   Array of status id and status name
  * @public
  */
 function civicrm_api3_membership_status_calc($membershipParams) {
@@ -144,7 +144,7 @@ function civicrm_api3_membership_status_calc($membershipParams) {
     throw new API_Exception('membershipParams do not contain membership_id');
   }
 
-  if(empty($membershipParams['id'])) {
+  if (empty($membershipParams['id'])) {
     //for consistency lets make sure id is set as this will get passed to hooks downstream
     $membershipParams['id'] = $membershipID;
   }
@@ -171,4 +171,3 @@ SELECT start_date, end_date, join_date, membership_type_id
   $dao->free();
   return $result;
 }
-