3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
37 * This class generates form components for adding a petition
41 class CRM_Campaign_Form_Petition
extends CRM_Core_Form
{
44 * Making this public so we can reference it in the formRule
50 public function preProcess() {
51 if (!CRM_Campaign_BAO_Campaign
::accessCampaign()) {
52 CRM_Utils_System
::permissionDenied();
55 $this->_context
= CRM_Utils_Request
::retrieve('context', 'String', $this);
57 $this->assign('context', $this->_context
);
59 $this->_action
= CRM_Utils_Request
::retrieve('action', 'String', $this);
61 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::DELETE
)) {
62 $this->_surveyId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE);
64 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
65 CRM_Utils_System
::setTitle(ts('Edit Survey'));
68 CRM_Utils_System
::setTitle(ts('Delete Survey'));
72 $this->_cdType
= CRM_Utils_Array
::value('type', $_GET);
73 $this->assign('cdType', FALSE);
75 $this->assign('cdType', TRUE);
76 return CRM_Custom_Form_CustomData
::preProcess($this);
79 // when custom data is included in this page
80 if (CRM_Utils_Array
::value('hidden_custom', $_POST)) {
81 CRM_Custom_Form_CustomData
::preProcess($this);
82 CRM_Custom_Form_CustomData
::buildQuickForm($this);
85 $session = CRM_Core_Session
::singleton();
86 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=survey');
87 $session->pushUserContext($url);
89 $this->_values
= $this->get('values');
91 if (!is_array($this->_values
)) {
92 $this->_values
= array();
93 if ($this->_surveyId
) {
94 $params = array('id' => $this->_surveyId
);
95 CRM_Campaign_BAO_Survey
::retrieve($params, $this->_values
);
97 $this->set('values', $this->_values
);
100 $this->assign('action', $this->_action
);
101 $this->assign('surveyId', $this->_surveyId
);
103 $this->assign('entityID', $this->_surveyId
);
105 if ($this->_action
& (CRM_Core_Action
::UPDATE | CRM_Core_Action
::DELETE
)) {
106 $this->_surveyId
= CRM_Utils_Request
::retrieve('id', 'Positive', $this, TRUE);
108 if ($this->_action
& CRM_Core_Action
::UPDATE
) {
109 CRM_Utils_System
::setTitle(ts('Edit Petition'));
112 CRM_Utils_System
::setTitle(ts('Delete Petition'));
116 $session = CRM_Core_Session
::singleton();
117 $url = CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=petition');
118 $session->pushUserContext($url);
120 CRM_Utils_System
::appendBreadCrumb(array(array('title' => ts('Petition Dashboard'), 'url' => $url)));
124 * This function sets the default values for the form. Note that in edit/view mode
125 * the default values are retrieved from the database
129 * @return array array of default values
132 function setDefaultValues() {
133 $defaults = $this->_values
;
135 $ufContactJoinParams = array(
136 'entity_table' => 'civicrm_survey',
137 'entity_id' => $this->_surveyId
,
141 if ($ufContactGroupId = CRM_Core_BAO_UFJoin
::findUFGroupId($ufContactJoinParams)) {
142 $defaults['contact_profile_id'] = $ufContactGroupId;
144 $ufActivityJoinParams = array(
145 'entity_table' => 'civicrm_survey',
146 'entity_id' => $this->_surveyId
,
150 if ($ufActivityGroupId = CRM_Core_BAO_UFJoin
::findUFGroupId($ufActivityJoinParams)) {
151 $defaults['profile_id'] = $ufActivityGroupId;
154 if (!isset($defaults['is_active'])) {
155 $defaults['is_active'] = 1;
158 $defaultSurveys = CRM_Campaign_BAO_Survey
::getSurveys(TRUE, TRUE);
159 if (!isset($defaults['is_default']) && empty($defaultSurveys)) {
160 $defaults['is_default'] = 1;
167 public function buildQuickForm() {
169 if ($this->_action
& CRM_Core_Action
::DELETE
) {
174 'name' => ts('Delete'),
179 'name' => ts('Cancel'),
186 $this->add('text', 'title', ts('Petition Title'), CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'title'), TRUE);
188 $attributes = CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey');
190 $petitionTypeID = CRM_Core_OptionGroup
::getValue('activity_type', 'petition', 'name');
191 $this->addElement('hidden', 'activity_type_id', $petitionTypeID);
193 // script / instructions / description of petition purpose
194 $this->addWysiwyg('instructions', ts('Introduction'), $attributes['instructions']);
197 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(CRM_Utils_Array
::value('campaign_id', $this->_values
));
198 $this->add('select', 'campaign_id', ts('Campaign'), array('' => ts('- select -')) +
$campaigns);
200 $customContactProfiles = CRM_Core_BAO_UFGroup
::getProfiles(array('Individual'));
202 $this->add('select', 'contact_profile_id', ts('Contact Profile'),
204 '' => ts('- select -')) +
$customContactProfiles, TRUE
207 $customProfiles = CRM_Core_BAO_UFGroup
::getProfiles(array('Activity'));
209 $this->add('select', 'profile_id', ts('Activity Profile'),
211 '' => ts('- select -')
215 // thank you title and text (html allowed in text)
216 $this->add('text', 'thankyou_title', ts('Thank-you Page Title'), CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'thankyou_title'));
217 $this->addWysiwyg('thankyou_text', ts('Thank-you Message'), CRM_Core_DAO
::getAttribute('CRM_Campaign_DAO_Survey', 'thankyou_text'));
219 // bypass email confirmation?
220 $this->add('checkbox', 'bypass_confirm', ts('Bypass email confirmation'));
222 //is share through social media
223 $this->addElement('checkbox', 'is_share', ts('Allow sharing through social media?'));
226 $this->add('checkbox', 'is_active', ts('Is Active?'));
229 $this->add('checkbox', 'is_default', ts('Is Default?'));
236 'name' => ts('Save'),
241 'name' => ts('Save and New'),
246 'name' => ts('Cancel'),
251 // add a form rule to check default value
252 $this->addFormRule(array('CRM_Campaign_Form_Petition', 'formRule'), $this);
256 * global validation rules for the form
259 static function formRule($fields, $files, $form) {
261 // Petitions should be unique by: title, campaign ID (if assigned) and activity type ID
262 // NOTE: This class is called for both Petition create / update AND for Survey Results tab, but this rule is only for Petition.
263 $where = array('activity_type_id = %1', 'title = %2');
265 1 => array($fields['activity_type_id'], 'Integer'),
266 2 => array($fields['title'], 'String'),
268 $uniqueRule = ts('activity type');
270 if (empty($fields['campaign_id'])) {
271 $where[] = 'campaign_id IS NULL';
273 $where[] = 'campaign_id = %3';
274 $params[3] = array($fields['campaign_id'], 'Integer');
275 $uniqueRule = ts('campaign and activity type');
278 // Exclude current Petition row if UPDATE.
279 if ($form->_surveyId
) {
280 $where[] = 'id != %4';
281 $params[4] = array($form->_surveyId
, 'Integer');
284 $whereClause = implode(' AND ', $where);
287 SELECT COUNT(*) AS row_count
292 $result = CRM_Core_DAO
::singleValueQuery($query, $params);
294 $errors['title'] = ts('This title is already associated with the selected %1. Please specify a unique title.', array(1 => $uniqueRule));
296 return empty($errors) ?
TRUE : $errors;
300 public function postProcess() {
301 // store the submitted values in an array
302 $params = $this->controller
->exportValues($this->_name
);
304 $session = CRM_Core_Session
::singleton();
306 $params['last_modified_id'] = $session->get('userID');
307 $params['last_modified_date'] = date('YmdHis');
308 $params['is_share'] = CRM_Utils_Array
::value('is_share', $params, FALSE);
310 if ($this->_surveyId
) {
312 if ($this->_action
& CRM_Core_Action
::DELETE
) {
313 CRM_Campaign_BAO_Survey
::del($this->_surveyId
);
314 CRM_Core_Session
::setStatus(ts(' Petition has been deleted.'), ts('Record Deleted'), 'success');
315 $session->replaceUserContext(CRM_Utils_System
::url('civicrm/campaign', 'reset=1&subPage=petition'));
319 $params['id'] = $this->_surveyId
;
322 $params['created_id'] = $session->get('userID');
323 $params['created_date'] = date('YmdHis');
326 $params['bypass_confirm'] = CRM_Utils_Array
::value('bypass_confirm', $params, 0);
327 $params['is_active'] = CRM_Utils_Array
::value('is_active', $params, 0);
328 $params['is_default'] = CRM_Utils_Array
::value('is_default', $params, 0);
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 (CRM_Utils_Array
::value('profile_id', $params)) {
345 $ufJoinParams['weight'] = 1;
346 $ufJoinParams['uf_group_id'] = $params['profile_id'];
347 CRM_Core_BAO_UFJoin
::create($ufJoinParams);
350 if (CRM_Utils_Array
::value('contact_profile_id', $params)) {
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'));