Merge pull request #15109 from civicrm/5.17
[civicrm-core.git] / CRM / Activity / Form / Task / SMS.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 * @package CRM
30 * @copyright CiviCRM LLC (c) 2004-2019
31 */
32
33 /**
34 * This class provides the functionality to sms a group of contacts.
35 */
36 class CRM_Activity_Form_Task_SMS extends CRM_Activity_Form_Task {
37
38 /**
39 * Are we operating in "single mode", i.e. sending sms to one
40 * specific contact?
41 *
42 * @var bool
43 */
44 public $_single = FALSE;
45
46 /**
47 * All the existing templates in the system.
48 *
49 * @var array
50 */
51 public $_templates = NULL;
52
53 /**
54 * Build all the data structures needed to build the form.
55 */
56 public function preProcess() {
57 parent::preProcess();
58 CRM_Contact_Form_Task_SMSCommon::preProcessProvider($this);
59 $this->assign('single', $this->_single);
60 }
61
62 /**
63 * Build the form object.
64 */
65 public function buildQuickForm() {
66 // Enable form element.
67 $this->assign('SMSTask', TRUE);
68 CRM_Contact_Form_Task_SMSCommon::buildQuickForm($this);
69 }
70
71 /**
72 * Process the form after the input has been submitted and validated.
73 */
74 public function postProcess() {
75 CRM_Contact_Form_Task_SMSCommon::postProcess($this);
76 }
77
78 /**
79 * List available tokens for this form.
80 *
81 * @return array
82 */
83 public function listTokens() {
84 $tokens = CRM_Core_SelectValues::contactTokens();
85 return $tokens;
86 }
87
88 }