3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2014
37 * Choose include / exclude groups and mass sms
40 class CRM_SMS_Form_Group
extends CRM_Contact_Form_Task
{
43 * Set variables up before form is built
47 public function preProcess() {
48 if (!CRM_SMS_BAO_Provider
::activeProviderCount()) {
49 CRM_Core_Error
::fatal(ts('The <a href="%1">SMS Provider</a> has not been configured or is not active.', array(1 => CRM_Utils_System
::url('civicrm/admin/sms/provider', 'reset=1'))));
52 $session = CRM_Core_Session
::singleton();
53 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/mailing/browse', 'reset=1&sms=1'));
57 * Set default values for the form.
58 * the default values are retrieved from the database
63 public function setDefaultValues() {
64 $mailingID = CRM_Utils_Request
::retrieve('mid', 'Integer', $this, FALSE, NULL);
65 $continue = CRM_Utils_Request
::retrieve('continue', 'String', $this, FALSE, NULL);
70 $mailing = new CRM_Mailing_DAO_Mailing();
71 $mailing->id
= $mailingID;
72 $mailing->addSelect('name');
75 $defaults['name'] = $mailing->name
;
77 $defaults['name'] = ts('Copy of %1', array(1 => $mailing->name
));
80 // CRM-7590, reuse same mailing ID if we are continuing
81 $this->set('mailing_id', $mailingID);
84 $dao = new CRM_Mailing_DAO_MailingGroup();
86 $mailingGroups = array();
87 $dao->mailing_id
= $mailingID;
89 while ($dao->fetch()) {
90 $mailingGroups[$dao->entity_table
][$dao->group_type
][] = $dao->entity_id
;
93 $defaults['includeGroups'] = $mailingGroups['civicrm_group']['Include'];
94 $defaults['excludeGroups'] = CRM_Utils_Array
::value('Exclude', $mailingGroups['civicrm_group']);
96 $defaults['includeMailings'] = CRM_Utils_Array
::value('Include', CRM_Utils_Array
::value('civicrm_mailing', $mailingGroups));
97 $defaults['excludeMailings'] = CRM_Utils_Array
::value('Exclude', CRM_Utils_Array
::value('civicrm_mailing', $mailingGroups));
104 * Build the form object
108 public function buildQuickForm() {
111 $context = $this->get('context');
113 $this->assign('context', $context);
115 $this->add('text', 'name', ts('Name Your SMS'),
116 CRM_Core_DAO
::getAttribute('CRM_Mailing_DAO_Mailing', 'name'),
120 //get the mailing groups.
121 $groups = CRM_Core_PseudoConstant
::nestedGroup('Mailing');
123 //get the sms mailing list
124 $mailings = CRM_Mailing_PseudoConstant
::completed('sms');
129 // run the groups through a hook so users can trim it if needed
130 CRM_Utils_Hook
::mailingGroups($this, $groups, $mailings);
132 $select2style = array(
134 'style' => 'width: 100%; max-width: 60em;',
135 'class' => 'crm-select2',
136 'placeholder' => ts('- select -'),
139 $this->add('select', 'includeGroups',
140 ts('Include Group(s)'),
146 $this->add('select', 'excludeGroups',
147 ts('Exclude Group(s)'),
153 $this->add('select', 'includeMailings',
154 ts('INCLUDE Recipients of These Message(s)'),
159 $this->add('select', 'excludeMailings',
160 ts('EXCLUDE Recipients of These Message(s)'),
166 $this->addFormRule(array('CRM_SMS_Form_Group', 'formRule'));
171 'name' => ts('Next'),
172 'spacing' => ' ',
177 'name' => ts('Cancel'),
181 $this->addButtons($buttons);
183 $this->assign('groupCount', count($groups));
184 $this->assign('mailingCount', count($mailings));
187 public function postProcess() {
188 $values = $this->controller
->exportValues($this->_name
);
197 if (!empty($values[$n])) {
198 $params[$n] = $values[$n];
202 $qf_Group_submit = $this->controller
->exportValue($this->_name
, '_qf_Group_submit');
203 $this->set('name', $params['name']);
205 $inGroups = $values['includeGroups'];
206 $outGroups = $values['excludeGroups'];
207 $inMailings = $values['includeMailings'];
208 $outMailings = $values['excludeMailings'];
210 if (is_array($inGroups)) {
211 foreach ($inGroups as $key => $id) {
213 $groups['include'][] = $id;
217 if (is_array($outGroups)) {
218 foreach ($outGroups as $key => $id) {
220 $groups['exclude'][] = $id;
226 if (is_array($inMailings)) {
227 foreach ($inMailings as $key => $id) {
229 $mailings['include'][] = $id;
233 if (is_array($outMailings)) {
234 foreach ($outMailings as $key => $id) {
236 $mailings['exclude'][] = $id;
241 $session = CRM_Core_Session
::singleton();
242 $params['groups'] = $groups;
243 $params['mailings'] = $mailings;
245 if ($this->get('mailing_id')) {
247 // don't create a new mass sms if already exists
248 $ids['mailing_id'] = $this->get('mailing_id');
250 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
251 $mailingTableName = CRM_Mailing_BAO_Mailing
::getTableName();
253 // delete previous includes/excludes, if mailing already existed
258 $mg = new CRM_Mailing_DAO_MailingGroup();
259 $mg->mailing_id
= $ids['mailing_id'];
260 $mg->entity_table
= ($entity == 'groups') ?
$groupTableName : $mailingTableName;
262 while ($mg->fetch()) {
268 // new mailing, so lets set the created_id
269 $session = CRM_Core_Session
::singleton();
270 $params['created_id'] = $session->get('userID');
271 $params['created_date'] = date('YmdHis');
274 $mailing = CRM_Mailing_BAO_Mailing
::create($params, $ids);
276 $this->set('mailing_id', $mailing->id
);
278 // also compute the recipients and store them in the mailing recipients table
279 CRM_Mailing_BAO_Mailing
::getRecipients($mailing->id
,
288 $count = CRM_Mailing_BAO_Recipients
::mailingSize($mailing->id
);
289 $this->set('count', $count);
290 $this->assign('count', $count);
291 $this->set('groups', $groups);
292 $this->set('mailings', $mailings);
294 if ($qf_Group_submit) {
295 $status = ts("Your Mass SMS has been saved.");
296 CRM_Core_Session
::setStatus($status, ts('Saved'), 'success');
297 $url = CRM_Utils_System
::url('civicrm/mailing', 'reset=1&sms=1');
298 return $this->controller
->setDestination($url);
303 * Display Name of the form
308 public function getTitle() {
309 return ts('Select Recipients');
313 * Global validation rules for the form
315 * @param array $fields
316 * Posted values of the form.
319 * list of errors to be posted back to the form
321 public static function formRule($fields) {
323 if (isset($fields['includeGroups']) &&
324 is_array($fields['includeGroups']) &&
325 isset($fields['excludeGroups']) &&
326 is_array($fields['excludeGroups'])
328 $checkGroups = array();
329 $checkGroups = array_intersect($fields['includeGroups'], $fields['excludeGroups']);
330 if (!empty($checkGroups)) {
331 $errors['excludeGroups'] = ts('Cannot have same groups in Include Group(s) and Exclude Group(s).');
335 if (isset($fields['includeMailings']) &&
336 is_array($fields['includeMailings']) &&
337 isset($fields['excludeMailings']) &&
338 is_array($fields['excludeMailings'])
340 $checkMailings = array();
341 $checkMailings = array_intersect($fields['includeMailings'], $fields['excludeMailings']);
342 if (!empty($checkMailings)) {
343 $errors['excludeMailings'] = ts('Cannot have same sms in Include mailing(s) and Exclude mailing(s).');
347 return empty($errors) ?
TRUE : $errors;