CRM/Contribute/Form/Task/Email.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33
  34 /**
  35  * This class provides the functionality to email a group of contacts.
  36  */
  37 class CRM_Contribute_Form_Task_Email extends CRM_Contribute_Form_Task {
  38
  39   /**
  40    * Are we operating in "single mode", i.e. sending email to one
  41    * specific contact?
  42    *
  43    * @var boolean
  44    */
  45   public $_single = FALSE;
  46
  47   public $_noEmails = FALSE;
  48
  49   /**
  50    * All the existing templates in the system.
  51    *
  52    * @var array
  53    */
  54   public $_templates = NULL;
  55
  56   /**
  57    * Build all the data structures needed to build the form.
  58    */
  59   public function preProcess() {
  60     CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($this);
  61     parent::preProcess();
  62
  63     // we have all the contribution ids, so now we get the contact ids
  64     parent::setContactIDs();
  65
  66     $this->assign('single', $this->_single);
  67   }
  68
  69   /**
  70    * Build the form object.
  71    */
  72   public function buildQuickForm() {
  73     //enable form element
  74     $this->assign('emailTask', TRUE);
  75
  76     CRM_Contact_Form_Task_EmailCommon::buildQuickForm($this);
  77   }
  78
  79   /**
  80    * Process the form after the input has been submitted and validated.
  81    */
  82   public function postProcess() {
  83     CRM_Contact_Form_Task_EmailCommon::postProcess($this);
  84   }
  85
  86   /**
  87    * List available tokens for this form.
  88    *
  89    * @return array
  90    */
  91   public function listTokens() {
  92     $tokens = CRM_Core_SelectValues::contactTokens();
  93     $tokens = array_merge(CRM_Core_SelectValues::contributionTokens(), $tokens);
  94     return $tokens;
  95   }
  96
  97 }