Merge pull request #4866 from totten/master-phpcs
[civicrm-core.git] / CRM / Member / BAO / MembershipType.php
index 530b28927df19109f106b86cd6ab4f06d4b677d8..d09f7d727403cec293332783eaa9815f6cba3825 100644 (file)
@@ -51,8 +51,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /**
    * Fetch object based on array of properties
    *
-   * @param array $params   (reference ) an assoc array of name/value pairs
-   * @param array $defaults (reference ) an assoc array to hold the flattened values
+   * @param array $params
+   *   (reference ) an assoc array of name/value pairs.
+   * @param array $defaults
+   *   (reference ) an assoc array to hold the flattened values.
    *
    * @return CRM_Member_BAO_MembershipType object
    * @static
@@ -70,8 +72,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /**
    * Update the is_active flag in the db
    *
-   * @param int      $id        id of the database record
-   * @param boolean  $is_active value we want to set the is_active field
+   * @param int $id
+   *   Id of the database record.
+   * @param bool $is_active
+   *   Value we want to set the is_active field.
    *
    * @return Object             DAO object on sucess, null otherwise
    * @static
@@ -83,8 +87,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /**
    * Add the membership types
    *
-   * @param array $params reference array contains the values submitted by the form
-   * @param array $ids array contains the id (deprecated)
+   * @param array $params
+   *   Reference array contains the values submitted by the form.
+   * @param array $ids
+   *   Array contains the id (deprecated).
    *
    * @static
    *
@@ -188,7 +194,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /**
    * Convert membership Type's 'start day' & 'rollover day' to human readable formats.
    *
-   * @param array $membershipType an array of membershipType-details.
+   * @param array $membershipType
+   *   An array of membershipType-details.
    * @static
    */
   public static function convertDayFormat(&$membershipType) {
@@ -277,11 +284,15 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /**
    * Calculate start date and end date for new membership
    *
-   * @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 $membershipTypeId
+   *   Membership type id.
+   * @param date $joinDate
+   *   Member since ( in mysql date format ).
+   * @param date $startDate
+   *   Start date ( in mysql date format ).
    * @param null $endDate
-   * @param int $numRenewTerms how many membership terms are being added to end date (default is 1)
+   * @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
@@ -382,8 +393,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
         // Check if we are on or after rollover day of the month - CRM-10585
         // If so, set fixed_period_rollover TRUE so we increment end_date month below.
         $dateParts = explode('-', $actualStartDate);
-        if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']){
-          $fixed_period_rollover = True;
+        if ($dateParts[2] >= $membershipTypeDetails['fixed_period_rollover_day']) {
+          $fixed_period_rollover = TRUE;
         }
 
         // Start date is always first day of actualStartDate month
@@ -456,8 +467,10 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
    *
    * @param int $membershipId
    * @param $changeToday
-   * @param int $membershipTypeID - if provided, overrides the membership type of the $membershipID membership
-   * @param int  $numRenewTerms    how many membership terms are being added to end date (default is 1)
+   * @param int $membershipTypeID
+   *   If provided, overrides the membership type of the $membershipID membership.
+   * @param int $numRenewTerms
+   *   How many membership terms are being added to end date (default is 1).
    *
    * CRM-7297 Membership Upsell - Added $membershipTypeID param to facilitate calculations of dates when membership type changes
    *
@@ -497,7 +510,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
       $date  = explode('-', $date);
       $logStartDate = date('Y-m-d', mktime(0, 0, 0,
           (double) $date[1],
-          (double)($date[2] + 1),
+          (double) ($date[2] + 1),
           (double) $date[0]
         ));
 
@@ -509,12 +522,13 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
       switch ($membershipTypeDetails['duration_unit']) {
         case 'year':
           //need to check if the upsell is from rolling to fixed and adjust accordingly
-          if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling' ) {
+          if ($membershipTypeDetails['period_type'] == 'fixed' && $oldPeriodType == 'rolling') {
             $month = substr($membershipTypeDetails['fixed_period_start_day'], 0, strlen($membershipTypeDetails['fixed_period_start_day']) - 2);
             $day = substr($membershipTypeDetails['fixed_period_start_day'], -2);
             $year += 1;
-          } else {
-          $year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
+          }
+          else {
+            $year = $year + ($numRenewTerms * $membershipTypeDetails['duration_interval']);
           }
           break;
 
@@ -564,7 +578,8 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
    * Retrieve all Membership Types associated
    * with an Organization
    *
-   * @param int $orgID  Id of Organization
+   * @param int $orgID
+   *   Id of Organization.
    *
    * @return Array array of the details of membership types
    * @static
@@ -641,7 +656,7 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
       $query = 'SELECT memType.id, memType.name, memType.member_of_contact_id, c.sort_name
         FROM civicrm_membership_type memType INNER JOIN civicrm_contact c ON c.id = memType.member_of_contact_id
         WHERE memType.is_active = 1 ';
-      $dao = CRM_Core_DAO::executeQuery( $query );
+      $dao = CRM_Core_DAO::executeQuery($query);
       while ($dao->fetch()) {
         $orgs[$dao->member_of_contact_id] = $dao->sort_name;
         $types[$dao->member_of_contact_id][$dao->id] = $dao->name;
@@ -736,12 +751,12 @@ class CRM_Member_BAO_MembershipType extends CRM_Member_DAO_MembershipType {
   /** This function updates all price field value for quick config
    * price set which has membership type
    *
-   *  @param  integer      membership type id
+   * @param  integer      membership type id
    *
-   *  @param  integer      financial type id
+   * @param  integer      financial type id
    */
   public static function updateAllPriceFieldValue($membershipTypeId, $params) {
-    if (!empty($params['minimum_fee'])){
+    if (!empty($params['minimum_fee'])) {
       $amount = $params['minimum_fee'];
     }
     else {