CRM/Admin/Form/ContactType.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for ContactSub Type
  38  *
  39  */
  40 class CRM_Admin_Form_ContactType extends CRM_Admin_Form {
  41
  42   /**
  43    * Build the form object
  44    *
  45    * @return void
  46    */
  47   public function buildQuickForm() {
  48     parent::buildQuickForm();
  49     $this->setPageTitle(ts('Contact Type'));
  50
  51     if ($this->_action & CRM_Core_Action::DELETE) {
  52       return;
  53     }
  54     $this->applyFilter('__ALL__', 'trim');
  55     $this->add('text', 'label', ts('Name'),
  56       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_ContactType', 'label'),
  57       TRUE
  58     );
  59     $contactType = $this->add('select', 'parent_id', ts('Basic Contact Type'),
  60       CRM_Contact_BAO_ContactType::basicTypePairs(FALSE, 'id')
  61     );
  62     $enabled = $this->add('checkbox', 'is_active', ts('Enabled?'));
  63     if ($this->_action & CRM_Core_Action::UPDATE) {
  64       $contactType->freeze();
  65       // We'll display actual "name" for built-in types (for reference) when editing their label / image_URL
  66       $contactTypeName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_ContactType', $this->_id, 'name');
  67       $this->assign('contactTypeName', $contactTypeName);
  68
  69       $this->_parentId = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_ContactType', $this->_id, 'parent_id');
  70       // Freeze Enabled field for built-in contact types (parent_id is NULL for these)
  71       if (is_null($this->_parentId)) {
  72         $enabled->freeze();
  73       }
  74     }
  75     $this->addElement('text', 'image_URL', ts('Image URL'));
  76     $this->add('text', 'description', ts('Description'),
  77       CRM_Core_DAO::getAttribute('CRM_Contact_DAO_ContactType', 'description')
  78     );
  79
  80     $this->assign('cid', $this->_id);
  81     $this->addFormRule(array('CRM_Admin_Form_ContactType', 'formRule'), $this);
  82   }
  83
  84   /**
  85    * Global form rule
  86    *
  87    * @param array $fields the input form values
  88    *
  89    * @param $files
  90    * @param $self
  91    *
  92    * @return true if no errors, else array of errors
  93    * @static
  94    */
  95   public static function formRule($fields, $files, $self) {
  96
  97     $errors = array();
  98
  99     if ($self->_id) {
 100       $contactName = CRM_Core_DAO::getFieldValue('CRM_Contact_DAO_ContactType', $self->_id, 'name');
 101     }
 102     else {
 103       $contactName = ucfirst(CRM_Utils_String::munge($fields['label']));
 104     }
 105
 106     if (!CRM_Core_DAO::objectExists($contactName, 'CRM_Contact_DAO_ContactType', $self->_id)) {
 107       $errors['label'] = ts('This contact type name already exists in database. Contact type names must be unique.');
 108     }
 109
 110     $reservedKeyWords = CRM_Core_SelectValues::customGroupExtends();
 111     //restrict "name" from being a reserved keyword when a new contact subtype is created
 112     if (!$self->_id && in_array($contactName, array_keys($reservedKeyWords))) {
 113       $errors['label'] = ts('Contact type names should not use reserved keywords.');
 114     }
 115     return empty($errors) ? TRUE : $errors;
 116   }
 117
 118   /**
 119    * Process the form submission
 120    *
 121    *
 122    * @return void
 123    */
 124   public function postProcess() {
 125     CRM_Utils_System::flushCache();
 126
 127     if ($this->_action & CRM_Core_Action::DELETE) {
 128       $isDelete = CRM_Contact_BAO_ContactType::del($this->_id);
 129       if ($isDelete) {
 130         CRM_Core_Session::setStatus(ts('Selected contact type has been deleted.'), ts('Record Deleted'), 'success');
 131       }
 132       else {
 133         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');
 134       }
 135       return;
 136     }
 137     // store the submitted values in an array
 138     $params = $this->exportValues();
 139
 140     if ($this->_action & CRM_Core_Action::UPDATE) {
 141       $params['id'] = $this->_id;
 142       // Force Enabled = true for built-in contact types to fix problems caused by CRM-6471 (parent_id is NULL for these types)
 143       if (is_null($this->_parentId)) {
 144         $params['is_active'] = 1;
 145       }
 146     }
 147     if ($this->_action & CRM_Core_Action::ADD) {
 148       $params['name'] = ucfirst(CRM_Utils_String::munge($params['label']));
 149     }
 150     $contactType = CRM_Contact_BAO_ContactType::add($params);
 151     CRM_Core_Session::setStatus(ts("The Contact Type '%1' has been saved.",
 152         array(1 => $contactType->label)
 153       ), ts('Saved'), 'success');
 154   }
 155
 156 }