Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
fee14197 | 4 | | CiviCRM version 5 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
6a488035 TO |
32 | */ |
33 | ||
34 | /** | |
ce064e4f | 35 | * This class generates form components for processing a campaign. |
6a488035 TO |
36 | */ |
37 | class CRM_Campaign_Form_Campaign extends CRM_Core_Form { | |
38 | ||
39 | /** | |
100fef9d | 40 | * Action |
6a488035 TO |
41 | * |
42 | * @var int | |
43 | */ | |
3a936dab | 44 | public $_action; |
6a488035 TO |
45 | |
46 | /** | |
100fef9d | 47 | * Context |
6a488035 TO |
48 | * |
49 | * @var string | |
50 | */ | |
51 | protected $_context; | |
52 | ||
53 | /** | |
100fef9d | 54 | * Object values. |
6a488035 TO |
55 | * |
56 | * @var array | |
57 | */ | |
58 | protected $_values; | |
59 | ||
60 | /** | |
100fef9d | 61 | * The id of the campaign we are proceessing |
6a488035 TO |
62 | * |
63 | * @var int | |
6a488035 TO |
64 | */ |
65 | protected $_campaignId; | |
d5965a37 | 66 | |
6e62b28c TM |
67 | /** |
68 | * Explicitly declare the entity api name. | |
69 | */ | |
70 | public function getDefaultEntity() { | |
71 | return 'Campaign'; | |
72 | } | |
6a488035 TO |
73 | |
74 | public function preProcess() { | |
75 | if (!CRM_Campaign_BAO_Campaign::accessCampaign()) { | |
76 | CRM_Utils_System::permissionDenied(); | |
77 | } | |
78 | ||
edc80cda | 79 | $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this); |
6a488035 TO |
80 | |
81 | $this->assign('context', $this->_context); | |
82 | ||
83 | $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this); | |
84 | $this->_campaignId = CRM_Utils_Request::retrieve('id', 'Positive', $this); | |
85 | ||
86 | $title = NULL; | |
87 | if ($this->_action & CRM_Core_Action::UPDATE) { | |
88 | $title = ts('Edit Campaign'); | |
89 | } | |
90 | if ($this->_action & CRM_Core_Action::DELETE) { | |
91 | $title = ts('Delete Campaign'); | |
92 | } | |
93 | if ($title) { | |
94 | CRM_Utils_System::setTitle($title); | |
95 | } | |
96 | ||
97 | $session = CRM_Core_Session::singleton(); | |
98 | $session->pushUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=campaign')); | |
99 | $this->assign('action', $this->_action); | |
100 | ||
101 | //load the values; | |
102 | $this->_values = $this->get('values'); | |
103 | if (!is_array($this->_values)) { | |
be2fb01f | 104 | $this->_values = []; |
6a488035 TO |
105 | |
106 | // if we are editing | |
107 | if (isset($this->_campaignId) && $this->_campaignId) { | |
be2fb01f | 108 | $params = ['id' => $this->_campaignId]; |
6a488035 TO |
109 | CRM_Campaign_BAO_Campaign::retrieve($params, $this->_values); |
110 | } | |
111 | ||
112 | //lets use current object session. | |
113 | $this->set('values', $this->_values); | |
114 | } | |
115 | ||
116 | // when custom data is included in form. | |
a7488080 | 117 | if (!empty($_POST['hidden_custom'])) { |
c5366541 | 118 | $campaignTypeId = empty($_POST['campaign_type_id']) ? NULL : $_POST['campaign_type_id']; |
6a488035 | 119 | $this->set('type', 'Campaign'); |
c5366541 | 120 | $this->set('subType', $campaignTypeId); |
6a488035 TO |
121 | $this->set('entityId', $this->_campaignId); |
122 | ||
c5366541 | 123 | CRM_Custom_Form_CustomData::preProcess($this, NULL, $campaignTypeId, 1, 'Campaign', $this->_campaignId); |
6a488035 TO |
124 | CRM_Custom_Form_CustomData::buildQuickForm($this); |
125 | CRM_Custom_Form_CustomData::setDefaultValues($this); | |
126 | } | |
127 | } | |
128 | ||
129 | /** | |
c490a46a | 130 | * Set default values for the form. Note that in edit/view mode |
6a488035 TO |
131 | * the default values are retrieved from the database |
132 | * | |
6a488035 | 133 | * |
2221b3e3 | 134 | * @return array |
6a488035 | 135 | */ |
00be9182 | 136 | public function setDefaultValues() { |
6a488035 TO |
137 | $defaults = $this->_values; |
138 | ||
c38a7f6b CW |
139 | if (empty($defaults['start_date'])) { |
140 | $defaults['start_date'] = date('Y-m-d H:i:s'); | |
6a488035 TO |
141 | } |
142 | ||
143 | if (!isset($defaults['is_active'])) { | |
144 | $defaults['is_active'] = 1; | |
145 | } | |
146 | ||
147 | if (!$this->_campaignId) { | |
148 | return $defaults; | |
149 | } | |
150 | ||
151 | $dao = new CRM_Campaign_DAO_CampaignGroup(); | |
152 | ||
be2fb01f | 153 | $campaignGroups = []; |
6a488035 TO |
154 | $dao->campaign_id = $this->_campaignId; |
155 | $dao->find(); | |
156 | ||
157 | while ($dao->fetch()) { | |
158 | $campaignGroups[$dao->entity_table][$dao->group_type][] = $dao->entity_id; | |
159 | } | |
160 | ||
161 | if (!empty($campaignGroups)) { | |
162 | $defaults['includeGroups'] = $campaignGroups['civicrm_group']['Include']; | |
163 | } | |
164 | return $defaults; | |
165 | } | |
166 | ||
167 | public function buildQuickForm() { | |
168 | if ($this->_action & CRM_Core_Action::DELETE) { | |
169 | ||
be2fb01f | 170 | $this->addButtons([ |
5d4fcf54 TO |
171 | [ |
172 | 'type' => 'next', | |
173 | 'name' => ts('Delete'), | |
174 | 'isDefault' => TRUE, | |
175 | ], | |
176 | [ | |
177 | 'type' => 'cancel', | |
178 | 'name' => ts('Cancel'), | |
179 | ], | |
180 | ]); | |
6a488035 TO |
181 | return; |
182 | } | |
183 | ||
184 | $this->applyFilter('__ALL__', 'trim'); | |
185 | ||
6a488035 TO |
186 | //lets assign custom data type and subtype. |
187 | $this->assign('customDataType', 'Campaign'); | |
188 | $this->assign('entityID', $this->_campaignId); | |
189 | $this->assign('customDataSubType', CRM_Utils_Array::value('campaign_type_id', $this->_values)); | |
190 | ||
191 | $attributes = CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Campaign'); | |
192 | ||
193 | // add comaign title. | |
194 | $this->add('text', 'title', ts('Title'), $attributes['title'], TRUE); | |
195 | ||
196 | // add description | |
197 | $this->add('textarea', 'description', ts('Description'), $attributes['description']); | |
198 | ||
199 | // add campaign start date | |
c38a7f6b | 200 | $this->add('datepicker', 'start_date', ts('Start Date'), [], TRUE); |
6a488035 TO |
201 | |
202 | // add campaign end date | |
c38a7f6b | 203 | $this->add('datepicker', 'end_date', ts('End Date')); |
6a488035 TO |
204 | |
205 | // add campaign type | |
be2fb01f | 206 | $this->addSelect('campaign_type_id', ['onChange' => "CRM.buildCustomData( 'Campaign', this.value );"], TRUE); |
6a488035 TO |
207 | |
208 | // add campaign status | |
a2015e41 | 209 | $this->addSelect('status_id'); |
6a488035 | 210 | |
7b99ead3 CW |
211 | // add External Identifier Element |
212 | $this->add('text', 'external_identifier', ts('External ID'), | |
6a488035 TO |
213 | CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Campaign', 'external_identifier'), FALSE |
214 | ); | |
215 | ||
216 | // add Campaign Parent Id | |
2221b3e3 | 217 | $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(CRM_Utils_Array::value('parent_id', $this->_values), $this->_campaignId); |
6a488035 | 218 | if (!empty($campaigns)) { |
2221b3e3 | 219 | $this->addElement('select', 'parent_id', ts('Parent ID'), |
be2fb01f CW |
220 | ['' => ts('- select Parent -')] + $campaigns, |
221 | ['class' => 'crm-select2'] | |
6a488035 TO |
222 | ); |
223 | } | |
2221b3e3 | 224 | $groups = CRM_Core_PseudoConstant::nestedGroup(); |
6a488035 | 225 | //get the campaign groups. |
11cac306 CW |
226 | $this->add('select', 'includeGroups', |
227 | ts('Include Group(s)'), | |
6a488035 | 228 | $groups, |
11cac306 | 229 | FALSE, |
be2fb01f | 230 | [ |
11cac306 CW |
231 | 'multiple' => TRUE, |
232 | 'class' => 'crm-select2 huge', | |
233 | 'placeholder' => ts('- none -'), | |
be2fb01f | 234 | ] |
6a488035 | 235 | ); |
6a488035 | 236 | |
be2fb01f CW |
237 | $this->add('wysiwyg', 'goal_general', ts('Campaign Goals'), ['rows' => 2, 'cols' => 40]); |
238 | $this->add('text', 'goal_revenue', ts('Revenue Goal'), ['size' => 8, 'maxlength' => 12]); | |
6a488035 | 239 | $this->addRule('goal_revenue', ts('Please enter a valid money value (e.g. %1).', |
be2fb01f | 240 | [1 => CRM_Utils_Money::format('99.99', ' ')] |
353ffa53 | 241 | ), 'money'); |
6a488035 TO |
242 | |
243 | // is this Campaign active | |
244 | $this->addElement('checkbox', 'is_active', ts('Is Active?')); | |
245 | ||
8dbd6052 CW |
246 | $buttons = [ |
247 | [ | |
248 | 'type' => 'upload', | |
249 | 'name' => ts('Save'), | |
250 | 'isDefault' => TRUE, | |
251 | ], | |
252 | ]; | |
253 | // Skip this button when adding a new campaign from an entityRef | |
254 | if (empty($_GET['snippet']) || empty($_GET['returnExtra'])) { | |
255 | $buttons[] = [ | |
256 | 'type' => 'upload', | |
257 | 'name' => ts('Save and New'), | |
258 | 'subName' => 'new', | |
259 | ]; | |
260 | } | |
261 | $buttons[] = [ | |
262 | 'type' => 'cancel', | |
263 | 'name' => ts('Cancel'), | |
264 | ]; | |
265 | ||
266 | $this->addButtons($buttons); | |
6a488035 TO |
267 | } |
268 | ||
269 | /** | |
dc195289 | 270 | * add the rules (mainly global rules) for form. |
6a488035 TO |
271 | * All local rules are added near the element |
272 | * | |
fd31fa4c EM |
273 | * @param $fields |
274 | * @param $files | |
275 | * @param $errors | |
276 | * | |
2221b3e3 | 277 | * @return bool|array |
6a488035 TO |
278 | * @see valid_date |
279 | */ | |
00be9182 | 280 | public static function formRule($fields, $files, $errors) { |
be2fb01f | 281 | $errors = []; |
6a488035 TO |
282 | |
283 | return empty($errors) ? TRUE : $errors; | |
284 | } | |
285 | ||
286 | /** | |
287 | * Form submission of new/edit campaign is processed. | |
6a488035 TO |
288 | */ |
289 | public function postProcess() { | |
290 | // store the submitted values in an array | |
291 | $params = $this->controller->exportValues($this->_name); | |
292 | $session = CRM_Core_Session::singleton(); | |
293 | ||
be2fb01f | 294 | $groups = []; |
6a488035 TO |
295 | if (isset($this->_campaignId)) { |
296 | if ($this->_action & CRM_Core_Action::DELETE) { | |
297 | CRM_Campaign_BAO_Campaign::del($this->_campaignId); | |
298 | CRM_Core_Session::setStatus(ts('Campaign has been deleted.'), ts('Record Deleted'), 'success'); | |
299 | $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=campaign')); | |
300 | return; | |
301 | } | |
302 | $params['id'] = $this->_campaignId; | |
303 | } | |
304 | else { | |
305 | $params['created_id'] = $session->get('userID'); | |
306 | $params['created_date'] = date('YmdHis'); | |
307 | } | |
308 | // format params | |
6a488035 TO |
309 | $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE); |
310 | $params['last_modified_id'] = $session->get('userID'); | |
311 | $params['last_modified_date'] = date('YmdHis'); | |
312 | ||
313 | if (is_array($params['includeGroups'])) { | |
314 | foreach ($params['includeGroups'] as $key => $id) { | |
315 | if ($id) { | |
316 | $groups['include'][] = $id; | |
317 | } | |
318 | } | |
319 | } | |
320 | $params['groups'] = $groups; | |
321 | ||
322 | // delete previous includes/excludes, if campaign already existed | |
353ffa53 TO |
323 | $groupTableName = CRM_Contact_BAO_Group::getTableName(); |
324 | $dao = new CRM_Campaign_DAO_CampaignGroup(); | |
325 | $dao->campaign_id = $this->_campaignId; | |
6a488035 TO |
326 | $dao->entity_table = $groupTableName; |
327 | $dao->find(); | |
328 | while ($dao->fetch()) { | |
329 | $dao->delete(); | |
330 | } | |
331 | ||
332 | //process custom data. | |
333 | $customFields = CRM_Core_BAO_CustomField::getFields('Campaign', FALSE, FALSE, | |
334 | CRM_Utils_Array::value('campaign_type_id', $params) | |
335 | ); | |
336 | $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params, | |
6a488035 TO |
337 | $this->_campaignId, |
338 | 'Campaign' | |
339 | ); | |
340 | ||
341 | $result = CRM_Campaign_BAO_Campaign::create($params); | |
342 | ||
343 | if ($result) { | |
be2fb01f | 344 | CRM_Core_Session::setStatus(ts('Campaign %1 has been saved.', [1 => $result->title]), ts('Saved'), 'success'); |
6a488035 | 345 | $session->pushUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=campaign')); |
8dbd6052 CW |
346 | $this->ajaxResponse['id'] = $result->id; |
347 | $this->ajaxResponse['label'] = $result->title; | |
6a488035 TO |
348 | } |
349 | ||
350 | $buttonName = $this->controller->getButtonName(); | |
351 | if ($buttonName == $this->getButtonName('upload', 'new')) { | |
352 | CRM_Core_Session::setStatus(ts(' You can add another Campaign.'), '', 'info'); | |
353 | $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign/add', 'reset=1&action=add')); | |
354 | } | |
355 | else { | |
356 | $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=campaign')); | |
357 | } | |
358 | } | |
96025800 | 359 | |
6a488035 | 360 | } |