Merge pull request #3393 from monishdeb/upgrade-distmaker-fix
[civicrm-core.git] / CRM / Member / BAO / MembershipType.php
index a9ac9bf2a82adce67b8bea785b8e00cffcb921c8..f68cc0f0710bcfaf100499fb9f81591037ac0bb1 100644 (file)
@@ -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
@@ -592,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();
@@ -641,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');