dev/core#2066 Extract getSelectedIDs

This is an extension of #18768 I decided moving the IF into the function & making FALSE a return option was cleaner
civicrm · Oct 14, 2020 · 56752ec · 56752ec
1 parent 7ad12b2
commit 56752ec
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 73 deletions.
diff --git a/CRM/Activity/Form/Task.php b/CRM/Activity/Form/Task.php
@@ -49,11 +49,9 @@ public static function preProcessCommon(&$form) {
 
     $form->_task = $values['task'];
 
-    $ids = [];
-    if ($values['radio_ts'] === 'ts_sel') {
-      $ids = $form->getSelectedIDs($values);
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+
+    if (!$ids) {
       $queryParams = $form->get('queryParams');
       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
         CRM_Contact_BAO_Query::MODE_ACTIVITY

diff --git a/CRM/Campaign/Form/Task.php b/CRM/Campaign/Form/Task.php
@@ -35,15 +35,9 @@ public function preProcess() {
 
     $this->_task = $values['task'];
 
-    $ids = [];
-    if ($values['radio_ts'] == 'ts_sel') {
-      foreach ($values as $name => $value) {
-        if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
-          $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
-        }
-      }
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+
+    if (!$ids) {
       $qfKey = CRM_Utils_Request::retrieve('qfKey', 'String', $this);
       $cacheKey = "civicrm search {$qfKey}";
       $allCids = Civi::service('prevnext')->getSelection($cacheKey, "getall");

diff --git a/CRM/Contribute/Form/Task.php b/CRM/Contribute/Form/Task.php
@@ -61,11 +61,8 @@ public static function preProcessCommon(&$form) {
 
     $form->_task = $values['task'] ?? NULL;
 
-    $ids = [];
-    if (isset($values['radio_ts']) && $values['radio_ts'] === 'ts_sel') {
-      $ids = $form->getSelectedIDs($values);
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+    if (!$ids) {
       $queryParams = $form->get('queryParams');
       $isTest = FALSE;
       if (is_array($queryParams)) {

diff --git a/CRM/Core/Form/Task.php b/CRM/Core/Form/Task.php
@@ -101,20 +101,23 @@ public function setNextUrl(string $pathPart) {
   }
 
   /**
-   * Get the ids the user has selected.
+   * Get the ids the user has selected or FALSE if selection has not been used.
    *
    * @param array $values
    *
-   * @return array
+   * @return array|bool
    */
-  public function getSelectedIDs(array $values): array {
-    $ids = [];
-    foreach ($values as $name => $value) {
-      if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
-        $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
+  public function getSelectedIDs(array $values) {
+    if ($values['radio_ts'] === 'ts_sel') {
+      $ids = [];
+      foreach ($values as $name => $value) {
+        if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
+          $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
+        }
       }
+      return $ids;
     }
-    return $ids;
+    return FALSE;
   }
 
   /**

diff --git a/CRM/Event/Form/Task.php b/CRM/Event/Form/Task.php
@@ -53,15 +53,9 @@ public static function preProcessCommon(&$form) {
       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
     }
 
-    $ids = [];
-    if ($values['radio_ts'] == 'ts_sel') {
-      foreach ($values as $name => $value) {
-        if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
-          $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
-        }
-      }
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+
+    if (!$ids) {
       $queryParams = $form->get('queryParams');
       $sortOrder = NULL;
       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {

diff --git a/CRM/Grant/Form/Task.php b/CRM/Grant/Form/Task.php
@@ -49,15 +49,9 @@ public static function preProcessCommon(&$form) {
       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
     }
 
-    $ids = [];
-    if ($values['radio_ts'] == 'ts_sel') {
-      foreach ($values as $name => $value) {
-        if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
-          $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
-        }
-      }
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+
+    if (!$ids) {
       $queryParams = $form->get('queryParams');
       $sortOrder = NULL;
       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {

diff --git a/CRM/Mailing/Form/Task.php b/CRM/Mailing/Form/Task.php
@@ -39,15 +39,9 @@ public static function preProcessCommon(&$form) {
     $form->_task = $values['task'] ?? NULL;
 
     // ids are mailing event queue ids
-    $ids = [];
-    if ($values['radio_ts'] == 'ts_sel') {
-      foreach ($values as $name => $value) {
-        if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
-          $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
-        }
-      }
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+
+    if (!$ids) {
       $queryParams = $form->get('queryParams');
       $sortOrder = NULL;
       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {

diff --git a/CRM/Member/Form/Task.php b/CRM/Member/Form/Task.php
@@ -56,15 +56,9 @@ public static function preProcessCommon(&$form) {
       CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
     }
 
-    $ids = [];
-    if ($values['radio_ts'] === 'ts_sel') {
-      foreach ($values as $name => $value) {
-        if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
-          $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
-        }
-      }
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+
+    if (!$ids) {
       $queryParams = $form->get('queryParams');
       $sortOrder = NULL;
       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {

diff --git a/CRM/Pledge/Form/Task.php b/CRM/Pledge/Form/Task.php
@@ -47,15 +47,9 @@ public static function preProcessCommon(&$form) {
 
     $form->_task = $values['task'];
 
-    $ids = [];
-    if ($values['radio_ts'] == 'ts_sel') {
-      foreach ($values as $name => $value) {
-        if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
-          $ids[] = substr($name, CRM_Core_Form::CB_PREFIX_LEN);
-        }
-      }
-    }
-    else {
+    $ids = $form->getSelectedIDs($values);
+
+    if (!$ids) {
       $queryParams = $form->get('queryParams');
       $sortOrder = NULL;
       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {

diff --git a/tests/phpunit/CRM/Contribute/Form/TaskTest.php b/tests/phpunit/CRM/Contribute/Form/TaskTest.php
@@ -66,7 +66,7 @@ public function testPreProcessCommonAfterSorting() {
     }
 
     // Assert contribIds are returned in a sorted order.
-    $form = $this->getFormObject('CRM_Contribute_Form_Task', [], 'Search');
+    $form = $this->getFormObject('CRM_Contribute_Form_Task', ['radio_ts' => 'ts_all'], 'Search');
     foreach ($fields as $val) {
       $form->set(CRM_Utils_Sort::SORT_ORDER, "`{$val}` asc");
       CRM_Contribute_Form_Task::preProcessCommon($form);