crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/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    * Basic setup.
  64    */
  65   public function preProcess() {
  66     $this->_id = $this->get('id');
  67     $this->_BAOName = $this->get('BAOName');
  68     $this->_values = array();
  69     if (isset($this->_id)) {
  70       $params = array('id' => $this->_id);
  71       // this is needed if the form is outside the CRM name space
  72       $baoName = $this->_BAOName;
  73       $baoName::retrieve($params, $this->_values);
  74     }
  75   }
  76
  77   /**
  78    * Set default values for the form. Note that in edit/view mode
  79    * the default values are retrieved from the database
  80    *
  81    *
  82    * @return array
  83    */
  84   public function setDefaultValues() {
  85     if (isset($this->_id) && empty($this->_values)) {
  86       $this->_values = array();
  87       $params = array('id' => $this->_id);
  88       $baoName = $this->_BAOName;
  89       $baoName::retrieve($params, $this->_values);
  90     }
  91     $defaults = $this->_values;
  92
  93     if ($this->_action == CRM_Core_Action::DELETE &&
  94       isset($defaults['name'])
  95     ) {
  96       $this->assign('delName', $defaults['name']);
  97     }
  98
  99     // its ok if there is no element called is_active
 100     $defaults['is_active'] = ($this->_id) ? CRM_Utils_Array::value('is_active', $defaults) : 1;
 101     if (!empty($defaults['parent_id'])) {
 102       $this->assign('is_parent', TRUE);
 103     }
 104     return $defaults;
 105   }
 106
 107   /**
 108    * Add standard buttons.
 109    *
 110    * @return void
 111    */
 112   public function buildQuickForm() {
 113     if ($this->_action & CRM_Core_Action::VIEW || $this->_action & CRM_Core_Action::PREVIEW) {
 114       $this->addButtons(array(
 115           array(
 116             'type' => 'cancel',
 117             'name' => ts('Done'),
 118             'isDefault' => TRUE,
 119           ),
 120         )
 121       );
 122     }
 123     else {
 124       $this->addButtons(array(
 125           array(
 126             'type' => 'next',
 127             'name' => $this->_action & CRM_Core_Action::DELETE ? ts('Delete') : ts('Save'),
 128             'isDefault' => TRUE,
 129           ),
 130           array(
 131             'type' => 'cancel',
 132             'name' => ts('Cancel'),
 133           ),
 134         )
 135       );
 136     }
 137   }
 138
 139 }