CRM/Admin/Form.php

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