Merge pull request #3393 from monishdeb/upgrade-distmaker-fix

[civicrm-core.git] / CRM / Member / BAO / MembershipType.php

diff --git a/CRM/Member/BAO/MembershipType.php b/CRM/Member/BAO/MembershipType.php
index 80956abca72105cc140e93946a06f2fda0c35cbd..f68cc0f0710bcfaf100499fb9f81591037ac0bb1 100644 (file)
--- a/CRM/Member/BAO/MembershipType.php
+++ b/CRM/Member/BAO/MembershipType.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -108,7 +108,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
 
     $membershipType->id = CRM_Utils_Array::value('membershipType', $ids);
 
-    // $previousID is the old organization id for memberhip type i.e 'member_of_contact_id'. This is used when an oganization is changed.
+    // $previousID is the old organization id for membership type i.e 'member_of_contact_id'. This is used when an oganization is changed.
     $previousID = NULL;
     if ($membershipType->id) {
       $previousID = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType', $membershipType->id, 'member_of_contact_id');
@@ -129,6 +129,9 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
    * Function to delete membership Types
    *
    * @param int $membershipTypeId
+   *
+   * @throws CRM_Core_Exception
+   * @return bool|mixed
    * @static
    */
   static function del($membershipTypeId) {
@@ -223,7 +226,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /**
    * Function to get membership Types
    *
-   * @param int $membershipTypeId
+   * @param bool $public
+   *
+   * @return array
+   * @internal param int $membershipTypeId
    * @static
    */
   static function getMembershipTypes($public = TRUE) {
@@ -246,6 +252,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
    * Function to get membership Type Details
    *
    * @param int $membershipTypeId
+   *
+   * @return array|null
    * @static
    */
   static function getMembershipTypeDetails($membershipTypeId) {
@@ -267,10 +275,11 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /**
    * Function to calculate start date and end date for new membership
    *
-   * @param int  $membershipTypeId membership type id
+   * @param int $membershipTypeId membership type id
    * @param date $joinDate member since ( in mysql date format )
    * @param date $startDate start date ( in mysql date format )
-   * @param int  $numRenewTerms    how many membership terms are being added to end date (default is 1)
+   * @param null $endDate
+   * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
    *
    * @return array associated array with  start date, end date and join date for the membership
    * @static
@@ -457,6 +466,9 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
     $params            = array('id' => $membershipId);
     $membershipDetails = CRM_Member_BAO_Membership::getValues($params, $values);
     $statusID          = $membershipDetails[$membershipId]->status_id;
+    $membershipDates = array(
+      'join_date' => CRM_Utils_Date::customFormat($membershipDetails[$membershipId]->join_date, '%Y%m%d'),
+    );
 
     $oldPeriodType = CRM_Core_DAO::getFieldValue('CRM_Member_DAO_MembershipType',
         CRM_Core_DAO::getFieldValue('CRM_Member_DAO_Membership', $membershipId, 'membership_type_id'), 'period_type');
@@ -523,7 +535,6 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
           ));
       }
       $today = date('Y-m-d');
-      $membershipDates = array();
       $membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d');
       $membershipDates['start_date'] = CRM_Utils_Date::customFormat($startDate, '%Y%m%d');
       $membershipDates['end_date'] = CRM_Utils_Date::customFormat($endDate, '%Y%m%d');
@@ -538,7 +549,6 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
       $renewalDates = self::getDatesForMembershipType($membershipTypeDetails['id'],
         $today, NULL, NULL, $numRenewTerms
       );
-      $membershipDates = array();
       $membershipDates['today'] = CRM_Utils_Date::customFormat($today, '%Y%m%d');
       $membershipDates['start_date'] = $renewalDates['start_date'];
       $membershipDates['end_date'] = $renewalDates['end_date'];
@@ -591,10 +601,14 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
     return $memTypeOrgs;
   }
 
-  /** The function returns all the Organization for  all membershiptypes .
-   *  @param  array      $allmembershipTypes       array of allMembershipTypes
-   *  with organization id Key - value pairs.
+  /**
+   * The function returns all the Organization for  all membershiptypes .
+   *
+   * @param null $membershipTypeId
    *
+   * @return array
+   * @internal param array $allmembershipTypes array of allMembershipTypes
+   *  with organization id Key - value pairs.
    */
   static function getMembershipTypeOrganization($membershipTypeId = NULL) {
     $allmembershipTypes = array();
@@ -640,6 +654,12 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   }
 
 
+  /**
+   * @param $params
+   * @param $ids
+   * @param $previousID
+   * @param $membershipTypeId
+   */
   public static function createMembershipPriceField($params, $ids, $previousID, $membershipTypeId) {
 
     $priceSetId = CRM_Core_DAO::getFieldValue('CRM_Price_DAO_PriceSet', 'default_membership_type_amount', 'id', 'name');