Merge pull request #15821 from seamuslee001/dev_core_183_custom_group

[civicrm-core.git] / CRM / Core / Form / Task.php

diff --git a/CRM/Core/Form/Task.php b/CRM/Core/Form/Task.php
index 7ca43d4a2f94289eaec262a8e9399f0e5a274783..879bfc6a471bbd1e5dc26dbb80193981b3b3dd49 100644 (file)
--- a/CRM/Core/Form/Task.php
+++ b/CRM/Core/Form/Task.php
@@ -1,33 +1,17 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 5                                                  |
- +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2019                                |
- +--------------------------------------------------------------------+
- | This file is a part of CiviCRM.                                    |
- |                                                                    |
- | CiviCRM is free software; you can copy, modify, and distribute it  |
- | under the terms of the GNU Affero General Public License           |
- | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
+ | Copyright CiviCRM LLC. All rights reserved.                        |
  |                                                                    |
- | CiviCRM is distributed in the hope that it will be useful, but     |
- | WITHOUT ANY WARRANTY; without even the implied warranty of         |
- | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
- | See the GNU Affero General Public License for more details.        |
- |                                                                    |
- | You should have received a copy of the GNU Affero General Public   |
- | License and the CiviCRM Licensing Exception along                  |
- | with this program; if not, contact CiviCRM LLC                     |
- | at info[AT]civicrm[DOT]org. If you have questions about the        |
- | GNU Affero General Public License or the licensing of CiviCRM,     |
- | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
  +--------------------------------------------------------------------+
  */
 
 /**
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2019
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
  */
 
 /**
@@ -80,14 +64,14 @@ abstract class CRM_Core_Form_Task extends CRM_Core_Form {
    *
    * @var string
    */
-  static $tableName = NULL;
+  public static $tableName = NULL;
 
   /**
    * Must be set to entity shortname (eg. event)
    *
    * @var string
    */
-  static $entityShortname = NULL;
+  public static $entityShortname = NULL;
 
   /**
    * Build all the data structures needed to build the form.
@@ -106,7 +90,7 @@ abstract class CRM_Core_Form_Task extends CRM_Core_Form {
    * @throws \CRM_Core_Exception
    */
   public static function preProcessCommon(&$form) {
-    $form->_entityIds = array();
+    $form->_entityIds = [];
 
     $searchFormValues = $form->controller->exportValues($form->get('searchFormName'));
 
@@ -115,7 +99,7 @@ abstract class CRM_Core_Form_Task extends CRM_Core_Form {
     $entityTasks = $className::tasks();
     $form->assign('taskName', $entityTasks[$form->_task]);
 
-    $entityIds = array();
+    $entityIds = [];
     if ($searchFormValues['radio_ts'] == 'ts_sel') {
       foreach ($searchFormValues as $name => $value) {
         if (substr($name, 0, CRM_Core_Form::CB_PREFIX_LEN) == CRM_Core_Form::CB_PREFIX) {
@@ -194,18 +178,17 @@ abstract class CRM_Core_Form_Task extends CRM_Core_Form {
    * @param bool $submitOnce
    */
   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
-    $this->addButtons(array(
-        array(
-          'type' => $nextType,
-          'name' => $title,
-          'isDefault' => TRUE,
-        ),
-        array(
-          'type' => $backType,
-          'name' => ts('Cancel'),
-        ),
-      )
-    );
+    $this->addButtons([
+      [
+        'type' => $nextType,
+        'name' => $title,
+        'isDefault' => TRUE,
+      ],
+      [
+        'type' => $backType,
+        'name' => ts('Cancel'),
+      ],
+    ]);
   }
 
   /**
@@ -218,4 +201,55 @@ abstract class CRM_Core_Form_Task extends CRM_Core_Form {
     return $this->queryMode ?: CRM_Contact_BAO_Query::MODE_CONTACTS;
   }
 
+  /**
+   * Given the component id, compute the contact id
+   * since it's used for things like send email.
+   *
+   * @todo At the moment this duplicates a similar function in CRM_Core_DAO
+   * because right now only the case component is using this. Since the
+   * default $orderBy is '' which is what the original does, others should be
+   * easily convertable as NFC.
+   * @todo The passed in variables should be class member variables. Shouldn't
+   * need to have passed in vars.
+   *
+   * @param $componentIDs
+   * @param string $tableName
+   * @param string $idField
+   *
+   * @return array
+   */
+  public function getContactIDsFromComponent($componentIDs, $tableName, $idField = 'id') {
+    $contactIDs = [];
+
+    if (empty($componentIDs)) {
+      return $contactIDs;
+    }
+
+    $orderBy = $this->orderBy();
+
+    $IDs = implode(',', $componentIDs);
+    $query = "
+SELECT contact_id
+  FROM $tableName
+ WHERE $idField IN ( $IDs ) $orderBy
+";
+
+    $dao = CRM_Core_DAO::executeQuery($query);
+    while ($dao->fetch()) {
+      $contactIDs[] = $dao->contact_id;
+    }
+    return $contactIDs;
+  }
+
+  /**
+   * Default ordering for getContactIDsFromComponent. Subclasses can override.
+   *
+   * @return string
+   *   SQL fragment. Either return '' or a valid order clause including the
+   *   words "ORDER BY", e.g. "ORDER BY `{$this->idField}`"
+   */
+  public function orderBy() {
+    return '';
+  }
+
 }