CRM/Admin/Form/OptionGroup.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   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-2018
  32  */
  33
  34 /**
  35  * This class generates form components for Option Group.
  36  */
  37 class CRM_Admin_Form_OptionGroup extends CRM_Admin_Form {
  38
  39   /**
  40    * Explicitly declare the entity api name.
  41    */
  42   public function getDefaultEntity() {
  43     return 'OptionGroup';
  44   }
  45
  46   /**
  47    * Build the form object.
  48    */
  49   public function buildQuickForm() {
  50     parent::buildQuickForm();
  51     if ($this->_action & CRM_Core_Action::DELETE) {
  52       return;
  53     }
  54     CRM_Utils_System::setTitle(ts('Dropdown Options'));
  55
  56     $this->applyFilter('__ALL__', 'trim');
  57     $this->add('text',
  58       'name',
  59       ts('Name'),
  60       CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionGroup', 'name'),
  61       TRUE
  62     );
  63     $this->addRule('name',
  64       ts('Name already exists in Database.'),
  65       'objectExists',
  66       array('CRM_Core_DAO_OptionGroup', $this->_id)
  67     );
  68
  69     $this->add('text',
  70       'title',
  71       ts('Group Title'),
  72       CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionGroup', 'title')
  73     );
  74
  75     $this->add('text',
  76       'description',
  77       ts('Description'),
  78       CRM_Core_DAO::getAttribute('CRM_Core_DAO_OptionGroup', 'description')
  79     );
  80
  81     $this->addSelect('data_type', array('options' => CRM_Utils_Type::dataTypes()), empty($this->_values['is_reserved']));
  82
  83     $element = $this->add('checkbox', 'is_active', ts('Enabled?'));
  84     if ($this->_action & CRM_Core_Action::UPDATE) {
  85       if (in_array($this->_values['name'], array(
  86         'encounter_medium',
  87         'case_type',
  88         'case_status',
  89       ))) {
  90         static $caseCount = NULL;
  91         if (!isset($caseCount)) {
  92           $caseCount = CRM_Case_BAO_Case::caseCount(NULL, FALSE);
  93         }
  94
  95         if ($caseCount > 0) {
  96           $element->freeze();
  97         }
  98       }
  99
 100       $this->add('checkbox', 'is_reserved', ts('Reserved?'));
 101       $this->freeze('is_reserved');
 102
 103       if (!empty($this->_values['is_reserved'])) {
 104         $this->freeze(array('name', 'is_active', 'data_type'));
 105       }
 106     }
 107
 108     $this->assign('id', $this->_id);
 109   }
 110
 111   /**
 112    * Process the form submission.
 113    */
 114   public function postProcess() {
 115     CRM_Utils_System::flushCache();
 116
 117     if ($this->_action & CRM_Core_Action::DELETE) {
 118       CRM_Core_BAO_OptionGroup::del($this->_id);
 119       CRM_Core_Session::setStatus(ts('Selected option group has been deleted.'), ts('Record Deleted'), 'success');
 120     }
 121     else {
 122       // store the submitted values in an array
 123       $params = $this->exportValues();
 124
 125       if ($this->_action & CRM_Core_Action::ADD) {
 126         // If we are adding option group via UI it should not be marked reserved.
 127         if (!isset($params['is_reserved'])) {
 128           $params['is_reserved'] = 0;
 129         }
 130       }
 131       elseif ($this->_action & CRM_Core_Action::UPDATE) {
 132         $params['id'] = $this->_id;
 133       }
 134
 135       $optionGroup = CRM_Core_BAO_OptionGroup::add($params);
 136       CRM_Core_Session::setStatus(ts('The Option Group \'%1\' has been saved.', array(1 => $optionGroup->name)), ts('Saved'), 'success');
 137     }
 138   }
 139
 140 }