CRM/Custom/Form/DeleteField.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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 is to build the form for deleting a field
  38  */
  39 class CRM_Custom_Form_DeleteField extends CRM_Core_Form {
  40
  41   /**
  42    * the group id
  43    *
  44    * @var int
  45    */
  46   protected $_id;
  47
  48   /**
  49    * The title of the group being deleted
  50    *
  51    * @var string
  52    */
  53   protected $_title;
  54
  55   /**
  56    * set up variables to build the form
  57    *
  58    * @param null
  59    *
  60    * @return void
  61    * @acess protected
  62    */
  63   function preProcess() {
  64     $this->_id = $this->get('id');
  65
  66
  67     $defaults = array();
  68     $params = array('id' => $this->_id);
  69     CRM_Core_BAO_CustomField::retrieve($params, $defaults);
  70
  71     $this->_title = CRM_Utils_Array::value('label', $defaults);
  72
  73     CRM_Utils_System::setTitle(ts('Delete %1', array(1 => $this->_title)));
  74   }
  75
  76   /**
  77    * Function to actually build the form
  78    *
  79    * @param null
  80    *
  81    * @return void
  82    * @access public
  83    */
  84   public function buildQuickForm() {
  85
  86     $this->addButtons(array(
  87         array(
  88           'type' => 'next',
  89           'name' => ts('Delete Custom Field'),
  90           'isDefault' => TRUE,
  91         ),
  92         array(
  93           'type' => 'cancel',
  94           'name' => ts('Cancel'),
  95         ),
  96       )
  97     );
  98   }
  99
 100   /**
 101    * Process the form when submitted
 102    *
 103    * @param null
 104    *
 105    * @return void
 106    * @access public
 107    */
 108   public function postProcess() {
 109     $field = new CRM_Core_DAO_CustomField();
 110     $field->id = $this->_id;
 111     $field->find(TRUE);
 112
 113     CRM_Core_BAO_CustomField::deleteField($field);
 114
 115     // also delete any profiles associted with this custom field
 116     CRM_Core_Session::setStatus(ts('The custom field \'%1\' has been deleted.', array(1 => $field->label)), '', 'success');
 117
 118   }
 119 }
 120