CRM/Campaign/Form/SurveyType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class generates form components for Option Group.
  20  */
  21 class CRM_Campaign_Form_SurveyType extends CRM_Admin_Form {
  22   protected $_gid;
  23
  24   /**
  25    * The option group name
  26    *
  27    * @var string
  28    */
  29   protected $_gName;
  30
  31   /**
  32    * Id
  33    *
  34    * @var int
  35    */
  36   protected $_id;
  37
  38   /**
  39    * Action
  40    *
  41    * @var int
  42    */
  43   public $_action;
  44
  45   /**
  46    * Set variables up before form is built.
  47    *
  48    * @throws \CRM_Core_Exception
  49    */
  50   public function preProcess() {
  51     $this->_action = CRM_Utils_Request::retrieve('action', 'String', $this);
  52
  53     if ($this->_action & (CRM_Core_Action::UPDATE | CRM_Core_Action::DELETE)) {
  54       $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this, TRUE);
  55       $this->assign('id', $this->_id);
  56     }
  57     $this->assign('action', $this->_action);
  58     $this->assign('id', $this->_id);
  59
  60     $this->_BAOName = 'CRM_Core_BAO_OptionValue';
  61     $this->_gName = 'activity_type';
  62     $this->_gid = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_gName, 'id', 'name');
  63
  64     $session = CRM_Core_Session::singleton();
  65     $url = CRM_Utils_System::url('civicrm/admin/campaign/surveyType', 'reset=1');
  66     $session->pushUserContext($url);
  67
  68     if ($this->_id && in_array($this->_gName, CRM_Core_OptionGroup::$_domainIDGroups)) {
  69       $domainID = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'domain_id', 'id');
  70       if (CRM_Core_Config::domainID() != $domainID) {
  71         CRM_Core_Error::statusBounce(ts('You do not have permission to access this page.'));
  72       }
  73     }
  74   }
  75
  76   /**
  77    * Set default values for the form.
  78    * the default values are retrieved from the database.
  79    *
  80    * @return array
  81    *   array of default values
  82    */
  83   public function setDefaultValues() {
  84     $defaults = parent::setDefaultValues();
  85
  86     if (!isset($defaults['weight']) || !$defaults['weight']) {
  87       $fieldValues = ['option_group_id' => $this->_gid];
  88       $defaults['weight'] = CRM_Utils_Weight::getDefaultWeight('CRM_Core_DAO_OptionValue', $fieldValues);
  89     }
  90
  91     return $defaults;
  92   }
  93
  94   /**
  95    * Build the form object.
  96    */
  97   public function buildQuickForm() {
  98     parent::buildQuickForm();
  99     if ($this->_action & CRM_Core_Action::DELETE) {
 100       return;
 101     }
 102
 103     $this->applyFilter('__ALL__', 'trim');
 104     $this->add('text', 'label', ts('Title'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'label'), TRUE);
 105
 106     $this->add('wysiwyg', 'description',
 107       ts('Description'),
 108       CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'description')
 109     );
 110
 111     $this->add('checkbox', 'is_active', ts('Enabled?'));
 112
 113     if ($this->_action == CRM_Core_Action::UPDATE &&
 114       CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionGroup', $this->_id, 'is_reserved')
 115     ) {
 116       $this->freeze(['label', 'is_active']);
 117     }
 118     $this->add('number', 'weight', ts('Order'), CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionValue', 'weight'), TRUE);
 119
 120     $this->assign('id', $this->_id);
 121   }
 122
 123   /**
 124    * Process the form submission.
 125    */
 126   public function postProcess() {
 127
 128     if ($this->_action & CRM_Core_Action::DELETE) {
 129       $fieldValues = ['option_group_id' => $this->_gid];
 130       $wt = CRM_Utils_Weight::delWeight('CRM_Core_DAO_OptionValue', $this->_id, $fieldValues);
 131
 132       if (CRM_Core_BAO_OptionValue::del($this->_id)) {
 133         CRM_Core_Session::setStatus(ts('Selected Survey type has been deleted.'), ts('Record Deleted'), 'success');
 134       }
 135     }
 136     else {
 137       $params = $ids = [];
 138       $params = $this->exportValues();
 139
 140       // set db value of filter in params if filter is non editable
 141       if ($this->_id && !array_key_exists('filter', $params)) {
 142         $params['filter'] = CRM_Core_DAO::getFieldValue('CRM_Core_DAO_OptionValue', $this->_id, 'filter', 'id');
 143       }
 144
 145       $params['component_id'] = CRM_Core_Component::getComponentID('CiviCampaign');
 146       $optionValue = CRM_Core_OptionValue::addOptionValue($params, $this->_gName, $this->_action, $this->_id);
 147
 148       CRM_Core_Session::setStatus(ts('The Survey type \'%1\' has been saved.', [1 => $optionValue->label]), ts('Saved'), 'success');
 149     }
 150   }
 151
 152 }