CRM/Admin/Form.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  */
  33
  34 /**
  35  * Base class for admin forms.
  36  */
  37 class CRM_Admin_Form extends CRM_Core_Form {
  38
  39   /**
  40    * The id of the object being edited / created
  41    *
  42    * @var int
  43    */
  44   protected $_id;
  45
  46   /**
  47    * The default values for form fields.
  48    *
  49    * @var int
  50    */
  51   protected $_values;
  52
  53   /**
  54    * The name of the BAO object for this form.
  55    *
  56    * @var string
  57    */
  58   protected $_BAOName;
  59
  60   /**
  61    * Explicitly declare the form context.
  62    */
  63   public function getDefaultContext() {
  64     return 'create';
  65   }
  66
  67   /**
  68    * Basic setup.
  69    */
  70   public function preProcess() {
  71     $this->_id = $this->get('id');
  72     $this->_BAOName = $this->get('BAOName');
  73     $this->_values = array();
  74     if (isset($this->_id)) {
  75       $params = array('id' => $this->_id);
  76       // this is needed if the form is outside the CRM name space
  77       $baoName = $this->_BAOName;
  78       $baoName::retrieve($params, $this->_values);
  79     }
  80   }
  81
  82   /**
  83    * Set default values for the form. Note that in edit/view mode
  84    * the default values are retrieved from the database
  85    *
  86    *
  87    * @return array
  88    */
  89   public function setDefaultValues() {
  90     if (isset($this->_id) && empty($this->_values)) {
  91       $this->_values = array();
  92       $params = array('id' => $this->_id);
  93       $baoName = $this->_BAOName;
  94       $baoName::retrieve($params, $this->_values);
  95     }
  96     $defaults = $this->_values;
  97
  98     if ($this->_action == CRM_Core_Action::DELETE &&
  99       isset($defaults['name'])
 100     ) {
 101       $this->assign('delName', $defaults['name']);
 102     }
 103
 104     // its ok if there is no element called is_active
 105     $defaults['is_active'] = ($this->_id) ? CRM_Utils_Array::value('is_active', $defaults) : 1;
 106     if (!empty($defaults['parent_id'])) {
 107       $this->assign('is_parent', TRUE);
 108     }
 109     return $defaults;
 110   }
 111
 112   /**
 113    * Add standard buttons.
 114    */
 115   public function buildQuickForm() {
 116     if ($this->_action & CRM_Core_Action::VIEW || $this->_action & CRM_Core_Action::PREVIEW) {
 117       $this->addButtons(array(
 118           array(
 119             'type' => 'cancel',
 120             'name' => ts('Done'),
 121             'isDefault' => TRUE,
 122           ),
 123         )
 124       );
 125     }
 126     else {
 127       $this->addButtons(array(
 128           array(
 129             'type' => 'next',
 130             'name' => $this->_action & CRM_Core_Action::DELETE ? ts('Delete') : ts('Save'),
 131             'isDefault' => TRUE,
 132           ),
 133           array(
 134             'type' => 'cancel',
 135             'name' => ts('Cancel'),
 136           ),
 137         )
 138       );
 139     }
 140   }
 141
 142 }