CRM/Admin/Form/ContactType.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 ContactSub Type.
  20  */
  21 class CRM_Admin_Form_ContactType extends CRM_Admin_Form {
  22
  23   /**
  24    * Build the form object.
  25    */
  26   public function buildQuickForm() {
  27     parent::buildQuickForm();
  28     $this->setPageTitle(ts('Contact Type'));
  29
  30     if ($this->_action & CRM_Core_Action::DELETE) {
  31       return;
  32     }
  33     $this->applyFilter('__ALL__', 'trim');
  34     $this->add('text', 'label', ts('Name'),
  35       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_ContactType', 'label'),
  36       TRUE
  37     );
  38     $contactType = $this->add('select', 'parent_id', ts('Basic Contact Type'),
  39       CRM_Contact_BAO_ContactType::basicTypePairs(FALSE, 'id')
  40     );
  41     $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
  42     if ($this->_action & CRM_Core_Action::UPDATE) {
  43       $contactType->freeze();
  44       // We'll display actual "name" for built-in types (for reference) when editing their label / image_URL
  45       $contactTypeName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_ContactType', $this->_id, 'name');
  46       $this->assign('contactTypeName', $contactTypeName);
  47
  48       $this->_parentId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_ContactType', $this->_id, 'parent_id');
  49       // Freeze Enabled field for built-in contact types (parent_id is NULL for these)
  50       if (is_null($this->_parentId)) {
  51         $enabled->freeze();
  52       }
  53     }
  54     // TODO: Remove when dropping image_URL column
  55     if ($this->_id) {
  56       $imageUrl = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_ContactType', $this->_id, 'image_URL');
  57       if ($imageUrl) {
  58         $this->addElement('text', 'image_URL', ts('Image URL'));
  59       }
  60     }
  61     $this->assign('hasImageUrl', !empty($imageUrl));
  62     $this->add('text', 'icon', ts('Icon'), ['class' => 'crm-icon-picker', 'title' => ts('Choose Icon'), 'allowClear' => TRUE]);
  63     $this->add('text', 'description', ts('Description'),
  64       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_ContactType', 'description')
  65     );
  66
  67     $this->assign('cid', $this->_id);
  68     $this->addFormRule(['CRM_Admin_Form_ContactType', 'formRule'], $this);
  69   }
  70
  71   /**
  72    * Global form rule.
  73    *
  74    * @param array $fields
  75    *   The input form values.
  76    *
  77    * @param $files
  78    * @param self $self
  79    *
  80    * @return bool|array
  81    *   true if no errors, else array of errors
  82    */
  83   public static function formRule($fields, $files, $self) {
  84
  85     $errors = [];
  86
  87     if ($self->_id) {
  88       $contactName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_ContactType', $self->_id, 'name');
  89     }
  90     else {
  91       $contactName = ucfirst(CRM_Utils_String::munge($fields['label']));
  92     }
  93
  94     if (!CRM_Core_DAO::objectExists($contactName, 'CRM_Contact_DAO_ContactType', $self->_id)) {
  95       $errors['label'] = ts('This contact type name already exists in database. Contact type names must be unique.');
  96     }
  97
  98     $reservedKeyWords = CRM_Core_SelectValues::customGroupExtends();
  99     //restrict "name" from being a reserved keyword when a new contact subtype is created
 100     if (!$self->_id && array_key_exists($contactName, $reservedKeyWords)) {
 101       $errors['label'] = ts('Contact type names should not use reserved keywords.');
 102     }
 103     return empty($errors) ? TRUE : $errors;
 104   }
 105
 106   /**
 107    * Process the form submission.
 108    */
 109   public function postProcess() {
 110     CRM_Utils_System::flushCache();
 111
 112     if ($this->_action & CRM_Core_Action::DELETE) {
 113       $isDelete = CRM_Contact_BAO_ContactType::del($this->_id);
 114       if ($isDelete) {
 115         CRM_Core_Session::setStatus(ts('Selected contact type has been deleted.'), ts('Record Deleted'), 'success');
 116       }
 117       else {
 118         CRM_Core_Session::setStatus(ts("Selected contact type can not be deleted. Make sure contact type doesn't have any associated custom data or group."), ts('Sorry'), 'error');
 119       }
 120       return;
 121     }
 122     // store the submitted values in an array
 123     $params = $this->exportValues();
 124
 125     if ($this->_action & CRM_Core_Action::UPDATE) {
 126       $params['id'] = $this->_id;
 127       // Force Enabled = true for built-in contact types to fix problems caused by CRM-6471 (parent_id is NULL for these types)
 128       if (is_null($this->_parentId)) {
 129         $params['is_active'] = 1;
 130       }
 131     }
 132
 133     // If icon is set, it overrides image_URL
 134     if (!empty($params['icon'])) {
 135       $params['image_URL'] = '';
 136     }
 137
 138     $contactType = CRM_Contact_BAO_ContactType::add($params);
 139     CRM_Core_Session::setStatus(ts("The Contact Type '%1' has been saved.",
 140       [1 => $contactType->label]
 141     ), ts('Saved'), 'success');
 142   }
 143
 144 }