CRM/Campaign/Form/Petition.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.3                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   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  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for adding a petition
  38  *
  39  */
  40
  41 class CRM_Campaign_Form_Petition extends CRM_Core_Form {
  42
  43   /**
  44    * @var int
  45    * @protected
  46    */
  47   public $_surveyId;
  48
  49   public function preProcess() {
  50     if (!CRM_Campaign_BAO_Campaign::accessCampaign()) {
  51       CRM_Utils_System::permissionDenied();
  52     }
  53
  54     $this->_context = CRM_Utils_Request::retrieve('context', 'String', $this);
  55
  56     $this->assign('context', $this->_context);
  57
  58     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this);
  59
  60     if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::DELETE)) {
  61       $this->_surveyId = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  62
  63       if ($this->_action & CRM_Core_Action::UPDATE) {
  64         CRM_Utils_System::setTitle(ts('Edit Survey'));
  65       }
  66       else {
  67         CRM_Utils_System::setTitle(ts('Delete Survey'));
  68       }
  69     }
  70
  71     $this->_cdType = CRM_Utils_Array::value('type', $_GET);
  72     $this->assign('cdType', FALSE);
  73     if ($this->_cdType) {
  74       $this->assign('cdType', TRUE);
  75       return CRM_Custom_Form_CustomData::preProcess($this);
  76     }
  77
  78     // when custom data is included in this page
  79     if (CRM_Utils_Array::value('hidden_custom', $_POST)) {
  80       CRM_Custom_Form_CustomData::preProcess($this);
  81       CRM_Custom_Form_CustomData::buildQuickForm($this);
  82     }
  83
  84     $session = CRM_Core_Session::singleton();
  85     $url = CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=survey');
  86     $session->pushUserContext($url);
  87
  88     $this->_values = $this->get('values');
  89
  90     if (!is_array($this->_values)) {
  91       $this->_values = array();
  92       if ($this->_surveyId) {
  93         $params = array('id' => $this->_surveyId);
  94         CRM_Campaign_BAO_Survey::retrieve($params, $this->_values);
  95       }
  96       $this->set('values', $this->_values);
  97     }
  98
  99     $this->assign('action', $this->_action);
 100     $this->assign('surveyId', $this->_surveyId);
 101     // for custom data
 102     $this->assign('entityID', $this->_surveyId);
 103
 104     if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::DELETE)) {
 105       $this->_surveyId = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
 106
 107       if ($this->_action & CRM_Core_Action::UPDATE) {
 108         CRM_Utils_System::setTitle(ts('Edit Petition'));
 109       }
 110       else {
 111         CRM_Utils_System::setTitle(ts('Delete Petition'));
 112       }
 113     }
 114
 115     $session = CRM_Core_Session::singleton();
 116     $url = CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=petition');
 117     $session->pushUserContext($url);
 118
 119     CRM_Utils_System::appendBreadCrumb(array(array('title' => ts('Petition Dashboard'), 'url' => $url)));
 120   }
 121
 122   /**
 123    * This function sets the default values for the form. Note that in edit/view mode
 124    * the default values are retrieved from the database
 125    *
 126    * @param null
 127    *
 128    * @return array    array of default values
 129    * @access public
 130    */
 131   function setDefaultValues() {
 132     $defaults = $this->_values;
 133
 134     $ufContactJoinParams = array(
 135       'entity_table' => 'civicrm_survey',
 136       'entity_id' => $this->_surveyId,
 137       'weight' => 2,
 138     );
 139
 140     if ($ufContactGroupId = CRM_Core_BAO_UFJoin::findUFGroupId($ufContactJoinParams)) {
 141       $defaults['contact_profile_id'] = $ufContactGroupId;
 142     }
 143     $ufActivityJoinParams = array(
 144       'entity_table' => 'civicrm_survey',
 145       'entity_id' => $this->_surveyId,
 146       'weight' => 1,
 147     );
 148
 149     if ($ufActivityGroupId = CRM_Core_BAO_UFJoin::findUFGroupId($ufActivityJoinParams)) {
 150       $defaults['profile_id'] = $ufActivityGroupId;
 151     }
 152
 153     if (!isset($defaults['is_active'])) {
 154       $defaults['is_active'] = 1;
 155     }
 156
 157     $defaultSurveys = CRM_Campaign_BAO_Survey::getSurveys(TRUE, TRUE);
 158     if (!isset($defaults['is_default']) && empty($defaultSurveys)) {
 159       $defaults['is_default'] = 1;
 160     }
 161
 162     return $defaults;
 163   }
 164
 165
 166   public function buildQuickForm() {
 167
 168     if ($this->_action & CRM_Core_Action::DELETE) {
 169       $this->addButtons(
 170         array(
 171           array(
 172             'type' => 'next',
 173             'name' => ts('Delete'),
 174             'isDefault' => TRUE,
 175           ),
 176           array(
 177             'type' => 'cancel',
 178             'name' => ts('Cancel'),
 179           ),
 180         )
 181       );
 182       return;
 183     }
 184
 185     $this->add('text', 'title', ts('Petition Title'), CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Survey', 'title'), TRUE);
 186
 187     $attributes = CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Survey');
 188
 189     $petitionTypeID = CRM_Core_OptionGroup::getValue('activity_type', 'petition', 'name');
 190     $this->addElement('hidden', 'activity_type_id', $petitionTypeID);
 191
 192     // script / instructions / description of petition purpose
 193     $this->addWysiwyg('instructions', ts('Introduction'), $attributes['instructions']);
 194
 195     // Campaign id
 196     $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(CRM_Utils_Array::value('campaign_id', $this->_values));
 197     $this->add('select', 'campaign_id', ts('Campaign'), array('' => ts('- select -')) + $campaigns);
 198
 199     $customContactProfiles = CRM_Core_BAO_UFGroup::getProfiles(array('Individual'));
 200     // custom group id
 201     $this->add('select', 'contact_profile_id', ts('Contact Profile'),
 202       array(
 203         '' => ts('- select -')) + $customContactProfiles, TRUE
 204     );
 205
 206     $customProfiles = CRM_Core_BAO_UFGroup::getProfiles(array('Activity'));
 207     // custom group id
 208     $this->add('select', 'profile_id', ts('Activity Profile'),
 209       array(
 210         '' => ts('- select -')
 211       ) + $customProfiles
 212     );
 213
 214     // thank you title and text (html allowed in text)
 215     $this->add('text', 'thankyou_title', ts('Thank-you Page Title'), CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Survey', 'thankyou_title'));
 216     $this->addWysiwyg('thankyou_text', ts('Thank-you Message'), CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Survey', 'thankyou_text'));
 217
 218     // bypass email confirmation?
 219     $this->add('checkbox', 'bypass_confirm', ts('Bypass email confirmation'));
 220
 221     //is share through social media
 222     $this->addElement('checkbox', 'is_share', ts('Allow sharing through social media?'));
 223
 224     // is active ?
 225     $this->add('checkbox', 'is_active', ts('Is Active?'));
 226
 227     // is default ?
 228     $this->add('checkbox', 'is_default', ts('Is Default?'));
 229
 230     // add buttons
 231     $this->addButtons(
 232       array(
 233         array(
 234           'type' => 'next',
 235           'name' => ts('Save'),
 236           'isDefault' => TRUE,
 237         ),
 238         array(
 239           'type' => 'next',
 240           'name' => ts('Save and New'),
 241           'subName' => 'new',
 242         ),
 243         array(
 244           'type' => 'cancel',
 245           'name' => ts('Cancel'),
 246         ),
 247       )
 248     );
 249
 250     // add a form rule to check default value
 251     $this->addFormRule(array('CRM_Campaign_Form_Petition', 'formRule'), $this);
 252   }
 253
 254   /**
 255    * global validation rules for the form
 256    *
 257    */
 258   static function formRule($fields, $files, $form) {
 259     $errors = array();
 260     // Petitions should be unique by: title, campaign ID (if assigned) and activity type ID
 261     // NOTE: This class is called for both Petition create / update AND for Survey Results tab, but this rule is only for Petition.
 262     $where = array('activity_type_id = %1', 'title = %2');
 263     $params = array(
 264       1 => array($fields['activity_type_id'], 'Integer'),
 265       2 => array($fields['title'], 'String'),
 266     );
 267     $uniqueRule = ts('activity type');
 268
 269     if (empty($fields['campaign_id'])) {
 270       $where[] = 'campaign_id IS NULL';
 271     } else {
 272       $where[] = 'campaign_id = %3';
 273       $params[3] = array($fields['campaign_id'], 'Integer');
 274       $uniqueRule = ts('campaign and activity type');
 275     }
 276
 277     // Exclude current Petition row if UPDATE.
 278     if ($form->_surveyId) {
 279       $where[] = 'id != %4';
 280       $params[4] = array($form->_surveyId, 'Integer');
 281     }
 282
 283     $whereClause = implode(' AND ', $where);
 284
 285     $query = "
 286 SELECT COUNT(*) AS row_count
 287 FROM   civicrm_survey
 288 WHERE  $whereClause
 289 ";
 290
 291     $result = CRM_Core_DAO::singleValueQuery($query, $params);
 292     if ($result >= 1) {
 293       $errors['title'] = ts('This title is already associated with the selected %1. Please specify a unique title.', array(1 => $uniqueRule));
 294     }
 295     return empty($errors) ? TRUE : $errors;
 296   }
 297
 298
 299   public function postProcess() {
 300     // store the submitted values in an array
 301     $params = $this->controller->exportValues($this->_name);
 302
 303     $session = CRM_Core_Session::singleton();
 304
 305     $params['last_modified_id'] = $session->get('userID');
 306     $params['last_modified_date'] = date('YmdHis');
 307     $params['is_share'] = CRM_Utils_Array::value('is_share', $params, FALSE);
 308
 309     if ($this->_surveyId) {
 310
 311       if ($this->_action & CRM_Core_Action::DELETE) {
 312         CRM_Campaign_BAO_Survey::del($this->_surveyId);
 313         CRM_Core_Session::setStatus(ts(' Petition has been deleted.'), ts('Record Deleted'), 'success');
 314         $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=petition'));
 315         return;
 316       }
 317
 318       $params['id'] = $this->_surveyId;
 319     }
 320     else {
 321       $params['created_id'] = $session->get('userID');
 322       $params['created_date'] = date('YmdHis');
 323     }
 324
 325     $params['bypass_confirm'] = CRM_Utils_Array::value('bypass_confirm', $params, 0);
 326     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, 0);
 327     $params['is_default'] = CRM_Utils_Array::value('is_default', $params, 0);
 328
 329     $surveyId = CRM_Campaign_BAO_Survey::create($params);
 330
 331     // also update the ProfileModule tables
 332     $ufJoinParams = array(
 333       'is_active' => 1,
 334       'module' => 'CiviCampaign',
 335       'entity_table' => 'civicrm_survey',
 336       'entity_id' => $surveyId->id,
 337     );
 338
 339     // first delete all past entries
 340     if ($this->_surveyId) {
 341       CRM_Core_BAO_UFJoin::deleteAll($ufJoinParams);
 342     }
 343     if (CRM_Utils_Array::value('profile_id', $params)) {
 344       $ufJoinParams['weight'] = 1;
 345       $ufJoinParams['uf_group_id'] = $params['profile_id'];
 346       CRM_Core_BAO_UFJoin::create($ufJoinParams);
 347     }
 348
 349     if (CRM_Utils_Array::value('contact_profile_id', $params)) {
 350       $ufJoinParams['weight'] = 2;
 351       $ufJoinParams['uf_group_id'] = $params['contact_profile_id'];
 352       CRM_Core_BAO_UFJoin::create($ufJoinParams);
 353     }
 354
 355     if (!is_a($surveyId, 'CRM_Core_Error')) {
 356       CRM_Core_Session::setStatus(ts('Petition has been saved.'), ts('Saved'), 'success');
 357     }
 358
 359     $buttonName = $this->controller->getButtonName();
 360     if ($buttonName == $this->getButtonName('next', 'new')) {
 361       CRM_Core_Session::setStatus(ts(' You can add another Petition.'), '', 'info');
 362       $session->replaceUserContext(CRM_Utils_System::url('civicrm/petition/add', 'reset=1&action=add'));
 363     }
 364     else {
 365       $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=petition'));
 366     }
 367   }
 368 }
 369
 370
 371
 372