CRM/Pledge/Form/Task.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * Class for pledge form task actions.
  20  * FIXME: This needs refactoring to properly inherit from CRM_Core_Form_Task and share more functions.
  21  */
  22 class CRM_Pledge_Form_Task extends CRM_Core_Form_Task {
  23
  24   /**
  25    * The array that holds all the pledge ids.
  26    *
  27    * @var array
  28    */
  29   protected $_pledgeIds;
  30
  31   /**
  32    * Build all the data structures needed to build the form.
  33    */
  34   public function preProcess() {
  35     self::preProcessCommon($this);
  36   }
  37
  38   /**
  39    * Common pre-processing.
  40    *
  41    * @param CRM_Pledge_Form_Task $form
  42    */
  43   public static function preProcessCommon(&$form) {
  44     $form->_pledgeIds = [];
  45
  46     $values = $form->controller->exportValues('Search');
  47
  48     $form->_task = $values['task'];
  49
  50     $ids = $form->getSelectedIDs($values);
  51
  52     if (!$ids) {
  53       $queryParams = $form->get('queryParams');
  54       $sortOrder = NULL;
  55       if ($form->get(CRM_Utils_Sort::SORT_ORDER)) {
  56         $sortOrder = $form->get(CRM_Utils_Sort::SORT_ORDER);
  57       }
  58       $query = new CRM_Contact_BAO_Query($queryParams, NULL, NULL, FALSE, FALSE,
  59         CRM_Contact_BAO_Query::MODE_PLEDGE
  60       );
  61       $query->_distinctComponentClause = ' civicrm_pledge.id';
  62       $query->_groupByComponentClause = ' GROUP BY civicrm_pledge.id ';
  63
  64       $result = $query->searchQuery(0, 0, $sortOrder);
  65       while ($result->fetch()) {
  66         $ids[] = $result->pledge_id;
  67       }
  68     }
  69
  70     if (!empty($ids)) {
  71       $form->_componentClause = ' civicrm_pledge.id IN ( ' . implode(',', $ids) . ' ) ';
  72       $form->assign('totalSelectedPledges', count($ids));
  73     }
  74
  75     $form->_pledgeIds = $form->_componentIds = $ids;
  76     $form->setNextUrl('pledge');
  77   }
  78
  79   /**
  80    * Given the signer id, compute the contact id
  81    * since its used for things like send email
  82    */
  83   public function setContactIDs() {
  84     $this->_contactIds = CRM_Core_DAO::getContactIDsFromComponent($this->_pledgeIds,
  85       'civicrm_pledge'
  86     );
  87   }
  88
  89   /**
  90    * Simple shell that derived classes can call to add buttons to
  91    * the form with a customized title for the main Submit
  92    *
  93    * @param string $title
  94    *   Title of the main button.
  95    * @param string $nextType
  96    * @param string $backType
  97    * @param bool $submitOnce
  98    */
  99   public function addDefaultButtons($title, $nextType = 'next', $backType = 'back', $submitOnce = FALSE) {
 100     $this->addButtons([
 101         [
 102           'type' => $nextType,
 103           'name' => $title,
 104           'isDefault' => TRUE,
 105         ],
 106         [
 107           'type' => $backType,
 108           'name' => ts('Cancel'),
 109         ],
 110     ]);
 111   }
 112
 113 }