MAE-823: Align with latest CiviCRM version 5.51

.github/workflows/unit-test.yml

@@ -6,7 +6,7 @@ jobs:
   run-unit-tests:
 
     runs-on: ubuntu-latest
-    container: compucorp/civicrm-buildkit:1.1.1-php7.2-chrome
+    container: compucorp/civicrm-buildkit:1.3.0-php8.0-chrome
 
     env:
       CIVICRM_EXTENSIONS_DIR: site/web/sites/all/modules/civicrm/tools/extensions
@@ -28,7 +28,15 @@ jobs:
         run : amp config:set --mysql_dsn=mysql://root:root@mysql:3306
 
       - name: Build Drupal site
-        run: civibuild create drupal-clean --civi-ver 5.39.1 --cms-ver 7.85 --web-root $GITHUB_WORKSPACE/site
+        run: civibuild create drupal-clean --civi-ver 5.51.3 --cms-ver 7.79 --web-root $GITHUB_WORKSPACE/site
+
+      - uses: compucorp/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          repo: compucorp/civicrm-core
+          version: 5.51.3
+          path: site/web/sites/all/modules/civicrm
 
       - uses: actions/checkout@v2
         with:

CRM/Civicase/Activity/ContactActivitiesSelector.php

@@ -1,9 +1,7 @@
 <?php
 
 /**
- * Class CRM_Civicase_Activity_ContactActivitiesSelector.
- *
- * Handle fetching activities for a given contact.
+ * Handles fetching activities for a given contact.
  */
 class CRM_Civicase_Activity_ContactActivitiesSelector {
 

CRM/Civicase/BAO/Query/ContactLock.php

@@ -6,19 +6,18 @@
 class CRM_Civicase_BAO_Query_ContactLock extends CRM_Contact_BAO_Query_Interface {
 
   /**
-   * Implements getFields method, required by CRM_Contact_BAO_Query_Interface
-   * class.
+   * {@inheritDoc}
    */
   public function &getFields() {
-    $fields = array();
+    $fields = [];
 
     return $fields;
   }
 
   /**
    * Alters from statement to include case locks.
    */
-  public function from($fieldName, $mode, $side) {
+  public static function from($fieldName, $mode, $side) {
     if ($fieldName == 'civicase_contactlock') {
       $loggedContactID = CRM_Core_Session::singleton()->getLoggedInContactID();
 
@@ -38,7 +37,7 @@ public function from($fieldName, $mode, $side) {
   /**
    * Alters where statement to include case locks.
    */
-  public function where(&$query) {
+  public static function where(&$query) {
     if ($query->_mode == CRM_Contact_BAO_QUERY::MODE_ACTIVITY) {
 
       $query->_where[0][] = CRM_Contact_BAO_Query::buildClause("activity_lock", 'IS NULL');
@@ -47,9 +46,7 @@ public function where(&$query) {
   }
 
   /**
-   * Implements getPanesMapper, required by getPanesMapper hook.
-   *
-   * @param $panes
+   * {@inheritDoc}
    */
   public function getPanesMapper(&$panes) {
 

CRM/Civicase/Event/Listener/AssetBuilder.php

@@ -0,0 +1,29 @@
+<?php
+
+use Civi\Angular\Page\Modules;
+use Civi\Core\Event\GenericHookEvent;
+
+/**
+ * Asset Builder Event Listener Class.
+ */
+class CRM_Civicase_Event_Listener_AssetBuilder {
+
+  /**
+   * Add word replacements to Angular asset.
+   *
+   * @param \Civi\Core\Event\GenericHookEvent $event
+   *   AssetBuilder Event.
+   */
+  public static function addWordReplacements(GenericHookEvent $event) {
+    if ($event->asset == 'angular-modules.json') {
+      $caseCategoryName = \Civi::cache('metadata')->get('current_case_category');
+      CRM_Civicase_Hook_Helper_CaseTypeCategory::addWordReplacements($caseCategoryName);
+
+      // Rebuild the asset if it has been built.
+      if (!empty($event->content)) {
+        Modules::buildAngularModules($event);
+      }
+    }
+  }
+
+}

CRM/Civicase/Form/Report/BaseExtendedReport.php

@@ -1173,23 +1173,9 @@ protected function addAggregateTotalField($fieldName, array $aggregates) {
    * of fields to be selected in the column header fields which is not
    * possible in the original function in base class.
    *
-   * @param array $specs
-   *   Specifications.
-   * @param string $tableName
-   *   Table name.
-   * @param string|null $daoName
-   *   DAO name.
-   * @param string|null $tableAlias
-   *   Table alias.
-   * @param array $defaults
-   *   Defaults.
-   * @param array $options
-   *   Options.
-   *
-   * @return array
-   *   Column lists.
+   * @inheritDoc
    */
-  protected function buildColumns(array $specs, $tableName, $daoName = NULL, $tableAlias = NULL, array $defaults = [], array $options = []) {
+  protected function buildColumns($specs, $tableName, $daoName = NULL, $tableAlias = NULL, $defaults = [], $options = []) {
 
     if (!$tableAlias) {
       $tableAlias = str_replace('civicrm_', '', $tableName);
@@ -1283,8 +1269,8 @@ protected function buildColumns(array $specs, $tableName, $daoName = NULL, $tabl
         }
       }
     }
-    $columns[$tableName]['prefix'] = isset($options['prefix']) ? $options['prefix'] : '';
-    $columns[$tableName]['prefix_label'] = isset($options['prefix_label']) ? $options['prefix_label'] : '';
+    $columns[$tableName]['prefix'] = $options['prefix'] ?? '';
+    $columns[$tableName]['prefix_label'] = $options['prefix_label'] ?? '';
     if (isset($options['group_title'])) {
       $groupTitle = $options['group_title'];
     }
@@ -1305,12 +1291,9 @@ protected function buildColumns(array $specs, $tableName, $daoName = NULL, $tabl
    * results for the row totals based on new Data aggregate functions
    * introduced.
    *
-   * @param array $rows
-   *   Result rows.
-   * @param bool $pager
-   *   Pager.
+   * @inheritDoc
    */
-  public function formatDisplay(array &$rows, $pager = TRUE) {
+  public function formatDisplay(&$rows, $pager = TRUE) {
     // Set pager based on if any limit was applied in the query.
     if ($pager) {
       $this->setPager();
@@ -1352,19 +1335,7 @@ public function formatDisplay(array &$rows, $pager = TRUE) {
   /**
    * Use the options for the field to map the display value.
    *
-   * @param string $value
-   *   Value of the field.
-   * @param array $row
-   *   Row display values.
-   * @param string $selectedField
-   *   Selected field.
-   * @param string $criteriaFieldName
-   *   Criteria field name.
-   * @param array $specs
-   *   Specifications of the column.
-   *
-   * @return string
-   *   Label of the option ids.
+   * @inheritDoc
    */
   public function alterFromOptions($value, array &$row, $selectedField, $criteriaFieldName, array $specs) {
     if ($specs['data_type'] == 'ContactReference') {
@@ -1798,10 +1769,9 @@ public function buildQuickForm() {
    * when next the report instance is opened, those panes are automatically
    * expanded.
    *
-   * @param array $params
-   *   Params.
+   * @inheritDoc
    */
-  public function setParams(array $params) {
+  public function setParams($params) {
     if (empty($params)) {
       $this->_params = $params;
       return;

CRM/Civicase/Form/Report/ColumnDefinitionTrait.php

@@ -253,13 +253,9 @@ public function getCaseColumns(array $options) {
   /**
    * Get contact columns.
    *
-   * @param array $options
-   *   Options for generating the columns.
-   *
-   * @return array
-   *   Contact columns
+   * @inheritDoc
    */
-  public function getContactColumns(array $options = []) {
+  protected function getContactColumns($options = []) {
     $defaultOptions = [
       'prefix' => '',
       'prefix_label' => '',

CRM/Civicase/Form/Report/ExtendedReport.php

@@ -830,7 +830,7 @@ function aggregateSelect() {
    *
    * @throws Exception
    */
-  function addColumnAggregateSelect($fieldName, $dbAlias, $spec) {
+  public function addColumnAggregateSelect($fieldName, $dbAlias, array $spec) {
     if (empty($fieldName)) {
       $this->addAggregateTotal($fieldName);
       return;
@@ -2314,7 +2314,7 @@ protected function addNullToFilterOptions($table, $fieldName, $label = '--does n
    * @param string $fieldAlias
    * @param string $title
    */
-  protected function addRowHeader($tableAlias, $selectedField, $fieldAlias, $title = '') {
+  protected function addRowHeader($tableAlias, array $selectedField, $fieldAlias, $title = '') {
     if (empty($tableAlias)) {
       $this->_select = 'SELECT 1 '; // add a fake value just to save lots of code to calculate whether a comma is required later
       $this->_rollup = NULL;
@@ -2578,7 +2578,7 @@ public function sectionTotals() {
    *
    * @param $rows
    */
-  function alterRollupRows(&$rows) {
+  function alterRollupRows(array &$rows) {
     if (count($rows) === 1) {
       // If the report only returns one row there is no rollup.
       return;
@@ -2636,7 +2636,7 @@ function alterRollupRows(&$rows) {
    *
    * @return string
    */
-  function alterFromOptions($value, &$row, $selectedField, $criteriaFieldName, $specs) {
+  public function alterFromOptions($value, array &$row, $selectedField, $criteriaFieldName, array $specs) {
     if ($specs['data_type'] == 'ContactReference') {
       if (!empty($row[$selectedField])) {
         return CRM_Contact_BAO_Contact::displayName($row[$selectedField]);
@@ -7488,7 +7488,7 @@ protected function getCustomDataDaos($extends) {
    * @param $prefixLabel
    * @param $tableKey
    */
-  protected function addCustomTableToColumns($field, $currentTable, $prefix, $prefixLabel, $tableKey) {
+  protected function addCustomTableToColumns(array $field, $currentTable, $prefix, $prefixLabel, $tableKey) {
     $entity = $field['extends'];
     if (in_array($entity, ['Individual', 'Organization', 'Household'])) {
       $entity = 'Contact';
@@ -7572,7 +7572,7 @@ protected function getCustomFieldMetadata($field, $prefixLabel, $prefix = '') {
    * @return array
    * @throws \Exception
    */
-  protected function getCustomFieldOptions($spec) {
+  protected function getCustomFieldOptions(array $spec) {
     $options = [];
     if (!empty($spec['options'])) {
       return $spec['options'];

CRM/Civicase/Helper/Category.php

@@ -29,7 +29,7 @@ public static function get(string $categoryName) {
     $categoryData = array_shift($categoryData['values']);
 
     $categoryCustomFields = (new CaseCategoryCustomFieldsSetting())->get($categoryData['value']);
-    $categoryData['singular_label'] = $categoryCustomFields['singular_label'];
+    $categoryData['singular_label'] = $categoryCustomFields['singular_label'] ?? NULL;
 
     return $categoryData;
   }

CRM/Civicase/Hook/BuildForm/HandleDraftActivities.php

@@ -13,7 +13,7 @@ class CRM_Civicase_Hook_BuildForm_HandleDraftActivities {
   ];
 
   const PDF_LETTER_FORM_NAME = 'CRM_Contact_Form_Task_PDF';
-  const EMAIL_FORM_NAME = 'CRM_Contact_Form_Task_Email';
+  const EMAIL_FORM_NAME = 'CRM_Case_Form_Task_Email';
   const SPECIAL_FORMS = [
     self::PDF_LETTER_FORM_NAME,
     self::EMAIL_FORM_NAME,
@@ -96,7 +96,7 @@ private function addSaveDraftButton(CRM_Core_Form &$form, $formName) {
             'id' => $id,
             'return' => 'case_id',
           ]);
-          $composeUrl = CRM_Utils_System::url("civicrm/activity/$atype/add", [
+          $composeUrl = CRM_Utils_System::url("civicrm/case/$atype/add", [
             'action' => 'add',
             'reset' => 1,
             'caseId' => $caseId['case_id'][0],