CRM/Campaign/Form/Petition.php

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