Big code cleanup - return types, visibility, type hints

CRM/Extendedreport/Form/Report/ActivityEditable.php

@@ -31,9 +31,11 @@ public function __construct() {
   }
 
   /**
-   * Generate From clause.
+   * Generate from clause.
+   *
+   * @return array
    */
-  public function fromClauses() {
+  public function fromClauses(): array {
     return [
       'activity_target_from_activity',
       'activity_assignee_from_activity',

CRM/Extendedreport/Form/Report/ActivityPivot.php

@@ -52,7 +52,7 @@ public function __construct() {
    *
    * @return array
    */
-  public function fromClauses() {
+  public function fromClauses(): array {
     return [];
   }
 }

CRM/Extendedreport/Form/Report/Campaign/CampaignProgressReport.php

@@ -123,8 +123,10 @@ public function __construct() {
 
   /**
    * Add from clause
+   *
+   * @throws \CRM_Core_Exception
    */
-  public function from() {
+  public function from(): void {
     $this->_from = "
       FROM civicrm_campaign {$this->_aliases['civicrm_campaign']}";
 
@@ -134,7 +136,7 @@ public function from() {
     $this->_from .= "
       LEFT JOIN civicrm_contact {$this->_aliases['civicrm_contact']}
       ON ({$this->_aliases['civicrm_contact']}.id = progress.contact_id )
-      {$this->_aclFrom}
+      $this->_aclFrom
     ";
   }
 
@@ -143,7 +145,7 @@ public function from() {
    *
    * @throws \CRM_Core_Exception
    */
-  protected function joinProgressTable() {
+  protected function joinProgressTable(): void {
     $until = CRM_Utils_Array::value('effective_date_value', $this->_params);
     $untilClause = '';
     if ($until) {
@@ -205,9 +207,9 @@ protected function joinProgressTable() {
    *
    * @return string
    */
-  function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
+  public function selectClause(&$tableName, $tableKey, &$fieldName, &$field): string {
     if ($fieldName === 'progress_still_to_raise') {
-      $alias = "{$tableName}_{$fieldName}";
+      $alias = "{$tableName}_$fieldName";
       $this->_columnHeaders[$alias]['title'] = CRM_Utils_Array::value('title', $field);
       $this->_columnHeaders[$alias]['type'] = CRM_Utils_Array::value('type', $field);
       $this->_columnHeaders[$alias]['dbAlias'] = CRM_Utils_Array::value('dbAlias', $field);
@@ -220,7 +222,7 @@ function selectClause(&$tableName, $tableKey, &$fieldName, &$field) {
   /**
    * Block parent re-ordering of headers.
    */
-  public function reOrderColumnHeaders() {
+  public function reOrderColumnHeaders(): void {
 
   }
 
@@ -231,16 +233,14 @@ public function reOrderColumnHeaders() {
    *
    * @return string
    */
-  public function alterIsPledge($value) {
+  public function alterIsPledge(bool $value): string {
     return str_replace([0, 1], [ts('Payment without pledge'), ts('Pledge')], $value);
   }
 
   /**
    * @param array $rows
-   *
-   * @throws \CRM_Core_Exception
    */
-  public function alterDisplay(&$rows) {
+  public function alterDisplay(&$rows): void {
     parent::alterDisplay($rows);
     $this->unsetUnreliableColumnsIfNotCampaignGrouped();
     if (isset($this->_columnHeaders['progress_progress_still_to_raise'])) {
@@ -289,13 +289,8 @@ public function alterDisplay(&$rows) {
   /**
    * Do we have a group by array that does not include campaign/
    */
-  protected function groupByCampaignTypeNotCampaign() {
-    if (!empty($this->_groupByArray)) {
-      if (!in_array('campaign.id', $this->_groupByArray, TRUE)) {
-        return TRUE;
-      }
-    }
-    return FALSE;
+  protected function groupByCampaignTypeNotCampaign(): bool {
+    return !empty($this->_groupByArray) && !in_array('campaign.id', $this->_groupByArray, TRUE);
   }
 
   /**
@@ -307,16 +302,16 @@ protected function groupByCampaignTypeNotCampaign() {
    *
    * @return array
    */
-  function getOperationPair($type = "string", $fieldName = NULL) {
-    if ($type == self::OP_SINGLEDATE) {
+  public function getOperationPair($type = "string", $fieldName = NULL): array {
+    if ($type === (string) self::OP_SINGLEDATE) {
       return [
         'to' => ts('Until Date'),
       ];
     }
     return parent::getOperationPair($type, $fieldName);
   }
 
-  protected function unsetUnreliableColumnsIfNotCampaignGrouped() {
+  protected function unsetUnreliableColumnsIfNotCampaignGrouped(): void {
     if ($this->groupByCampaignTypeNotCampaign()) {
       if (isset($this->_columnHeaders['progress_still_to_raise'])) {
         unset($this->_columnHeaders['progress_still_to_raise']);

CRM/Extendedreport/Form/Report/Case/ActivityPivot.php

@@ -11,16 +11,10 @@ class CRM_Extendedreport_Form_Report_Case_ActivityPivot extends CRM_Extendedrepo
 
   protected $_customGroupAggregates = TRUE;
 
-  protected $_aggregatesIncludeNULL = TRUE;
-
-  protected $_aggregatesAddTotal = TRUE;
-
   protected $_rollup = 'WITH ROLLUP';
 
   protected $_aggregatesAddPercentage = TRUE;
 
-  public $_drilldownReport = [];
-
   protected $_potentialCriteria = [];
 
   protected $isPivot = TRUE;
@@ -29,6 +23,8 @@ class CRM_Extendedreport_Form_Report_Case_ActivityPivot extends CRM_Extendedrepo
 
   /**
    * Class constructor.
+   *
+   * @throws \CiviCRM_API3_Exception
    */
   public function __construct() {
     $this->_customGroupExtended['civicrm_case'] = [
@@ -63,7 +59,7 @@ public function __construct() {
   /**
    * @return array
    */
-  function fromClauses() {
+  public function fromClauses(): array {
     return [
       'case_from_activity',
       'contact_from_case',

CRM/Extendedreport/Form/Report/Case/CasePivot.php

@@ -85,7 +85,7 @@ public function __construct() {
    *
    * @return array
    */
-  public function fromClauses() {
+  public function fromClauses(): array {
     return [
       'contact_from_case',
     ];

CRM/Extendedreport/Form/Report/Case/CaseWithActivityPivot.php

@@ -109,7 +109,7 @@ function generateTempTable() {
   /**
    * @return array
    */
-  function fromClauses() {
+  function fromClauses(): array {
     return [
       'contact_from_case',
       'activity_from_case',

CRM/Extendedreport/Form/Report/ColumnDefinitionTrait.php

@@ -200,7 +200,7 @@ public function getActivityColumns(array $options = []): array {
   /**
    * Get columns for Case.
    *
-   * @param $options
+   * @param array $options
    *
    * @return array
    *
@@ -569,7 +569,7 @@ protected function getContactColumns($options = []) {
    *
    * @return array
    */
-  function getLatestActivityColumns($options) {
+  function getLatestActivityColumns(array $options) {
     $defaultOptions = [
       'prefix' => '',
       'prefix_label' => '',
@@ -604,7 +604,7 @@ function getLatestActivityColumns($options) {
    *
    * @return array
    */
-  protected function getContributionRecurColumns($options = []): array {
+  protected function getContributionRecurColumns(array $options = []): array {
     $spec = [
       'id' => [
         'is_fields' => TRUE,
@@ -764,7 +764,7 @@ protected function getContributionRecurColumns($options = []): array {
    *
    * @return array
    */
-  protected function getContributionSoftColumns($options = []): array {
+  protected function getContributionSoftColumns(array $options = []): array {
     $spec = [
       'id' => [
         'is_fields' => FALSE,

CRM/Extendedreport/Form/Report/Contact/AddressHistory.php

@@ -121,7 +121,7 @@ public function orderBy() {
    *
    * @return null|string
    */
-  public function whereClause(&$field, $op, $value, $min, $max) {
+  public function whereClause(&$field, $op, $value, $min, $max): ?string {
     if ($field['name'] === 'contact_id' && $value) {
       $this->contactID = (int) $value;
       $mergedContactIDs = $this->getContactsMergedIntoThisOne($this->contactID);
@@ -137,7 +137,7 @@ public function whereClause(&$field, $op, $value, $min, $max) {
    *
    * @return array
    */
-  protected function getContactsMergedIntoThisOne($contactID) {
+  protected function getContactsMergedIntoThisOne(int $contactID): array {
     // @todo get api joins working properly.
     $result = civicrm_api3('Activity', 'get', [
       'assignee_contact_id' => $contactID,

CRM/Extendedreport/Form/Report/Contact/Basiccontact.php

@@ -5,8 +5,6 @@
  */
 class CRM_Extendedreport_Form_Report_Contact_Basiccontact extends CRM_Extendedreport_Form_Report_ExtendedReport {
 
-  protected $_baseTable = 'civicrm_contact';
-
   protected $skipACL = FALSE;
 
   protected $_joinFilters = ['address_from_contact' => ['civicrm_address' => 'is_primary = 1 ']];
@@ -53,7 +51,7 @@ public function __construct() {
   /**
    * @return array
    */
-  function fromClauses() {
+  public function fromClauses(): array {
     return [
       'address_from_contact',
       'email_from_contact',
@@ -63,7 +61,7 @@ function fromClauses() {
     ];
   }
 
-  function groupBy() {
+  public function groupBy(): void {
     $this->_groupBy = "GROUP BY {$this->_aliases['civicrm_contact']}.id";
   }
 }