CRM/Campaign/Form/Campaign.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 processing a campaign.
  36  */
  37 class CRM_Campaign_Form_Campaign extends CRM_Core_Form {
  38
  39   /**
  40    * Action
  41    *
  42    * @var int
  43    */
  44   public $_action;
  45
  46   /**
  47    * Context
  48    *
  49    * @var string
  50    */
  51   protected $_context;
  52
  53   /**
  54    * Object values.
  55    *
  56    * @var array
  57    */
  58   protected $_values;
  59
  60   /**
  61    * The id of the campaign we are proceessing
  62    *
  63    * @var int
  64    */
  65   protected $_campaignId;
  66
  67   /**
  68    * Explicitly declare the entity api name.
  69    */
  70   public function getDefaultEntity() {
  71     return 'Campaign';
  72   }
  73
  74   public function preProcess() {
  75     if (!CRM_Campaign_BAO_Campaign::accessCampaign()) {
  76       CRM_Utils_System::permissionDenied();
  77     }
  78
  79     $this->_context = CRM_Utils_Request::retrieve('context', 'Alphanumeric', $this);
  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)) {
 104       $this->_values = array();
 105
 106       // if we are editing
 107       if (isset($this->_campaignId) && $this->_campaignId) {
 108         $params = array('id' => $this->_campaignId);
 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.
 117     if (!empty($_POST['hidden_custom'])) {
 118       $campaignTypeId = empty($_POST['campaign_type_id']) ? NULL : $_POST['campaign_type_id'];
 119       $this->set('type', 'Campaign');
 120       $this->set('subType', $campaignTypeId);
 121       $this->set('entityId', $this->_campaignId);
 122
 123       CRM_Custom_Form_CustomData::preProcess($this, NULL, $campaignTypeId, 1, 'Campaign', $this->_campaignId);
 124       CRM_Custom_Form_CustomData::buildQuickForm($this);
 125       CRM_Custom_Form_CustomData::setDefaultValues($this);
 126     }
 127   }
 128
 129   /**
 130    * Set default values for the form. Note that in edit/view mode
 131    * the default values are retrieved from the database
 132    *
 133    *
 134    * @return array
 135    */
 136   public function setDefaultValues() {
 137     $defaults = $this->_values;
 138
 139     if (empty($defaults['start_date'])) {
 140       $defaults['start_date'] = date('Y-m-d H:i:s');
 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
 153     $campaignGroups = array();
 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
 170       $this->addButtons(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->applyFilter('__ALL__', 'trim');
 186
 187     //lets assign custom data type and subtype.
 188     $this->assign('customDataType', 'Campaign');
 189     $this->assign('entityID', $this->_campaignId);
 190     $this->assign('customDataSubType', CRM_Utils_Array::value('campaign_type_id', $this->_values));
 191
 192     $attributes = CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Campaign');
 193
 194     // add comaign title.
 195     $this->add('text', 'title', ts('Title'), $attributes['title'], TRUE);
 196
 197     // add description
 198     $this->add('textarea', 'description', ts('Description'), $attributes['description']);
 199
 200     // add campaign start date
 201     $this->add('datepicker', 'start_date', ts('Start Date'), [], TRUE);
 202
 203     // add campaign end date
 204     $this->add('datepicker', 'end_date', ts('End Date'));
 205
 206     // add campaign type
 207     $this->addSelect('campaign_type_id', array('onChange' => "CRM.buildCustomData( 'Campaign', this.value );"), TRUE);
 208
 209     // add campaign status
 210     $this->addSelect('status_id');
 211
 212     // add External Identifier Element
 213     $this->add('text', 'external_identifier', ts('External ID'),
 214       CRM_Core_DAO::getAttribute('CRM_Campaign_DAO_Campaign', 'external_identifier'), FALSE
 215     );
 216
 217     // add Campaign Parent Id
 218     $campaigns = CRM_Campaign_BAO_Campaign::getCampaigns(CRM_Utils_Array::value('parent_id', $this->_values), $this->_campaignId);
 219     if (!empty($campaigns)) {
 220       $this->addElement('select', 'parent_id', ts('Parent ID'),
 221         array('' => ts('- select Parent -')) + $campaigns,
 222         array('class' => 'crm-select2')
 223       );
 224     }
 225     $groups = CRM_Core_PseudoConstant::nestedGroup();
 226     //get the campaign groups.
 227     $this->add('select', 'includeGroups',
 228       ts('Include Group(s)'),
 229       $groups,
 230       FALSE,
 231       array(
 232         'multiple' => TRUE,
 233         'class' => 'crm-select2 huge',
 234         'placeholder' => ts('- none -'),
 235       )
 236     );
 237
 238     $this->add('wysiwyg', 'goal_general', ts('Campaign Goals'), array('rows' => 2, 'cols' => 40));
 239     $this->add('text', 'goal_revenue', ts('Revenue Goal'), array('size' => 8, 'maxlength' => 12));
 240     $this->addRule('goal_revenue', ts('Please enter a valid money value (e.g. %1).',
 241       array(1 => CRM_Utils_Money::format('99.99', ' '))
 242     ), 'money');
 243
 244     // is this Campaign active
 245     $this->addElement('checkbox', 'is_active', ts('Is Active?'));
 246
 247     $buttons = [
 248       [
 249         'type' => 'upload',
 250         'name' => ts('Save'),
 251         'isDefault' => TRUE,
 252       ],
 253     ];
 254     // Skip this button when adding a new campaign from an entityRef
 255     if (empty($_GET['snippet']) || empty($_GET['returnExtra'])) {
 256       $buttons[] = [
 257         'type' => 'upload',
 258         'name' => ts('Save and New'),
 259         'subName' => 'new',
 260       ];
 261     }
 262     $buttons[] = [
 263       'type' => 'cancel',
 264       'name' => ts('Cancel'),
 265     ];
 266
 267     $this->addButtons($buttons);
 268   }
 269
 270   /**
 271    * add the rules (mainly global rules) for form.
 272    * All local rules are added near the element
 273    *
 274    * @param $fields
 275    * @param $files
 276    * @param $errors
 277    *
 278    * @return bool|array
 279    * @see valid_date
 280    */
 281   public static function formRule($fields, $files, $errors) {
 282     $errors = array();
 283
 284     return empty($errors) ? TRUE : $errors;
 285   }
 286
 287   /**
 288    * Form submission of new/edit campaign is processed.
 289    */
 290   public function postProcess() {
 291     // store the submitted values in an array
 292     $params = $this->controller->exportValues($this->_name);
 293     $session = CRM_Core_Session::singleton();
 294
 295     $groups = array();
 296     if (isset($this->_campaignId)) {
 297       if ($this->_action & CRM_Core_Action::DELETE) {
 298         CRM_Campaign_BAO_Campaign::del($this->_campaignId);
 299         CRM_Core_Session::setStatus(ts('Campaign has been deleted.'), ts('Record Deleted'), 'success');
 300         $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=campaign'));
 301         return;
 302       }
 303       $params['id'] = $this->_campaignId;
 304     }
 305     else {
 306       $params['created_id'] = $session->get('userID');
 307       $params['created_date'] = date('YmdHis');
 308     }
 309     // format params
 310     $params['is_active'] = CRM_Utils_Array::value('is_active', $params, FALSE);
 311     $params['last_modified_id'] = $session->get('userID');
 312     $params['last_modified_date'] = date('YmdHis');
 313
 314     if (is_array($params['includeGroups'])) {
 315       foreach ($params['includeGroups'] as $key => $id) {
 316         if ($id) {
 317           $groups['include'][] = $id;
 318         }
 319       }
 320     }
 321     $params['groups'] = $groups;
 322
 323     // delete previous includes/excludes, if campaign already existed
 324     $groupTableName = CRM_Contact_BAO_Group::getTableName();
 325     $dao = new CRM_Campaign_DAO_CampaignGroup();
 326     $dao->campaign_id = $this->_campaignId;
 327     $dao->entity_table = $groupTableName;
 328     $dao->find();
 329     while ($dao->fetch()) {
 330       $dao->delete();
 331     }
 332
 333     //process custom data.
 334     $customFields = CRM_Core_BAO_CustomField::getFields('Campaign', FALSE, FALSE,
 335       CRM_Utils_Array::value('campaign_type_id', $params)
 336     );
 337     $params['custom'] = CRM_Core_BAO_CustomField::postProcess($params,
 338       $this->_campaignId,
 339       'Campaign'
 340     );
 341
 342     $result = CRM_Campaign_BAO_Campaign::create($params);
 343
 344     if ($result) {
 345       CRM_Core_Session::setStatus(ts('Campaign %1 has been saved.', array(1 => $result->title)), ts('Saved'), 'success');
 346       $session->pushUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=campaign'));
 347       $this->ajaxResponse['id'] = $result->id;
 348       $this->ajaxResponse['label'] = $result->title;
 349     }
 350
 351     $buttonName = $this->controller->getButtonName();
 352     if ($buttonName == $this->getButtonName('upload', 'new')) {
 353       CRM_Core_Session::setStatus(ts(' You can add another Campaign.'), '', 'info');
 354       $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign/add', 'reset=1&action=add'));
 355     }
 356     else {
 357       $session->replaceUserContext(CRM_Utils_System::url('civicrm/campaign', 'reset=1&subPage=campaign'));
 358     }
 359   }
 360
 361 }