Merge pull request #14249 from yashodha/959_dev
[civicrm-core.git] / CRM / Event / 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 * $Id: Email.php 45499 2013-02-08 12:31:05Z kurund $
33 */
34
35 /**
36 * This class provides the functionality to email a group of
37 * contacts.
38 */
39 class CRM_Event_Form_Task_Email extends CRM_Event_Form_Task {
40
41 /**
42 * Are we operating in "single mode", i.e. sending email to one
43 * specific contact?
44 *
45 * @var bool
46 */
47 public $_single = FALSE;
48
49 /**
50 * Are we operating in "single mode", i.e. sending email to one
51 * specific contact?
52 *
53 * @var bool
54 */
55 public $_noEmails = FALSE;
56
57 /**
58 * All the existing templates in the system.
59 *
60 * @var array
61 */
62 public $_templates = NULL;
63
64 /**
65 * Build all the data structures needed to build the form.
66 */
67 public function preProcess() {
68 CRM_Contact_Form_Task_EmailCommon::preProcessFromAddress($this);
69 parent::preProcess();
70
71 // we have all the participant ids, so now we get the contact ids
72 parent::setContactIDs();
73
74 $this->assign('single', $this->_single);
75 }
76
77 /**
78 * Build the form object.
79 */
80 public function buildQuickForm() {
81 //enable form element
82 $this->assign('emailTask', TRUE);
83
84 CRM_Contact_Form_Task_EmailCommon::buildQuickForm($this);
85 }
86
87 /**
88 * Process the form after the input has been submitted and validated.
89 */
90 public function postProcess() {
91 CRM_Contact_Form_Task_EmailCommon::postProcess($this);
92 }
93
94 /**
95 * List available tokens for this form.
96 *
97 * @return array
98 */
99 public function listTokens() {
100 $tokens = CRM_Core_SelectValues::contactTokens();
101 return $tokens;
102 }
103
104 }