INFRA-132 comments to end with full stops
[civicrm-core.git] / CRM / Report / Form / Extended.php
index ef11ba6594b4cbfd53e9786c1b5a58bb1bac6185..7effc2e17249e7223c8bd61797c7a2cb160625aa 100644 (file)
@@ -128,7 +128,13 @@ class CRM_Report_Form_Extended extends CRM_Report_Form {
   }
 
   /**
+   * Alter display of rows.
+   *
+   * Iterate through the rows retrieved via SQL and make changes for display purposes,
+   * such as rendering contacts as links.
+   *
    * @param array $rows
+   *   Rows generated by SQL, with an array for each row.
    */
   public function alterDisplay(&$rows) {
     parent::alterDisplay($rows);
@@ -698,7 +704,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form {
   }
 
   /**
-   * Get address columns to add to array
+   * Get address columns to add to array.
    *
    * @param array $options
    *   Options for the report.
@@ -909,7 +915,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form {
   }
 
   /**
-   * Get Information about advertised Joins
+   * Get Information about advertised Joins.
    *
    * @return array
    */
@@ -1025,7 +1031,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form {
   }
 
   /**
-   * Define join from line item table to participant table
+   * Define join from line item table to participant table.
    */
   public function joinParticipantFromLineItem() {
     $this->_from .= " LEFT JOIN civicrm_participant {$this->_aliases['civicrm_participant']}
@@ -1050,7 +1056,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form {
   }
 
   /**
-   * Define join from Participant to Contribution table
+   * Define join from Participant to Contribution table.
    */
   public function joinContributionFromParticipant() {
     $this->_from .= " LEFT JOIN civicrm_participant_payment pp
@@ -1061,7 +1067,7 @@ class CRM_Report_Form_Extended extends CRM_Report_Form {
   }
 
   /**
-   * Define join from Membership to Contribution table
+   * Define join from Membership to Contribution table.
    */
   public function joinContributionFromMembership() {
     $this->_from .= " LEFT JOIN civicrm_membership_payment pp
@@ -1212,7 +1218,7 @@ WHERE   line_item_civireport.id IS NOT NULL
   }
 
   /**
-   * Retrieve text for financial type from pseudoconstant
+   * Retrieve text for financial type from pseudoconstant.
    *
    * @param $value
    * @param array $row
@@ -1230,7 +1236,7 @@ WHERE   line_item_civireport.id IS NOT NULL
   }
 
   /**
-   * Retrieve text for contribution type from pseudoconstant
+   * Retrieve text for contribution type from pseudoconstant.
    *
    * @param $value
    * @param array $row
@@ -1242,7 +1248,7 @@ WHERE   line_item_civireport.id IS NOT NULL
   }
 
   /**
-   * Retrieve text for contribution status from pseudoconstant
+   * Retrieve text for contribution status from pseudoconstant.
    *
    * @param $value
    * @param array $row
@@ -1254,7 +1260,7 @@ WHERE   line_item_civireport.id IS NOT NULL
   }
 
   /**
-   * Retrieve text for payment instrument from pseudoconstant
+   * Retrieve text for payment instrument from pseudoconstant.
    *
    * @param $value
    * @param array $row