3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
35 * This class generates form components for adding a petition.
37 class CRM_Campaign_Form_Petition
extends CRM_Core_Form
{
40 * Making this public so we can reference it in the formRule
45 public function preProcess() {
46 if (!CRM_Campaign_BAO_Campaign
::accessCampaign()) {
47 CRM_Utils_System
::permissionDenied();
50 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
52 $this->assign('context', $this->_context
);
54 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this);
56 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::DELETE
)) {
57 $this->_surveyId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE);
59 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
60 CRM_Utils_System
::setTitle(ts('Edit Survey'));
63 CRM_Utils_System
::setTitle(ts('Delete Survey'));
67 // when custom data is included in this page
68 if (!empty($_POST['hidden_custom'])) {
69 $this->set('type', 'Event');
70 $this->set('entityId', $this->_surveyId
);
71 CRM_Custom_Form_CustomData
::preProcess($this, NULL, NULL, 1, 'Survey', $this->_surveyId
);
72 CRM_Custom_Form_CustomData
::buildQuickForm($this);
73 CRM_Custom_Form_CustomData
::setDefaultValues($this);
76 $session = CRM_Core_Session
::singleton();
77 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=survey');
78 $session->pushUserContext($url);
80 $this->_values
= $this->get('values');
82 if (!is_array($this->_values
)) {
83 $this->_values
= array();
84 if ($this->_surveyId
) {
85 $params = array('id' => $this->_surveyId
);
86 CRM_Campaign_BAO_Survey
::retrieve($params, $this->_values
);
88 $this->set('values', $this->_values
);
91 $this->assign('action', $this->_action
);
92 $this->assign('surveyId', $this->_surveyId
);
94 $this->assign('entityID', $this->_surveyId
);
96 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::DELETE
)) {
97 $this->_surveyId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE);
99 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
100 CRM_Utils_System
::setTitle(ts('Edit Petition'));
103 CRM_Utils_System
::setTitle(ts('Delete Petition'));
107 $session = CRM_Core_Session
::singleton();
108 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=petition');
109 $session->pushUserContext($url);
111 CRM_Utils_System
::appendBreadCrumb(array(array('title' => ts('Petition Dashboard'), 'url' => $url)));
115 * Set default values for the form. Note that in edit/view mode
116 * the default values are retrieved from the database
119 * array of default values
121 public function setDefaultValues() {
122 $defaults = $this->_values
;
124 $ufContactJoinParams = array(
125 'entity_table' => 'civicrm_survey',
126 'entity_id' => $this->_surveyId
,
130 if ($ufContactGroupId = CRM_Core_BAO_UFJoin
::findUFGroupId($ufContactJoinParams)) {
131 $defaults['contact_profile_id'] = $ufContactGroupId;
133 $ufActivityJoinParams = array(
134 'entity_table' => 'civicrm_survey',
135 'entity_id' => $this->_surveyId
,
139 if ($ufActivityGroupId = CRM_Core_BAO_UFJoin
::findUFGroupId($ufActivityJoinParams)) {
140 $defaults['profile_id'] = $ufActivityGroupId;
143 if (!isset($defaults['is_active'])) {
144 $defaults['is_active'] = 1;
147 $defaultSurveys = CRM_Campaign_BAO_Survey
::getSurveys(TRUE, TRUE);
148 if (!isset($defaults['is_default']) && empty($defaultSurveys)) {
149 $defaults['is_default'] = 1;
156 public function buildQuickForm() {
158 if ($this->_action
& CRM_Core_Action
::DELETE
) {
163 'name' => ts('Delete'),
168 'name' => ts('Cancel'),
175 $this->add('text', 'title', ts('Petition Title'), CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'title'), TRUE);
177 $attributes = CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey');
179 $petitionTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Petition');
180 $this->addElement('hidden', 'activity_type_id', $petitionTypeID);
182 // script / instructions / description of petition purpose
183 $this->add('wysiwyg', 'instructions', ts('Introduction'), $attributes['instructions']);
186 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(CRM_Utils_Array
::value('campaign_id', $this->_values
));
187 $this->add('select', 'campaign_id', ts('Campaign'), array('' => ts('- select -')) +
$campaigns);
189 $customContactProfiles = CRM_Core_BAO_UFGroup
::getProfiles(array('Individual'));
191 $this->add('select', 'contact_profile_id', ts('Contact Profile'),
193 '' => ts('- select -'),
194 ) +
$customContactProfiles, TRUE
197 $customProfiles = CRM_Core_BAO_UFGroup
::getProfiles(array('Activity'));
199 $this->add('select', 'profile_id', ts('Activity Profile'),
201 '' => ts('- select -'),
205 // thank you title and text (html allowed in text)
206 $this->add('text', 'thankyou_title', ts('Thank-you Page Title'), CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'thankyou_title'));
207 $this->add('wysiwyg', 'thankyou_text', ts('Thank-you Message'), CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'thankyou_text'));
209 // bypass email confirmation?
210 $this->add('checkbox', 'bypass_confirm', ts('Bypass email confirmation'));
212 //is share through social media
213 $this->addElement('checkbox', 'is_share', ts('Allow sharing through social media?'));
216 $this->add('checkbox', 'is_active', ts('Is Active?'));
219 $this->add('checkbox', 'is_default', ts('Is Default?'));
226 'name' => ts('Save'),
231 'name' => ts('Save and New'),
236 'name' => ts('Cancel'),
241 // add a form rule to check default value
242 $this->addFormRule(array('CRM_Campaign_Form_Petition', 'formRule'), $this);
246 * Global validation rules for the form.
252 public static function formRule($fields, $files, $form) {
254 // Petitions should be unique by: title, campaign ID (if assigned) and activity type ID
255 // NOTE: This class is called for both Petition create / update AND for Survey Results tab, but this rule is only for Petition.
256 $where = array('activity_type_id = %1', 'title = %2');
258 1 => array($fields['activity_type_id'], 'Integer'),
259 2 => array($fields['title'], 'String'),
261 $uniqueRuleErrorMessage = ts('This title is already associated with the selected activity type. Please specify a unique title.');
263 if (empty($fields['campaign_id'])) {
264 $where[] = 'campaign_id IS NULL';
267 $where[] = 'campaign_id = %3';
268 $params[3] = array($fields['campaign_id'], 'Integer');
269 $uniqueRuleErrorMessage = ts('This title is already associated with the selected campaign and activity type. Please specify a unique title.');
272 // Exclude current Petition row if UPDATE.
273 if ($form->_surveyId
) {
274 $where[] = 'id != %4';
275 $params[4] = array($form->_surveyId
, 'Integer');
278 $whereClause = implode(' AND ', $where);
281 SELECT COUNT(*) AS row_count
286 $result = CRM_Core_DAO
::singleValueQuery($query, $params);
288 $errors['title'] = $uniqueRuleErrorMessage;
290 return empty($errors) ?
TRUE : $errors;
294 public function postProcess() {
295 // store the submitted values in an array
296 $params = $this->controller
->exportValues($this->_name
);
298 $session = CRM_Core_Session
::singleton();
300 $params['last_modified_id'] = $session->get('userID');
301 $params['last_modified_date'] = date('YmdHis');
302 $params['is_share'] = CRM_Utils_Array
::value('is_share', $params, FALSE);
304 if ($this->_surveyId
) {
306 if ($this->_action
& CRM_Core_Action
::DELETE
) {
307 CRM_Campaign_BAO_Survey
::del($this->_surveyId
);
308 CRM_Core_Session
::setStatus(ts(' Petition has been deleted.'), ts('Record Deleted'), 'success');
309 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=petition'));
313 $params['id'] = $this->_surveyId
;
316 $params['created_id'] = $session->get('userID');
317 $params['created_date'] = date('YmdHis');
320 $params['bypass_confirm'] = CRM_Utils_Array
::value('bypass_confirm', $params, 0);
321 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, 0);
322 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, 0);
324 $customFields = CRM_Core_BAO_CustomField
::getFields('Survey');
325 $params['custom'] = CRM_Core_BAO_CustomField
::postProcess($params,
330 $surveyId = CRM_Campaign_BAO_Survey
::create($params);
332 // also update the ProfileModule tables
333 $ufJoinParams = array(
335 'module' => 'CiviCampaign',
336 'entity_table' => 'civicrm_survey',
337 'entity_id' => $surveyId->id
,
340 // first delete all past entries
341 if ($this->_surveyId
) {
342 CRM_Core_BAO_UFJoin
::deleteAll($ufJoinParams);
344 if (!empty($params['profile_id'])) {
345 $ufJoinParams['weight'] = 1;
346 $ufJoinParams['uf_group_id'] = $params['profile_id'];
347 CRM_Core_BAO_UFJoin
::create($ufJoinParams);
350 if (!empty($params['contact_profile_id'])) {
351 $ufJoinParams['weight'] = 2;
352 $ufJoinParams['uf_group_id'] = $params['contact_profile_id'];
353 CRM_Core_BAO_UFJoin
::create($ufJoinParams);
356 if (!is_a($surveyId, 'CRM_Core_Error')) {
357 CRM_Core_Session
::setStatus(ts('Petition has been saved.'), ts('Saved'), 'success');
360 $buttonName = $this->controller
->getButtonName();
361 if ($buttonName == $this->getButtonName('next', 'new')) {
362 CRM_Core_Session
::setStatus(ts(' You can add another Petition.'), '', 'info');
363 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/petition/add', 'reset=1&action=add'));
366 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=petition'));